A tetrahedral cell primitive. More...

Inheritance diagram for tetCell:

Collaboration diagram for tetCell:

Public Member Functions
	tetCell ()
	Default construct, with invalid point labels (-1) More...

	tetCell (const label a, const label b, const label c, const label d)
	Construct from four point labels. More...

	tetCell (std::initializer_list< label > list)
	Construct from an initializer list of four point labels. More...

	tetCell (const FixedList< label, 4 > &list)
	Construct from FixedList of four point labels. More...

	tetCell (const labelUList &list, const FixedList< label, 4 > &indices)
	Copy construct from a subset of point labels. More...

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

Foam::triFace	face (const label facei) const
	Return i-th face. More...

label	edgeFace (const label edgei) const
	Return first face adjacent to the given edge. More...

label	edgeAdjacentFace (const label edgei, const label facei) const
	Return face adjacent to the given face sharing the same edge. More...

Foam::edge	tetEdge (const label edgei) const
	Return i-th edge from tet. More...

Foam::edge	edge (const label edgei) const
	Return i-th edge. Identical to tetEdge but with generic name. More...

Foam::edge	reverseEdge (const label edgei) const
	Return i-th edge reversed. More...

cellShape	tetCellShape () const
	Return tet shape cell. More...

tetPointRef	tet (const UList< point > &points) const
	Return the tetrahedron. More...

Public Member Functions inherited from FixedList< label, 4 >
void	writeEntry (const word &keyword, Ostream &os) const
	Write the list as a dictionary entry with keyword. More...

	FixedList ()=default
	Default construct. More...

	FixedList (const label &val)
	Construct and initialize all entries to given value. More...

	FixedList (const Foam::zero)
	Construct and initialize all entries to zero. More...

	FixedList (const label list[N])
	Copy construct from C-array. More...

	FixedList (const FixedList< label, N > &list)
	Copy construct. More...

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

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

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

	FixedList (const UList< label > &list)
	Construct from UList. More...

	FixedList (const UList< label > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. More...

	FixedList (const SLList< label > &list)
	Construct from SLList. More...

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

autoPtr< FixedList< label, N > >	clone () const
	Clone. More...

const label *	cdata () const noexcept
	Return a const pointer to the first data element. More...

label *	data () noexcept
	Return a pointer to the first data element. More...

label &	first () noexcept
	The first element of the list, position [0]. More...

const label &	first () const noexcept
	The first element of the list, position [0]. More...

label &	last () noexcept
	The last element of the list, position [N-1]. More...

const label &	last () const noexcept
	The last element of the list, position [N-1]. More...

label	fcIndex (const label i) const

const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

label &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

label	rcIndex (const label i) const

const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

label &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

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

void	checkSize (const label size) const
	Check size is identical to template parameter N. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,N) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const label &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const label &val, label pos=0) const
	True if the value if found in the list. More...

void	resize (const label n)
	Dummy function, to make FixedList consistent with List. More...

void	setSize (const label n)
	Dummy function, to make FixedList consistent with List. More...

void	fill (const label &val)
	Assign all entries to the given value. More...

void	fill (const Foam::zero)
	Assign all entries to zero. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. More...

void	swapLast (const label i)
	Swap element with the last element. More...

void	transfer (FixedList< label, N > &list)

label &	operator[] (const label i)
	Return element of FixedList. More...

const label &	operator[] (const label i) const
	Return element of constant FixedList. More...

void	operator= (const label list[N])
	Assignment to array operator. Takes linear time. More...

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

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

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

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

void	operator= (const Foam::zero)
	Assign all entries to zero. fill() More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	swap (FixedList< label, N > &list)
	Swap lists by swapping the content of the individual list elements. More...

bool	operator== (const FixedList< label, N > &list) const
	Equality operation on FixedLists of the same type. More...

bool	operator!= (const FixedList< label, N > &list) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator> (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator<= (const FixedList< label, N > &list) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const FixedList< label, N > &list) const
	Return true if !(a < b). Takes linear time. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

Additional Inherited Members
Public Types inherited from FixedList< label, 4 >
typedef label	value_type
	The value type the FixedList contains. More...

typedef label *	pointer
	The pointer type for non-const access to value_type items. More...

typedef label &	reference
	The type used for storing into value_type objects. More...

typedef label *	iterator
	Random access iterator for traversing FixedList. More...

