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 (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
	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 List< T > &)
	Copy constructor. More...

	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. 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 (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...

Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...

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

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

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

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

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

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

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

template<class T >
	List (const label s)

template<class T >
	List (const label s, const T &a)

template<class T >
	List (const List< T > &a)

template<class T >
	List (const Xfer< List< T > > &lst)

template<class T >
	List (List< T > &a, bool reUse)

template<class T >
	List (const UList< T > &a, const labelUList &map)

template<class T >
	List (const PtrList< T > &lst)

template<class T >
	List (const SLList< T > &lst)

template<class T >
	List (const UIndirectList< T > &lst)

template<class T >
	List (const BiIndirectList< T > &lst)

template<class T >
void	transfer (List< T > &a)

template<class T >
void	transfer (SortableList< T > &a)

template<class T >
	List ()

template<class T >
	List (Istream &is)

Private Attributes
const cellModel *	m
	Access to the cellShape's model. More...

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

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

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

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

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

Protected Member Functions inherited from List
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/3]

cellShape ( )

inline

Construct null.

Definition at line 31 of file cellShapeI.H.

◆ cellShape() [2/3]

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

inline

Construct from components.

Definition at line 38 of file cellShapeI.H.

◆ cellShape() [3/3]

cellShape ( Istream & is )

inline

Construct from Istream.

Definition at line 54 of file cellShapeI.H.

Member Function Documentation

◆ clone()

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

inline

Clone.

Definition at line 60 of file cellShapeI.H.

◆ points()

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

inline

Return the points corresponding to this cellShape.

Definition at line 69 of file cellShapeI.H.

References forAll, and p.

◆ model()

const Foam::cellModel & model ( ) const

inline

Model reference.

Definition at line 88 of file cellShapeI.H.

Referenced by ensightPartCells::classify(), Foam::operator<<(), vtkTopo::vtkTopo(), STARCD::writeBoundary(), and STARCD::writeCells().

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

References forAll, and List::size().

Here is the call 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 129 of file cellShapeI.H.

References Foam::e, forAll, and List::size().

Here is the call graph for this function:

◆ faces()

Foam::faceList faces ( ) const

inline

Faces of this cell.

Definition at line 162 of file cellShapeI.H.

Referenced by STARCD::writeBoundary().

Here is the caller graph for this function:

◆ collapsedFaces()

Foam::faceList collapsedFaces ( ) const

inline

Collapsed faces of this cell.

Definition at line 168 of file cellShapeI.H.

References f(), forAll, List::setSize(), and List::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 217 of file cellShapeI.H.

◆ edges()

Foam::edgeList edges ( ) const

inline

Edges of this cellShape.

Definition at line 223 of file cellShapeI.H.

◆ nEdges()

Foam::label nEdges ( ) const

inline

Number of edges.

Definition at line 229 of file cellShapeI.H.

◆ nPoints()

Foam::label nPoints ( ) const

inline

Number of points.

Definition at line 235 of file cellShapeI.H.

◆ centre()

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

inline

Centroid of the cell.

Definition at line 241 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.

Used to print token information to a stream

Definition at line 142 of file cellShape.H.

◆ mag()

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

inline

Scalar magnitude.

Definition at line 247 of file cellShapeI.H.

References points.

◆ collapse()

void collapse ( )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 32 of file cellShape.C.

References degenerateMatcher::match(), and List::operator=().

Here is the call 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

Field Documentation

◆ m

const cellModel* m

private

Access to the cellShape's model.

Definition at line 76 of file cellShape.H.

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

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cellShape() [1/3]

◆ cellShape() [2/3]

◆ cellShape() [3/3]

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<<

Field Documentation

◆ m