An analytical geometric cellShape. More...

Inheritance diagram for cellShape:

Collaboration diagram for cellShape:

Public Member Functions
constexpr	cellShape () noexcept
	Default construct. More...

	cellShape (const cellModel &model, const labelUList &labels, const bool doCollapse=false)
	Copy construct from components. More...

template<unsigned N>
	cellShape (const cellModel &model, const FixedList< label, N > &labels, const bool doCollapse=false)
	Copy construct from components. More...

	cellShape (const cellModel &model, labelUList &&labels, const bool doCollapse=false)
	Move construct from components. More...

	cellShape (const word &modelName, const labelUList &labels, const bool doCollapse=false)
	Copy construct from components, using lookup cellModel by name. More...

	cellShape (Istream &is)
	Construct from Istream. More...

autoPtr< cellShape >	clone () const
	Clone. More...

const cellModel &	model () const
	Model reference. More...

label	nPoints () const
	Number of points. More...

label	nEdges () const
	Number of edges. More...

label	nFaces () const
	Number of faces. More...

pointField	points (const UList< point > &meshPoints) const
	The points corresponding to this shape. More...

labelList	meshFaces (const faceList &allFaces, const cell &cFaces) const
	Mesh face labels of this cell (in order of model) More...

labelList	meshEdges (const edgeList &allEdges, const labelList &cEdges) const
	Mesh edge labels of this cell (in order of model) More...

Foam::face	face (const label modelFacei) const
	The face for the specified model face. More...

faceList	faces () const
	Faces of this cell. More...

faceList	collapsedFaces () const
	Collapsed faces of this cell. More...

Foam::edge	edge (const label modelEdgei) const
	The edge for the specified model edge. More...

edgeList	edges () const
	Edges of this shape. More...

point	centre (const UList< point > &points) const
	Centroid of the cell. More...

Foam::InfoProxy< cellShape >	info () const
	Return info proxy, to print information to a stream. More...

scalar	mag (const UList< point > &points) const
	Scalar magnitude. More...

void	collapse ()
	Collapse shape to correct one after removing duplicate vertices. More...

Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Null constructor. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const T &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const T &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, T &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< T > &a)
	Copy construct from list. More...

	List (const UList< T > &a)
	Copy construct contents from list. More...

	List (List< T > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

template<class InputIterator >
	List (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< T > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &list)
	Construct as copy of SLList<T> More...

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< T > list)
	Construct from an initializer list. More...

	List (List< T > &&list)
	Move construct from List. More...

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< T > &&list)
	Move construct from SortableList. More...

	List (SLList< T > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label newSize)
	Adjust allocated size of list. More...

void	resize (const label newSize, const T &val)
	Adjust allocated size of list and set val for new elements. More...

void	setSize (const label newSize)
	Alias for resize(const label) More...

void	setSize (const label newSize, const T &val)
	Alias for resize(const label, const T&) More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const T &val)
	Append an element at the end of the list. More...

void	append (T &&val)
	Move append an element at the end of the list. More...

void	append (const UList< T > &list)
	Append a List to the end of this list. More...

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

void	transfer (List< T > &list)

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)

void	transfer (SortableList< T > &list)

T &	newElmt (const label i)

void	operator= (const UList< T > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< T > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< T > &list)
	Assignment to SLList operator. Takes linear time. More...

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< T > &&list)
	Move assignment. Takes constant time. More...

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< T > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< T > &&list)
	Move assignment. Takes constant time. More...

void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

template<>
void	resize (const label newSize)

Friends
bool	operator== (const cellShape &a, const cellShape &b)

Istream &	operator>> (Istream &is, cellShape &s)

Ostream &	operator<< (Ostream &os, const cellShape &s)

Additional Inherited Members
Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from List< T >
static const List< T > &	null ()
	Return a null List. More...

Detailed Description

An analytical geometric cellShape.

The optional collapse functionality changes the cellModel to the correct type after removing any duplicate points.

Source files

Definition at line 69 of file cellShape.H.

Constructor & Destructor Documentation

◆ cellShape() [1/6]

constexpr cellShape ( )

inlineconstexprnoexcept

Default construct.

Definition at line 36 of file cellShapeI.H.

◆ cellShape() [2/6]

