A tetrahedral cell primitive. More...

#include <tetCell.H>

Inheritance diagram for tetCell:

Collaboration diagram for tetCell:

Public Member Functions
void	front ()=delete
	The front() accessor (from FixedList) has no purpose.
void	back ()=delete
	The back() accessor (from FixedList) has no purpose.
	tetCell ()
	Default construct, with invalid point labels (-1).
	tetCell (const label p0, const label p1, const label p2, const label p3)
	Construct from four point labels.
	tetCell (std::initializer_list< label > list)
	Construct from an initializer list of four point labels.
	tetCell (const FixedList< label, 4 > &list)
	Construct from FixedList of four point labels.
	tetCell (const labelUList &list, const FixedList< label, 4 > &indices)
	Copy construct from a subset of point labels.
template<unsigned AnyNum>
	tetCell (const FixedList< label, AnyNum > &list, const FixedList< label, 4 > &indices)
	Copy construct from a subset of point labels.
	tetCell (Istream &is)
	Construct from Istream.
Foam::triFace	face (const label facei) const
	Return i-th face.
label	edgeFace (const label edgei) const
	Return first face adjacent to the given edge.
label	edgeAdjacentFace (const label edgei, const label facei) const
	Return face adjacent to the given face sharing the same edge.
Foam::edge	edge (const label edgei) const
	Return i-th edge.
Foam::edge	reverseEdge (const label edgei) const
	Return i-th edge reversed.
pointField	points (const UList< point > &meshPoints) const
	The points corresponding to this shape.
cellShape	shape () const
	Return TET shape cell.
tetPointRef	tet (const UList< point > &meshPoints) const
	Return the tetrahedron.
Foam::edge	tetEdge (label edgei) const
	Identical to edge().
cellShape	tetCellShape () const
	Identical to shape().
Public Member Functions inherited from FixedList< label, 4 >
	FixedList ()=default
	Default construct.
autoPtr< FixedList< label, N > >	clone () const
	Clone.
const label *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
label *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
label &	get () noexcept
	Element access using compile-time indexing.
label &	front () noexcept
	Access first element of the list, position [0].
label &	back () noexcept
	Access last element of the list, position [N-1].
label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list.
const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list.
const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is identical to template parameter N.
void	checkIndex (const label i) const
	Check index is within valid range [0,N).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const label &val) const
	True if the value is contained in the list.
label	find (const label &val) const
	Find index of the first occurrence of the value.
