A cell is defined as a list of faces with extra functionality. More...

Inheritance diagram for cell:

Collaboration diagram for cell:

Public Member Functions
constexpr	cell () noexcept=default
	Default construct. More...

	cell (const label sz)
	Construct given size, with invalid point labels (-1) More...

	cell (const labelUList &list)
	Copy construct from list of face labels. More...

	cell (labelList &&list)
	Move construct from list of face labels. More...

template<unsigned N>
	cell (const FixedList< label, N > &list)
	Copy construct from list of face labels. More...

	cell (const labelUList &list, const labelUList &indices)
	Copy construct from subset of face labels. More...

template<unsigned N>
	cell (const labelUList &list, const FixedList< label, N > &indices)
	Copy construct from subset of face labels. More...

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

label	nFaces () const noexcept
	Return number of faces. More...

labelList	labels (const faceUList &meshFaces) const
	Return unordered list of cell vertices given the list of faces. More...

pointField	points (const faceUList &meshFaces, const UList< point > &meshPoints) const
	Return the cell vertices given the list of faces and mesh points. More...

edgeList	edges (const faceUList &meshFaces) const
	Return cell edges. More...

label	opposingFaceLabel (const label masterFaceLabel, const faceUList &meshFaces) const
	Return index of opposite face. More...

oppositeFace	opposingFace (const label masterFaceLabel, const faceUList &meshFaces) const
	Return opposite face oriented the same way as the master face. More...

point	centre (const UList< point > &meshPoints, const faceUList &meshFaces) const
	Returns cell centre. More...

scalar	mag (const UList< point > &meshPoints, const faceUList &meshFaces) const
	Returns cell volume. More...

Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Default construct. 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<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	clear ()
	Clear the list, i.e. set size to zero. More...

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

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

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

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

void	setSize (const label n, const T &val)
	Alias for resize() 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...

label	appendUniq (const T &val)
	Append an element if not already in the 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...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. 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<>
Istream &	readList (Istream &is)

template<>
void	resize (const label newLen)

template<>
Istream &	readList (Istream &is)

Static Public Attributes
static const char *const	typeName = "cell"

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

A cell is defined as a list of faces with extra functionality.

Source files

Definition at line 54 of file cell.H.

Constructor & Destructor Documentation

◆ cell() [1/8]

constexpr cell ( )

constexprdefaultnoexcept

Default construct.

◆ cell() [2/8]

cell ( const label sz )

inlineexplicit

Construct given size, with invalid point labels (-1)

Definition at line 31 of file cellI.H.

◆ cell() [3/8]

cell ( const labelUList & list )

inlineexplicit

Copy construct from list of face labels.

Definition at line 37 of file cellI.H.

◆ cell() [4/8]

cell ( labelList && list )

inlineexplicit

Move construct from list of face labels.

Definition at line 50 of file cellI.H.

◆ cell() [5/8]

cell ( const FixedList< label, N > & list )

inlineexplicit

Copy construct from list of face labels.

Definition at line 44 of file cellI.H.

◆ cell() [6/8]

cell	(	const labelUList &	list,
		const labelUList &	indices
	)

inline

Copy construct from subset of face labels.

Definition at line 56 of file cellI.H.

◆ cell() [7/8]

cell	(	const labelUList &	list,
		const FixedList< label, N > &	indices
	)

inline

Copy construct from subset of face labels.

Definition at line 64 of file cellI.H.

◆ cell() [8/8]

cell ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 73 of file cellI.H.

Member Function Documentation

◆ nFaces()

Foam::label nFaces ( ) const

inlinenoexcept

Return number of faces.

Definition at line 81 of file cellI.H.

◆ labels()

Foam::labelList labels ( const faceUList & meshFaces ) const

Return unordered list of cell vertices given the list of faces.

Definition at line 39 of file cell.C.

References pointLabels(), and UList< T >::size().

Here is the call graph for this function:

◆ points()

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

Return the cell vertices given the list of faces and mesh points.

Definition at line 93 of file cell.C.

References Foam::DelaunayMeshTools::allPoints(), forAll, and pointLabels().

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( const faceUList & meshFaces ) const

Return cell edges.

Definition at line 111 of file cell.C.

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

Referenced by layerAdditionRemoval::changeTopology().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ opposingFaceLabel()

Foam::label opposingFaceLabel	(	const label	masterFaceLabel,
		const faceUList &	meshFaces
	)		const

Return index of opposite face.

Definition at line 39 of file oppositeCellFace.C.

References Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ opposingFace()

Foam::oppositeFace opposingFace	(	const label	masterFaceLabel,
		const faceUList &	meshFaces
	)		const

Return opposite face oriented the same way as the master face.

Definition at line 114 of file oppositeCellFace.C.

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

◆ centre()

Foam::point centre	(	const UList< point > &	meshPoints,
		const faceUList &	meshFaces
	)		const

Returns cell centre.

Definition at line 155 of file cell.C.

References f(), and Foam::Zero.

Here is the call graph for this function:

◆ mag()

Foam::scalar mag	(	const UList< point > &	meshPoints,
		const faceUList &	meshFaces
	)		const

Returns cell volume.

Definition at line 219 of file cell.C.

References f(), Foam::mag(), VectorSpace< Form, Cmpt, Ncmpts >::size(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ typeName

const char *const typeName = "cell"

static

Definition at line 62 of file cell.H.

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

src/OpenFOAM/meshes/meshShapes/cell/cell.H
src/OpenFOAM/meshes/meshShapes/cell/cell.C
src/OpenFOAM/meshes/meshShapes/cell/cellI.H
src/OpenFOAM/meshes/meshShapes/cell/oppositeCellFace.C

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cell() [1/8]

◆ cell() [2/8]

◆ cell() [3/8]

◆ cell() [4/8]

◆ cell() [5/8]

◆ cell() [6/8]

◆ cell() [7/8]

◆ cell() [8/8]

Member Function Documentation

◆ nFaces()

◆ labels()

◆ points()

◆ edges()

◆ opposingFaceLabel()

◆ opposingFace()

◆ centre()

◆ mag()

Member Data Documentation

◆ typeName