FreeFOAM The Cross-Platform CFD Toolkit
triFace Class Reference

A triangle face primitive using a FixedList. More...

#include <OpenFOAM/triFace.H>


Detailed Description

A triangle face primitive using a FixedList.

Source files

Definition at line 63 of file triFace.H.

+ Inheritance diagram for triFace:
+ Collaboration diagram for triFace:

List of all members.

Public Member Functions

 triFace ()
 Construct null.
 triFace (const label a, const label b, const label c)
 Construct from three point labels.
 triFace (const UList< label > &)
 Construct from a UList<label>
 triFace (Istream &)
 Construct from Istream.
label collapse ()
 Collapse face by removing duplicate point labels.
int edgeDirection (const edge &) const
 Return the edge direction on the face.
pointField points (const pointField &points) const
 Return the points corresponding to this face.
face triFaceFace () const
 Return triangle as a face.
label nEdges () const
 Return number of edges.
edgeList edges () const
 Return edges.
point centre (const pointField &) const
 Return centre (centroid)
scalar mag (const pointField &) const
 Return scalar magnitude.
vector normal (const pointField &) const
 Return vector normal.
label nTriangles () const
 Number of triangles after splitting.
triFace reverseFace () const
 Return face with reverse direction.
scalar sweptVol (const pointField &oldPoints, const pointField &newPoints) const
 Return swept-volume.
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, with.
triPointRef tri (const pointField &) const
 Return the triangle.
- Public Member Functions inherited from FixedList< label, 3 >
 FixedList ()
 Null constructor.
 FixedList (const labelv[Size])
 Construct from components.
 FixedList (const label &)
 Construct from value.
 FixedList (const UList< label > &)
 Construct from UList.
 FixedList (const SLList< label > &)
 Construct from SLList.
 FixedList (const FixedList< label, Size > &)
 Copy constructor.
 FixedList (Istream &)
 Construct from Istream.
autoPtr< FixedList< label, Size > > clone () const
 Clone.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
const label * cdata () const
 Return a const pointer to the first data element,.
label * data ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void resize (const label)
 Dummy resize function.
void setSize (const label)
 Dummy setSize function.
void transfer (const FixedList< label, Size > &)
 Copy (not transfer) the argument contents.
void writeEntry (Ostream &) const
 Write the FixedList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the FixedList as a dictionary entry with keyword.
label & operator[] (const label)
 Return element of FixedList.
const label & operator[] (const label) const
 Return element of constant FixedList.
void operator= (const labelv[Size])
 Assignment from array operator. Takes linear time.
void operator= (const UList< label > &)
 Assignment from UList operator. Takes linear time.
void operator= (const SLList< label > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const label &)
 Assignment of all entries to the given value.
iterator begin ()
 Return an iterator to begin traversing the FixedList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant FixedList.
iterator end ()
 Return an iterator to end traversing the FixedList.
const_iterator end () const
 Return const_iterator to end traversing the constant FixedList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant FixedList.
const_iterator cend () const
 Return const_iterator to end traversing the constant FixedList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the FixedList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing 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.
label size () const
 Return the number of elements in the FixedList.
label max_size () const
 Return size of the largest possible FixedList.
bool empty () const
 Return true if the FixedList is empty (ie, size() is zero).
void swap (FixedList< label, Size > &)
 Swap two FixedLists of the same type in constant time.
bool operator== (const FixedList< label, Size > &) const
 Equality operation on FixedLists of the same type.
