FreeFOAM The Cross-Platform CFD Toolkit
oppositeFace Class Reference

Class containing opposite face for a prismatic cell with addresing and a possibility of failure. More...

#include <OpenFOAM/oppositeFace.H>


Detailed Description

Class containing opposite face for a prismatic cell with addresing and a possibility of failure.

Source files

Definition at line 50 of file oppositeFace.H.

+ Inheritance diagram for oppositeFace:
+ Collaboration diagram for oppositeFace:

List of all members.

Public Member Functions

 oppositeFace (const face &f, const label masterIndex, const label oppositeIndex)
 Construct from components.
label masterIndex () const
 Master face index.
label oppositeIndex () const
 Slave face index.
bool found () const
 Does the opposite face exist?
- Public Member Functions inherited from face
 face ()
 Construct null.
 face (label)
 Construct given size.
 face (const UList< label > &)
 Construct from list of labels.
 face (const labelList &)
 Construct from list of labels.
 face (const Xfer< labelList > &)
 Construct by transferring the parameter contents.
 face (const triFace &)
 Copy construct from triFace.
 face (Istream &)
 Construct from Istream.
label collapse ()
 Collapse face by removing duplicate point labels.
pointField points (const pointField &meshPoints) const
 Return the points corresponding to this face.
point centre (const pointField &) const
 Centre point of face.
template<class Type >
Type average (const pointField &, const Field< Type > &) const
 Calculate average value at centroid of face.
scalar mag (const pointField &) const
 Scalar magnitude.
vector normal (const pointField &) const
 Vector normal; magnitude is equal to area of face.
face reverseFace () const
 Return face with reverse direction.
label which (const label globalIndex) const
 Navigation through face vertices.
label nextLabel (const label i) const
 Next vertex on face.
label prevLabel (const label i) const
 Previous vertex on face.
scalar sweptVol (const pointField &oldPoints, const pointField &newPoints) const
 Return the volume swept out by the face when its points move.
pointHit ray (const point &p, const vector &n, const pointField &meshPoints, const intersection::algorithm alg=intersection::FULL_RAY, const intersection::direction dir=intersection::VECTOR) const
 Return potential intersection with face with a ray starting.
pointHit intersection (const point &p, const vector &q, const point &ctr, const pointField &meshPoints, const intersection::algorithm alg, const scalar tol=0.0) const
 Fast intersection with a ray.
pointHit nearestPoint (const point &p, const pointField &meshPoints) const
 Return nearest point to face.
scalar contactSphereDiameter (const point &p, const vector &n, const pointField &meshPoints) const
 Return contact sphere diameter.
scalar areaInContact (const pointField &points, const scalarField &v) const
 Return area in contact, given the displacement in vertices.
label nEdges () const
 Return number of edges.
edgeList edges () const
 Return edges in face point ordering, i.e. edges()[0] is edge.
edge faceEdge (const label n) const
 Return n-th face edge.
int edgeDirection (const edge &) const
 Return the edge direction on the face.
label nTriangles () const
 Number of triangles after splitting.
label nTriangles (const pointField &points) const
 Number of triangles after splitting.
label triangles (const pointField &points, label &triI, faceList &triFaces) const
 Split into triangles using existing points.
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
label triangles (const pointField &points, DynamicList< face, SizeInc, SizeMult, SizeDiv > &triFaces) const
 Split into triangles using existing points.
label nTrianglesQuads (const pointField &points, label &nTris, label &nQuads) const
 Number of triangles and quads after splitting.
label trianglesQuads (const pointField &points, label &triI, label &quadI, faceList &triFaces, faceList &quadFaces) const
 Split into triangles and quads.
- Public Member Functions inherited from List< T >
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const T &)
 Construct with given size and value for all elements.
 List (const List< T > &)
 Copy constructor.
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents.
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< T > &, const unallocLabelList &mapAddressing)
 Construct as subset.
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< T > &)
 Construct as copy of PtrList<T>
 List (const SLList< T > &)
 Construct as copy of SLList<T>
 List (const IndirectList< T > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< T > > clone () const
 Clone.
 ~List ()
label size () const
 Return the number of elements in the UList.
void resize (const label)
 Reset size of List.
void resize (const label, const T &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const T &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< T > &)
 Append a List at the end of this list.
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list.
void transfer (List< T > &)
 Transfer the contents of the argument List into this list.
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list.
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container.
TnewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< T > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< T > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const T &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor.
 UList (T *__restrict__ v, label size)
 Construct from components.
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.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Tcdata () const
 Return a const pointer to the first data element,.
Tdata ()
 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< T > &)
 Assign elements to those from UList.
Toperator[] (const label)
 Return element of UList.
const Toperator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< T > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time.
template<>
const bool & operator[] (const label i) const

Additional Inherited Members

- Static Public Member Functions inherited from face
static int compare (const face &, const face &)
 compare faces
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List.
- Static Public Attributes inherited from face
static const char *const typeName = "face"

Constructor & Destructor Documentation

oppositeFace ( const face f,
const label  masterIndex,
const label  oppositeIndex 
)
inline

Construct from components.

Definition at line 69 of file oppositeFace.H.


Member Function Documentation

label masterIndex ( ) const
inline

Master face index.

Definition at line 85 of file oppositeFace.H.

label oppositeIndex ( ) const
inline

Slave face index.

Definition at line 91 of file oppositeFace.H.

bool found ( ) const
inline

Does the opposite face exist?

Definition at line 97 of file oppositeFace.H.


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