An analytical geometric cellShape. More...

Inheritance diagram for cellShape:

Collaboration diagram for cellShape:

Public Member Functions
	cellShape ()
	Construct null. More...

	cellShape (const cellModel &, const labelList &, const bool doCollapse=false)
	Construct from components. More...

	cellShape (const word &model, const labelList &, const bool doCollapse=false)
	Construct from components. More...

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

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

pointField	points (const pointField &meshPoints) const
	Return the points corresponding to this cellShape. More...

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

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

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

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

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

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

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

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

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

point	centre (const pointField &) const
	Centroid of the cell. More...

Foam::InfoProxy< cellShape >	info () const
	Return info proxy. More...

scalar	mag (const pointField &) const
	Scalar magnitude. More...

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

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

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

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

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< T > &)
	Copy constructor. More...

template<class T2 >
	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< T > &&)
	Move constructor. More...

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

	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...

template<class InputIterator >
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

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

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

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

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

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

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

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

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

	~List ()
	Destructor. More...

label	size () const
	Return the number of elements in the UList. More...

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

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

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...

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

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

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

void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< T > &)
	Transfer the contents of the argument List into this list. More...

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< T > &)
	Transfer the contents of the argument List into this list. More...

T &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< T > &)=delete
	Disallow implicit shallowCopy. More...

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

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

void	operator= (List< T > &&)
	Move assignment operator. More...

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

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

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

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

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

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

template<>
const bool &	operator[] (const label i) const

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

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

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

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

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

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

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

Protected Member Functions inherited from List< T >
void	size (const label)
	Override size to be inconsistent with allocated storage. 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/4]

cellShape ( )

inline

Construct null.

Definition at line 32 of file cellShapeI.H.

Referenced by cellShape::cellShape(), and cellShape::clone().

Here is the caller graph for this function:

◆ cellShape() [2/4]

cellShape	(	const cellModel &	M,
		const labelList &	l,
		const bool	doCollapse = `false`
	)

inline

Construct from components.

Definition at line 39 of file cellShapeI.H.

References cellShape::cellShape(), and cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [3/4]

cellShape	(	const word &	model,
		const labelList &	l,
		const bool	doCollapse = `false`
	)

inline

Construct from components.

Definition at line 56 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [4/4]

cellShape ( Istream & is )

inline

Construct from Istream.

Definition at line 72 of file cellShapeI.H.

Member Function Documentation

◆ clone()

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

inline

Clone.

Definition at line 78 of file cellShapeI.H.

References cellShape::cellShape(), and cellShape::points().

Here is the call graph for this function:

◆ points()

Foam::pointField points ( const pointField & meshPoints ) const

inline

Return the points corresponding to this cellShape.

Definition at line 87 of file cellShapeI.H.

References forAll, UList< T >::operator[](), p, and List< T >::size().

Referenced by cellShape::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ model()

const Foam::cellModel & model ( ) const

inline

Model reference.

Definition at line 106 of file cellShapeI.H.

References cellShape::meshFaces().

Referenced by Foam::operator<<().

Here is the call graph for this function:

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 113 of file cellShapeI.H.

References cellShape::faces(), forAll, cellShape::meshEdges(), and List< T >::size().

Referenced by cellShape::model().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 147 of file cellShapeI.H.

References Foam::e, cellShape::edges(), forAll, and List< T >::size().

Referenced by cellShape::meshFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faces()

Foam::faceList faces ( ) const

inline

Faces of this cell.

Definition at line 180 of file cellShapeI.H.

References cellModel::faces().

Referenced by cellShape::collapsedFaces(), and cellShape::meshFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collapsedFaces()

Foam::faceList collapsedFaces ( ) const

inline

Collapsed faces of this cell.

Definition at line 186 of file cellShapeI.H.

References f(), cellShape::faces(), forAll, List< T >::setSize(), and List< T >::size().

Referenced by degenerateMatcher::match().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nFaces()

Foam::label nFaces ( ) const

inline

Number of faces.

Definition at line 235 of file cellShapeI.H.

References cellModel::nFaces().

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( ) const

inline

Edges of this cellShape.

Definition at line 241 of file cellShapeI.H.

References cellModel::edges().

Referenced by cellShape::meshEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nEdges()

Foam::label nEdges ( ) const

inline

Number of edges.

Definition at line 247 of file cellShapeI.H.

References cellModel::nEdges().

Here is the call graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

inline

Number of points.

Definition at line 253 of file cellShapeI.H.

References List< T >::size().

Here is the call graph for this function:

◆ centre()

Foam::point centre ( const pointField & points ) const

inline

Centroid of the cell.

Definition at line 259 of file cellShapeI.H.

References cellModel::centre().

Here is the call graph for this function:

◆ info()

Foam::InfoProxy<cellShape> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 150 of file cellShape.H.

◆ mag()

Foam::scalar mag ( const pointField & points ) const

inline

Scalar magnitude.

Definition at line 265 of file cellShapeI.H.

References cellModel::mag().

Here is the call graph for this function:

◆ collapse()

void collapse ( )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 31 of file cellShape.C.

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

Referenced by cellShape::cellShape().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

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

friend

◆ operator>>

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

friend

◆ operator<<

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

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/4]

◆ cellShape() [2/4]

◆ cellShape() [3/4]

◆ cellShape() [4/4]

Member Function Documentation

◆ clone()

◆ points()

◆ model()

◆ meshFaces()

◆ meshEdges()

◆ faces()

◆ collapsedFaces()

◆ nFaces()

◆ edges()

◆ nEdges()

◆ nPoints()

◆ centre()

◆ info()

◆ mag()

◆ collapse()

Friends And Related Function Documentation

◆ operator==

◆ operator>>

◆ operator<<