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

Inheritance diagram for cell:

Collaboration diagram for cell:

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

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

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

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

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

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

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

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

edgeList	edges (const faceUList &f) 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 > &p, const faceUList &f) const
	Returns cell centre. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

	List (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

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

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

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

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

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

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

	List (DynamicList< label, SizeMin > &&list)
	Move construct from DynamicList. More...

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

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

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

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

	~List ()
	Destructor. More...

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

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

void	resize (const label newSize)

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

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

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

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

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

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

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

void	transfer (List< label > &list)

void	transfer (DynamicList< label, SizeMin > &list)

void	transfer (SortableList< label > &list)

label &	newElmt (const label i)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from List< label >
static const List< label > &	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/5]

cell ( )

inline

Construct null.

Definition at line 30 of file cellI.H.

◆ cell() [2/5]

cell ( const label sz )

inlineexplicit

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

Definition at line 34 of file cellI.H.

◆ cell() [3/5]

cell ( const labelUList & lst )

inlineexplicit

Copy construct from list of labels.

Definition at line 40 of file cellI.H.

◆ cell() [4/5]

cell ( labelList && lst )

inlineexplicit

Move construct from list of labels.

Definition at line 46 of file cellI.H.

◆ cell() [5/5]

cell ( Istream & is )

inline

Construct from Istream.

Definition at line 52 of file cellI.H.

Member Function Documentation

◆ nFaces()

Foam::label nFaces ( ) const

inline

Return number of faces.

Definition at line 60 of file cellI.H.

◆ labels()

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

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

Definition at line 37 of file cell.C.

References f(), forAll, found, and p.

Here is the call graph for this function:

◆ points()

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

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

Definition at line 104 of file cell.C.

References f(), forAll, p, and pointLabels().

Here is the call graph for this function:

◆ edges()

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

Return cell edges.

Definition at line 122 of file cell.C.

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

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 > &	p,
		const faceUList &	f
	)		const

Returns cell centre.

Definition at line 175 of file cell.C.

References f(), forAll, p, and Foam::Zero.

Here is the call graph for this function:

◆ mag()

Foam::scalar mag	(	const UList< point > &	p,
		const faceUList &	f
	)		const

Returns cell volume.

Definition at line 241 of file cell.C.

References f(), forAll, Foam::mag(), p, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ typeName

const char *const typeName = "cell"

static

Definition at line 63 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/5]

◆ cell() [2/5]

◆ cell() [3/5]

◆ cell() [4/5]

◆ cell() [5/5]

Member Function Documentation

◆ nFaces()

◆ labels()

◆ points()

◆ edges()

◆ opposingFaceLabel()

◆ opposingFace()

◆ centre()

◆ mag()

Member Data Documentation

◆ typeName