cellShape	(	const cellModel &	model,
		const labelUList &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components.

Definition at line 44 of file cellShapeI.H.

◆ cellShape() [3/6]

cellShape	(	const cellModel &	model,
		const FixedList< label, N > &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components.

Definition at line 62 of file cellShapeI.H.

◆ cellShape() [4/6]

cellShape	(	const cellModel &	model,
		labelUList &&	labels,
		const bool	doCollapse = `false`
	)

inline

Move construct from components.

Definition at line 79 of file cellShapeI.H.

◆ cellShape() [5/6]

cellShape	(	const word &	modelName,
		const labelUList &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components, using lookup cellModel by name.

Definition at line 96 of file cellShapeI.H.

◆ cellShape() [6/6]

cellShape ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 112 of file cellShapeI.H.

Member Function Documentation

◆ clone()

Foam::autoPtr< Foam::cellShape > clone ( ) const

inline

Clone.

Definition at line 118 of file cellShapeI.H.

References autoPtr< T >::New().

Here is the call graph for this function:

◆ model()

const Foam::cellModel & model ( ) const

inline

Model reference.

Definition at line 126 of file cellShapeI.H.

Referenced by Foam::operator<<(), and vtuSizing::reset().

Here is the caller graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

inline

Number of points.

Definition at line 132 of file cellShapeI.H.

◆ nEdges()

Foam::label nEdges ( ) const

inline

Number of edges.

Definition at line 138 of file cellShapeI.H.

◆ nFaces()

Foam::label nFaces ( ) const

inline

Number of faces.

Definition at line 144 of file cellShapeI.H.

◆ points()

Foam::pointField points ( const UList< point > & meshPoints ) const

inline

The points corresponding to this shape.

Definition at line 151 of file cellShapeI.H.

Referenced by voxelMeshSearch::makeMesh().

Here is the caller graph for this function:

◆ meshFaces()

Foam::labelList meshFaces	(	const faceList &	allFaces,
		const cell &	cFaces
	)		const

inline

Mesh face labels of this cell (in order of model)

Definition at line 160 of file cellShapeI.H.

References forAll.

◆ meshEdges()

Foam::labelList meshEdges	(	const edgeList &	allEdges,
		const labelList &	cEdges
	)		const

inline

Mesh edge labels of this cell (in order of model)

Definition at line 191 of file cellShapeI.H.

References Foam::constant::electromagnetic::e, and forAll.

◆ face()

Foam::face face ( const label modelFacei ) const

inline

The face for the specified model face.

Definition at line 221 of file cellShapeI.H.

References face::face().

Here is the call graph for this function:

◆ faces()

Foam::faceList faces ( ) const

inline

Faces of this cell.

Definition at line 227 of file cellShapeI.H.

◆ collapsedFaces()

Foam::faceList collapsedFaces ( ) const

inline

Collapsed faces of this cell.

Definition at line 233 of file cellShapeI.H.

References f(), and List< T >::resize().

Referenced by degenerateMatcher::match().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge()

Foam::edge edge ( const label modelEdgei ) const

inline

The edge for the specified model edge.

Definition at line 275 of file cellShapeI.H.

References edge::edge().

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( ) const

inline

Edges of this shape.

Definition at line 281 of file cellShapeI.H.

◆ centre()

Foam::point centre ( const UList< point > & points ) const

inline

Centroid of the cell.

Definition at line 287 of file cellShapeI.H.

References Vector< Cmpt >::centre(), and points.

Here is the call graph for this function:

◆ info()

Foam::InfoProxy<cellShape> info ( ) const

inline

Return info proxy, to print information to a stream.

Definition at line 176 of file cellShape.H.

◆ mag()

Foam::scalar mag ( const UList< point > & points ) const

inline

Scalar magnitude.

Definition at line 293 of file cellShapeI.H.

References points.

◆ collapse()

void collapse ( )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 33 of file cellShape.C.

References List< T >::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const cellShape &	a,
		const cellShape &	b
	)

friend

◆ operator>>

Istream& operator>>	(	Istream &	is,
		cellShape &	s
	)

friend

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const cellShape &	s
	)

friend

The documentation for this class was generated from the following files:

src/OpenFOAM/meshes/meshShapes/cellShape/cellShape.H
src/OpenFOAM/meshes/meshShapes/cellShape/cellShape.C
src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeI.H

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cellShape() [1/6]

◆ cellShape() [2/6]

◆ cellShape() [3/6]

◆ cellShape() [4/6]

◆ cellShape() [5/6]

◆ cellShape() [6/6]

Member Function Documentation

◆ clone()

◆ model()

◆ nPoints()

◆ nEdges()

◆ nFaces()

◆ points()

◆ meshFaces()

◆ meshEdges()

◆ face()

◆ faces()

◆ collapsedFaces()

◆ edge()

◆ edges()

◆ centre()

◆ info()

◆ mag()

◆ collapse()

Friends And Related Function Documentation

◆ operator==

◆ operator>>

◆ operator<<