label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_fill (const label n, const label &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	setSize (const label n)
	Dummy function, to make FixedList consistent with List.
void	fill (const label &val)
	Assign all entries to the given value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element.
void	swapLast (const label i)
	Swap element with the last element.
void	transfer (FixedList< label, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements.
label &	operator[] (const label i)
	Return element of FixedList.
void	operator= (const UList< label > &list)
	Assignment to UList operator. Takes linear time.
iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList.
iterator	end () noexcept
	Return an iterator to end traversing the FixedList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant FixedList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
void	swap (FixedList< label, N > &other)
	Swap lists by swapping the content of the individual list elements.
bool	operator== (const FixedList< label, N > &list) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< label, N > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< label, N > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< label, N > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
label &	first () noexcept
	Access first element of the list, position [0] - front().
label &	last () noexcept
	Access last element of the list, position [N-1] - back().
bool	found (const label &val, label pos=0) const
	Same as contains().

Static Public Member Functions
static constexpr label	nPoints () noexcept
	Number of points for TET.
static constexpr label	nEdges () noexcept
	Number of edges for TET.
static constexpr label	nFaces () noexcept
	Number of faces for TET.
static const Foam::faceList &	modelFaces ()
	Return the model faces.
static const Foam::edgeList &	modelEdges ()
	Return the model edges.
Static Public Member Functions inherited from FixedList< label, 4 >
static const FixedList< label, N > &	null () noexcept
	Return a null FixedList (reference to a nullObject). Read/write access is questionable.
static std::streamsize	size_bytes () noexcept
	Number of contiguous bytes for the list data,.
static std::streamsize	byteSize ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous.
static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled.
static constexpr label	size () noexcept
	Return the number of elements in the FixedList.
static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList.

Additional Inherited Members
Public Types inherited from FixedList< label, 4 >
typedef label	value_type
	The value type the FixedList contains.
typedef label *	pointer
	The pointer type for non-const access to value_type items.
typedef const label *	const_pointer
	The pointer type for const access to value_type items.
typedef label &	reference
	The type used for storing into value_type objects.
typedef const label &	const_reference
	The type used for reading from constant value_type objects.
typedef label *	iterator
	Random access iterator for traversing FixedList.
typedef const label *	const_iterator
	Random access iterator for traversing FixedList.
typedef label	size_type
	The type to represent the size of a FixedList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
Protected Member Functions inherited from FixedList< label, 4 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type.

Detailed Description

A tetrahedral cell primitive.

It is important that the face/edge ordering is identical for a tetrahedron class, a tetrahedron cell shape model and a tetCell

Source files

Definition at line 60 of file tetCell.H.

Constructor & Destructor Documentation

◆ tetCell() [1/7]

tetCell ( )

inline

Default construct, with invalid point labels (-1).

Definition at line 24 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

◆ tetCell() [2/7]

tetCell	(	const label	p0,
		const label	p1,
		const label	p2,
		const label	p3 )

inline

Construct from four point labels.

Definition at line 30 of file tetCellI.H.

References FixedList< label, 4 >::operator[](), and p0.

Here is the call graph for this function:

◆ tetCell() [3/7]

tetCell ( std::initializer_list< label > list )

inlineexplicit

Construct from an initializer list of four point labels.

Definition at line 45 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

◆ tetCell() [4/7]

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

inline

Construct from FixedList of four point labels.

Definition at line 51 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

◆ tetCell() [5/7]

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

inline

Copy construct from a subset of point labels.

Definition at line 57 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

◆ tetCell() [6/7]

template<unsigned AnyNum>

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

inline

Copy construct from a subset of point labels.

Definition at line 68 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

◆ tetCell() [7/7]

tetCell ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 78 of file tetCellI.H.

References FixedList< label, 4 >::FixedList().

Here is the call graph for this function:

Member Function Documentation

◆ front()

void front ( )

delete

The front() accessor (from FixedList) has no purpose.

◆ back()

void back ( )

delete

The back() accessor (from FixedList) has no purpose.

References FixedList< label, 4 >::FixedList(), and p0.

Here is the call graph for this function:

◆ nPoints()

constexpr label nPoints ( )

inlinestaticconstexprnoexcept

Number of points for TET.

Definition at line 150 of file tetCell.H.

References Foam::noexcept.

◆ nEdges()

constexpr label nEdges ( )

inlinestaticconstexprnoexcept

Number of edges for TET.

Definition at line 158 of file tetCell.H.

References Foam::noexcept.

Referenced by edge(), edgeAdjacentFace(), edgeFace(), and modelEdges().

Here is the caller graph for this function:

◆ nFaces()

constexpr label nFaces ( )

inlinestaticconstexprnoexcept

Number of faces for TET.

Definition at line 166 of file tetCell.H.

References Foam::noexcept.

Referenced by edgeAdjacentFace(), face(), and modelFaces().

Here is the caller graph for this function:

◆ modelFaces()

const Foam::faceList & modelFaces ( )

static

Return the model faces.

Definition at line 57 of file tetCell.C.

References f(), and nFaces().

Here is the call graph for this function:

◆ modelEdges()

const Foam::edgeList & modelEdges ( )

static

Return the model edges.

Definition at line 79 of file tetCell.C.

References e, and nEdges().

Here is the call graph for this function:

◆ face()

Foam::triFace face ( const label facei ) const

inline

Return i-th face.

Definition at line 86 of file tetCellI.H.

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

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 106 of file tetCellI.H.

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

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 125 of file tetCellI.H.

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

Here is the call graph for this function:

◆ edge()

Foam::edge edge ( const label edgei ) const

inline

Return i-th edge.

Definition at line 163 of file tetCellI.H.

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

Referenced by reverseEdge(), and tetEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reverseEdge()

Foam::edge reverseEdge ( const label edgei ) const

inline

Return i-th edge reversed.

Definition at line 182 of file tetCellI.H.

References edge().

Here is the call graph for this function:

◆ points()

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

inline

The points corresponding to this shape.

Definition at line 189 of file tetCellI.H.

◆ shape()

Foam::cellShape shape ( ) const

Return TET shape cell.

Foam::faceList Foam::tetCell::faces() const { Foam::faceList theFaces(tetCell::nFaces(), Foam::face(3));

label facei = 0; for (auto& f : theFaces) { f[0] = (*this)[modelFaces_[facei][0]]; f[1] = (*this)[modelFaces_[facei][1]]; f[2] = (*this)[modelFaces_[facei][2]]; ++facei; }

return theFaces; }

Foam::edgeList Foam::tetCell::edges() const { Foam::edgeList theEdges(tetCell::nEdges());

label edgei = 0; for (auto& e : theEdges) { e[0] = (*this)[modelEdges_[edgei][0]]; e[1] = (*this)[modelEdges_[edgei][1]]; ++edgei; }

return theEdges; }

Definition at line 135 of file tetCell.C.

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

Referenced by tetCellShape().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tet()

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

inline

Return the tetrahedron.

Definition at line 198 of file tetCellI.H.

◆ tetEdge()

Foam::edge tetEdge ( label edgei ) const

inline

Identical to edge().

Definition at line 235 of file tetCell.H.

References edge().

Here is the call graph for this function:

◆ tetCellShape()

Foam::cellShape tetCellShape ( ) const

Identical to shape().

Definition at line 148 of file tetCell.C.

References shape().

Here is the call graph for this function:

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

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ tetCell() [1/7]

◆ tetCell() [2/7]

◆ tetCell() [3/7]

◆ tetCell() [4/7]

◆ tetCell() [5/7]

◆ tetCell() [6/7]

◆ tetCell() [7/7]

Member Function Documentation

◆ front()

◆ back()

◆ nPoints()

◆ nEdges()

◆ nFaces()

◆ modelFaces()

◆ modelEdges()

◆ face()

◆ edgeFace()

◆ edgeAdjacentFace()

◆ edge()

◆ reverseEdge()

◆ points()

◆ shape()

◆ tet()

◆ tetEdge()

◆ tetCellShape()