Public Member Functions | Friends | List of all members
labelledTri Class Reference

Triangle with additional region number. More...

Inheritance diagram for labelledTri:
Inheritance graph
[legend]
Collaboration diagram for labelledTri:
Collaboration graph
[legend]

Public Member Functions

 labelledTri ()
 Construct null. More...
 
 labelledTri (const triFace &, const label region)
 Construct from triFace and a region label. More...
 
 labelledTri (const label a, const label b, const label c, const label region)
 Construct from three point labels and a region label. More...
 
 labelledTri (Istream &)
 Construct from Istream. More...
 
label region () const
 Return region label. More...
 
labelregion ()
 Return region label. More...
 
- Public Member Functions inherited from triFace
 triFace ()
 Construct null. More...
 
 triFace (const label a, const label b, const label c)
 Construct from three point labels. More...
 
 triFace (const labelUList &)
 Construct from a list of labels. More...
 
 triFace (Istream &)
 Construct from Istream. More...
 
label collapse ()
 Collapse face by removing duplicate point labels. More...
 
void flip ()
 Flip the face in-place. More...
 
pointField points (const pointField &) const
 Return the points corresponding to this face. More...
 
face triFaceFace () const
 Return triangle as a face. More...
 
triPointRef tri (const pointField &) const
 Return the triangle. More...
 
point centre (const pointField &) const
 Return centre (centroid) More...
 
template<class Type >
Type average (const pointField &, const Field< Type > &) const
 Calculate average value at centroid of face. More...
 
scalar mag (const pointField &) const
 Magnitude of face area. More...
 
vector normal (const pointField &) const
 Vector normal; magnitude is equal to area of face. More...
 
label nTriangles () const
 Number of triangles after splitting. More...
 
triFace reverseFace () const
 Return face with reverse direction. More...
 
scalar sweptVol (const pointField &oldPoints, const pointField &newPoints) const
 Return swept-volume. More...
 
tensor inertia (const pointField &, const point &refPt=vector::zero, scalar density=1.0) const
 Return the inertia tensor, with optional reference. More...
 
pointHit ray (const point &p, const vector &q, const pointField &points, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction dir=intersection::VECTOR) const
 Return point intersection with a ray starting at p,. More...
 
pointHit intersection (const point &p, const vector &q, const pointField &points, const intersection::algorithm alg, const scalar tol=0.0) const
 Fast intersection with a ray. More...
 
pointHit intersection (const point &p, const vector &q, const point &ctr, const pointField &points, const intersection::algorithm alg, const scalar tol=0.0) const
 
pointHit nearestPoint (const point &p, const pointField &points) const
 Return nearest point to face. More...
 
pointHit nearestPointClassify (const point &p, const pointField &points, label &nearType, label &nearLabel) const
 Return nearest point to face and classify it: More...
 
label nEdges () const
 Return number of edges. More...
 
edgeList edges () const
 Return edges in face point ordering,. More...
 
edge faceEdge (const label n) const
 Return n-th face edge. More...
 
int edgeDirection (const edge &) const
 Return the edge direction on the face. More...
 
- Public Member Functions inherited from FixedList< label, 3 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const label v[Size])
 Construct from C-array. More...
 
 FixedList (const label &)
 Construct from value. More...
 
 FixedList (const UList< label > &)
 Construct from UList. More...
 
 FixedList (const SLList< label > &)
 Construct from SLList. More...
 
 FixedList (const FixedList< label, Size > &)
 Copy constructor. 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...
 
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...
 
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 from array operator. Takes linear time. More...
 
void operator= (const UList< label > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const SLList< label > &)
 Assignment from SLList operator. 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...
 

Friends

Istreamoperator>> (Istream &, labelledTri &)
 
Ostreamoperator<< (Ostream &, const labelledTri &)
 

Additional Inherited Members

- Public Types inherited from FixedList< label, 3 >
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 triFace
static int compare (const triFace &, const triFace &)
 Compare triFaces. More...
 
- Static Public Member Functions inherited from FixedList< label, 3 >
static const FixedList< label, Size > & null ()
 Return a null FixedList. More...
 

Detailed Description

Triangle with additional region number.

Source files

Definition at line 49 of file labelledTri.H.

Constructor & Destructor Documentation

labelledTri ( )
inline

Construct null.

Definition at line 30 of file labelledTriI.H.

Referenced by labelledTri::labelledTri().

Here is the caller graph for this function:

labelledTri ( const triFace tri,
const label  region 
)
inline

Construct from triFace and a region label.

Definition at line 37 of file labelledTriI.H.

References labelledTri::labelledTri().

Here is the call graph for this function:

labelledTri ( const label  a,
const label  b,
const label  c,
const label  region 
)
inline

Construct from three point labels and a region label.

Definition at line 48 of file labelledTriI.H.

labelledTri ( Istream is)
inline

Construct from Istream.

Definition at line 60 of file labelledTriI.H.

References labelledTri::operator>>.

Member Function Documentation

Foam::label region ( ) const
inline

Return region label.

Definition at line 68 of file labelledTriI.H.

Referenced by booleanSurface::booleanSurface(), NamedEnum< Enum, nEnum >::names(), boundaryMesh::readTriSurface(), and triSurface::triSurfInstance().

Here is the caller graph for this function:

Foam::label & region ( )
inline

Friends And Related Function Documentation

Istream& operator>> ( Istream ,
labelledTri  
)
friend
Ostream& operator<< ( Ostream ,
const labelledTri  
)
friend

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