tetPoints Class Reference

Tet storage. Null constructable (unfortunately tetrahedron<point, point> is not) More...

Inheritance diagram for tetPoints:
Collaboration diagram for tetPoints:

Public Member Functions

 tetPoints ()
 Construct null. More...
 
 tetPoints (const point &a, const point &b, const point &c, const point &d)
 Construct from four points. More...
 
tetPointRef tet () const
 Return the tetrahedron. More...
 
treeBoundBox bounds () const
 Calculate the bounding box. More...
 
- Public Member Functions inherited from FixedList< point, 4 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const pointv[Size])
 Construct from C-array. More...
 
 FixedList (const point &)
 Construct from value. More...
 
 FixedList (const UList< point > &)
 Construct from UList. More...
 
 FixedList (const SLList< point > &)
 Construct from SLList. More...
 
 FixedList (const FixedList< point, Size > &)
 Copy constructor. More...
 
 FixedList (Istream &)
 Construct from Istream. More...
 
autoPtr< FixedList< point, 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 pointcdata () const
 Return a const pointer to the first data element,. More...
 
pointdata ()
 Return a pointer to the first data element,. More...
 
pointfirst ()
 Return the first element of the list. More...
 
const pointfirst () const
 Return first element of the list. More...
 
pointlast ()
 Return the last element of the list. More...
 
const pointlast () 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< point, Size > &)
 Copy (not transfer) the argument contents. More...
 
void writeEntry (Ostream &) const
 Write the FixedList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the FixedList as a dictionary entry with keyword. More...
 
pointoperator[] (const label)
 Return element of FixedList. More...
 
const pointoperator[] (const label) const
 Return element of constant FixedList. More...
 
void operator= (const pointv[Size])
 Assignment from array operator. Takes linear time. More...
 
void operator= (const UList< point > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const SLList< point > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const point &)
 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< point, Size > &)
 Swap two FixedLists of the same type in constant time. More...
 
bool operator== (const FixedList< point, Size > &) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< point, Size > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< point, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< point, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< point, Size > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< point, Size > &) const
 Return true if !(a < b). Takes linear time. More...
 

Additional Inherited Members

- Public Types inherited from FixedList< point, 4 >
typedef point value_type
 Type of values the FixedList contains. More...
 
typedef pointreference
 Type that can be used for storing into. More...
 
typedef const pointconst_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 pointiterator
 Random access iterator for traversing FixedList. More...
 
typedef const pointconst_iterator
 Random access iterator for traversing FixedList. More...
 
typedef pointreverse_iterator
 Reverse iterator for reverse traversal of FixedList. More...
 
typedef const pointconst_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList. More...
 
- Static Public Member Functions inherited from FixedList< point, 4 >
static const FixedList< point,
Size > & 
null ()
 Return a null FixedList. More...
 

Detailed Description

Tet storage. Null constructable (unfortunately tetrahedron<point, point> is not)

Source files

Definition at line 50 of file tetPoints.H.

Constructor & Destructor Documentation

tetPoints ( )
inline

Construct null.

Definition at line 59 of file tetPoints.H.

tetPoints ( const point a,
const point b,
const point c,
const point d 
)
inline

Construct from four points.

Definition at line 64 of file tetPoints.H.

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

Here is the call graph for this function:

Member Function Documentation

tetPointRef tet ( ) const
inline

Return the tetrahedron.

Definition at line 80 of file tetPoints.H.

treeBoundBox bounds ( ) const
inline

Calculate the bounding box.

Definition at line 92 of file tetPoints.H.

References boundBox::max(), Foam::max(), boundBox::min(), Foam::min(), FixedList< point, 4 >::operator[](), and FixedList< point, 4 >::size().

Referenced by tetOverlapVolume::cellCellOverlapMinDecomp(), and tetOverlapVolume::cellCellOverlapVolumeMinDecomp().

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following file:
  • src/OpenFOAM/meshes/primitiveShapes/tetrahedron/tetPoints.H