bool operator!= (const FixedList< label, Size > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time.
bool operator> (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time.
bool operator<= (const FixedList< label, Size > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const FixedList< label, Size > &) const
 Return true if !(a < b). Takes linear time.

Static Public Member Functions

static int compare (const triFace &, const triFace &)
 compare triFaces
- Static Public Member Functions inherited from FixedList< label, 3 >
static const FixedList< label,
Size > & 
null ()
 Return a null FixedList.

Friends

bool operator== (const triFace &, const triFace &)
bool operator!= (const triFace &, const triFace &)

Additional Inherited Members

- Public Types inherited from FixedList< label, 3 >
typedef label value_type
 Type of values the FixedList contains.
typedef label & reference
 Type that can be used for storing into.
typedef const label & const_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a FixedList.
typedef label * iterator
 Random access iterator for traversing FixedList.
typedef const label * const_iterator
 Random access iterator for traversing FixedList.
typedef label * reverse_iterator
 Reverse iterator for reverse traversal of FixedList.
typedef const label * const_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList.

Constructor & Destructor Documentation

triFace ( )
inline

Construct null.

Definition at line 63 of file triFaceI.H.

triFace ( const label  a,
const label  b,
const label  c 
)
inline

Construct from three point labels.

Definition at line 68 of file triFaceI.H.

References b.

triFace ( const UList< label > &  lst)
inlineexplicit

Construct from a UList<label>

Definition at line 80 of file triFaceI.H.

triFace ( Istream is)
inline

Construct from Istream.

Definition at line 86 of file triFaceI.H.


Member Function Documentation

Foam::label collapse ( )
inline

Collapse face by removing duplicate point labels.

return the collapsed size, set collapsed point labels to -1

Definition at line 94 of file triFaceI.H.

int edgeDirection ( const edge e) const
inline

Return the edge direction on the face.

  • +1: forward (counter-clockwise) on the face

-1: reverse (clockwise) on the face

  • 0: edge not found on the face

Definition at line 172 of file triFaceI.H.

References edge::end(), and edge::start().

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

Return the points corresponding to this face.

Definition at line 121 of file triFaceI.H.

References p.

Foam::face triFaceFace ( ) const
inline

Return triangle as a face.

Definition at line 133 of file triFaceI.H.

References f().

Referenced by sampledTriSurfaceMesh::update().

Foam::label nEdges ( ) const
inline

Return number of edges.

Definition at line 145 of file triFaceI.H.

Foam::edgeList edges ( ) const
inline

Return edges.

Definition at line 151 of file triFaceI.H.

References e, and UList< T >::end().

Foam::point centre ( const pointField points) const
inline

Return centre (centroid)

Definition at line 199 of file triFaceI.H.

Foam::scalar mag ( const pointField points) const
inline

Return scalar magnitude.

Definition at line 210 of file triFaceI.H.

References Foam::mag().

Foam::vector normal ( const pointField points) const
inline

Return vector normal.

Definition at line 216 of file triFaceI.H.

Referenced by triSurfaceMesh::getNormal().

Foam::label nTriangles ( ) const
inline

Number of triangles after splitting.

Definition at line 226 of file triFaceI.H.

Foam::triFace reverseFace ( ) const
inline

Return face with reverse direction.

Definition at line 232 of file triFaceI.H.

References triFace().

Foam::scalar sweptVol ( const pointField oldPoints,
const pointField newPoints 
) const
inline

Return swept-volume.

Definition at line 240 of file triFaceI.H.

Foam::pointHit ray ( const point p,
const vector q,
const pointField points,
const intersection::algorithm  alg = intersection::FULL_RAY,
const intersection::direction  dir = intersection::VECTOR 
) const
inline

Return point intersection with a ray starting at p, with.

direction n.

Definition at line 273 of file triFaceI.H.

Foam::triPointRef tri ( const pointField points) const
inline

Return the triangle.

Definition at line 290 of file triFaceI.H.

Referenced by triSurfaceTools::calcInterpolationWeights().

int compare ( const triFace a,
const triFace b 
)
inlinestatic

compare triFaces

  • 0: different

+1: identical

  • -1: same face, but different orientation

Definition at line 32 of file triFaceI.H.

Referenced by Foam::operator!=(), and Foam::operator==().


Friends And Related Function Documentation

bool operator== ( const triFace ,
const triFace  
)
friend
bool operator!= ( const triFace ,
const triFace  
)
friend

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