typedef label	size_type
	The type to represent the size of a FixedList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Static Public Member Functions inherited from FixedList< label, 4 >
static const FixedList< label, N > &	null ()
	Return a null FixedList. More...

static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled. More...

static constexpr label	size () noexcept
	Return the number of elements in the FixedList. More...

static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList. More...

Public Attributes inherited from FixedList< label, 4 >
const typedef label *	const_pointer
	The pointer type for const access to value_type items. More...

const typedef label &	const_reference
	The type used for reading from constant value_type objects. More...

const typedef label *	const_iterator
	Random access iterator for traversing FixedList. More...

Protected Member Functions inherited from FixedList< label, 4 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type. More...

Detailed Description

A tetrahedral cell primitive.

It is important that the ordering of edges is the same for a tetrahedron class, a tetrahedron cell shape model and a tetCell

Source files

Definition at line 62 of file tetCell.H.

Constructor & Destructor Documentation

◆ tetCell() [1/6]

tetCell ( )

inline

Default construct, with invalid point labels (-1)

Definition at line 31 of file tetCellI.H.

◆ tetCell() [2/6]

tetCell	(	const label	a,
		const label	b,
		const label	c,
		const label	d
	)

inline

Construct from four point labels.

Definition at line 38 of file tetCellI.H.

References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.

◆ tetCell() [3/6]

tetCell ( std::initializer_list< label > list )

inlineexplicit

Construct from an initializer list of four point labels.

Definition at line 52 of file tetCellI.H.

◆ tetCell() [4/6]

tetCell ( const FixedList< label, 4 > & list )

inline

Construct from FixedList of four point labels.

Definition at line 58 of file tetCellI.H.

◆ tetCell() [5/6]

tetCell	(	const labelUList &	list,
		const FixedList< label, 4 > &	indices
	)

inline

Copy construct from a subset of point labels.

Definition at line 65 of file tetCellI.H.

◆ tetCell() [6/6]

tetCell ( Istream & is )

inline

Construct from Istream.

Definition at line 74 of file tetCellI.H.

Member Function Documentation

◆ face()

Foam::triFace face ( const label facei ) const

inline

Return i-th face.

Definition at line 82 of file tetCellI.H.

References Foam::abort(), Foam::constant::physicoChemical::b, Foam::constant::universal::c, Foam::FatalError, FatalErrorInFunction, and triFace().

Here is the call graph for this function:

◆ edgeFace()

Foam::label edgeFace ( const label edgei ) const

inline

Return first face adjacent to the given edge.

Definition at line 108 of file tetCellI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ edgeAdjacentFace()

Foam::label edgeAdjacentFace	(	const label	edgei,
		const label	facei
	)		const

inline

Return face adjacent to the given face sharing the same edge.

Definition at line 128 of file tetCellI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ tetEdge()

Foam::edge tetEdge ( const label edgei ) const

inline

Return i-th edge from tet.

Definition at line 165 of file tetCellI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ edge()

Foam::edge edge ( const label edgei ) const

inline

Return i-th edge. Identical to tetEdge but with generic name.

Definition at line 185 of file tetCellI.H.

◆ reverseEdge()

Foam::edge reverseEdge ( const label edgei ) const

inline

Return i-th edge reversed.

Definition at line 191 of file tetCellI.H.

References edge::reverseEdge().

Here is the call graph for this function:

◆ tetCellShape()

Foam::cellShape tetCellShape ( ) const

Return tet shape cell.

Definition at line 33 of file tetCell.C.

References cellModel::ptr(), and cellModel::TET.

Here is the call graph for this function:

◆ tet()

Foam::tetPointRef tet ( const UList< point > & points ) const

inline

Return the tetrahedron.

Definition at line 198 of file tetCellI.H.

References points.

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

src/OpenFOAM/meshes/meshShapes/tetCell/tetCell.H
src/OpenFOAM/meshes/meshShapes/tetCell/tetCell.C
src/OpenFOAM/meshes/meshShapes/tetCell/tetCellI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ tetCell() [1/6]

◆ tetCell() [2/6]

◆ tetCell() [3/6]

◆ tetCell() [4/6]

◆ tetCell() [5/6]

◆ tetCell() [6/6]

Member Function Documentation

◆ face()

◆ edgeFace()

◆ edgeAdjacentFace()

◆ tetEdge()

◆ edge()

◆ reverseEdge()

◆ tetCellShape()

◆ tet()