FreeFOAM The Cross-Platform CFD Toolkit
labelledTri Class Reference

Triangle with additional region number. More...

#include <triSurface/labelledTri.H>


Detailed Description

Triangle with additional region number.

Source files

Definition at line 49 of file labelledTri.H.

+ Inheritance diagram for labelledTri:
+ Collaboration diagram for labelledTri:

List of all members.

Public Member Functions

 labelledTri ()
 Construct null.
 labelledTri (const label a, const label b, const label c, const label region)
 Construct from three point labels and a region label.
 labelledTri (Istream &)
 Construct from Istream.
label region () const
 Return region label.
label & region ()
 Return region label.
- Public Member Functions inherited from triFace
 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.

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from triFace
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.

Constructor & Destructor Documentation

labelledTri ( )
inline

Construct null.

Definition at line 38 of file labelledTriI.H.

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

Construct from three point labels and a region label.

Construct from components.

Definition at line 46 of file labelledTriI.H.

labelledTri ( Istream is)
inline

Construct from Istream.

Definition at line 58 of file labelledTriI.H.

References labelledTri::operator>>.


Member Function Documentation

label region ( ) const
inline
label & region ( )
inline

Return region label.

Definition at line 71 of file labelledTriI.H.


Friends And Related Function Documentation

Istream& operator>> ( Istream is,
labelledTri t 
)
friend

Definition at line 79 of file labelledTriI.H.

Referenced by labelledTri::labelledTri().

Ostream& operator<< ( Ostream os,
const labelledTri t 
)
friend

Definition at line 103 of file labelledTriI.H.


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