All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
tetCell Class Reference

A tetrahedral cell primitive. More...

Inheritance diagram for tetCell:
Collaboration diagram for tetCell:

Public Member Functions

 tetCell ()
 Construct null. More...
 
 tetCell (const label a, const label b, const label c, const label d)
 Construct from four points. More...
 
 tetCell (const FixedList< label, 4 > &)
 Construct from FixedList. More...
 
 tetCell (Istream &)
 Construct from Istream. More...
 
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...
 
edge tetEdge (const label edgeI) const
 Return i-th edge. More...
 
cellShape tetCellShape () const
 Return tet shape cell. More...
 
tetPointRef tet (const pointField &) const
 Return the tetrahedron. More...
 
- Public Member Functions inherited from FixedList< label, 4 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const label &)
 Construct from value. More...
 
 FixedList (const label v[Size])
 Construct from C-array. More...
 
 FixedList (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 FixedList (std::initializer_list< label >)
 Construct from an initializer list. More...
 
 FixedList (const UList< label > &)
 Construct from UList. More...
 
 FixedList (const SLList< label > &)
 Construct from SLList. More...
 
 FixedList (Istream &)
 Construct from Istream. More...
 
autoPtr< FixedList< label, Size > > clone () const
 Clone. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
const labelcdata () const
 Return a const pointer to the first data element,. More...
 
labeldata ()
 Return a pointer to the first data element,. More...
 
labelfirst ()
 Return the first element of the list. More...
 
const labelfirst () const
 Return first element of the list. More...
 
labellast ()
 Return the last element of the list. More...
 
const labellast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void resize (const label)
 Dummy resize function. More...
 
void setSize (const label)
 Dummy setSize function. More...
 
void transfer (const FixedList< label, Size > &)
 Copy (not transfer) the argument contents. More...
 
labeloperator[] (const label)
 Return element of FixedList. More...
 
const labeloperator[] (const label) const
 Return element of constant FixedList. More...
 
void operator= (const label v[Size])
 Assignment to array operator. Takes linear time. More...
 
void operator= (const UList< label > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const SLList< label > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (std::initializer_list< label >)
 Assignment to an initializer list. Takes linear time. More...
 
void operator= (const label &)
 Assignment of all entries to the given value. 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...
 
label size () const
 Return the number of elements in the FixedList. More...
 
label max_size () const
 Return size of the largest possible FixedList. More...
 
bool empty () const
 Return true if the FixedList is empty (ie, size() is zero) More...
 
void swap (FixedList< label, Size > &)
 Swap two FixedLists of the same type in constant time. More...
 
bool operator== (const FixedList< label, Size > &) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< label, Size > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< label, Size > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< label, Size > &) const
 Return true if !(a < b). Takes linear time. More...
 

Additional Inherited Members

- Public Types inherited from FixedList< label, 4 >
typedef label value_type
 Type of values the FixedList contains. More...
 
typedef labelreference
 Type that can be used for storing into. More...
 
typedef const labelconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a FixedList. More...
 
typedef labeliterator
 Random access iterator for traversing FixedList. More...
 
typedef const labelconst_iterator
 Random access iterator for traversing FixedList. More...
 
typedef labelreverse_iterator
 Reverse iterator for reverse traversal of FixedList. More...
 
typedef const labelconst_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList. More...
 
- Static Public Member Functions inherited from FixedList< label, 4 >
static const FixedList< label, Size > & null ()
 Return a null FixedList. 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 58 of file tetCell.H.

Constructor & Destructor Documentation

◆ tetCell() [1/4]

tetCell ( )
inline

Construct null.

Definition at line 32 of file tetCellI.H.

◆ tetCell() [2/4]

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

Construct from four points.

Definition at line 37 of file tetCellI.H.

References Foam::constant::physicoChemical::b, Foam::constant::universal::c, and FixedList< label, 4 >::operator[]().

Here is the call graph for this function:

◆ tetCell() [3/4]

tetCell ( const FixedList< label, 4 > &  lst)
inline

Construct from FixedList.

Definition at line 51 of file tetCellI.H.

◆ tetCell() [4/4]

tetCell ( Istream is)
inline

Construct from Istream.

Definition at line 57 of file tetCellI.H.

Member Function Documentation

◆ face()

Foam::triFace face ( const label  facei) const
inline

Return i-th face.

Definition at line 65 of file tetCellI.H.

References Foam::abort(), 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 91 of file tetCellI.H.

References Foam::abort(), tetCell::edgeAdjacentFace(), 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 112 of file tetCellI.H.

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

Referenced by tetCell::edgeFace().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tetEdge()

Foam::edge tetEdge ( const label  edgeI) const
inline

Return i-th edge.

Definition at line 149 of file tetCellI.H.

References Foam::abort(), FixedList< label, 4 >::end(), Foam::FatalError, and FatalErrorInFunction.

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 cellModeller::lookup(), and tetCell::tet().

Here is the call graph for this function:

◆ tet()

Foam::tetPointRef tet ( const pointField points) const
inline

Return the tetrahedron.

Definition at line 170 of file tetCellI.H.

Referenced by tetCell::tetCellShape().

Here is the caller graph for this function:

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