Class containing opposite face for a prismatic cell with addressing and a possibility of failure. More...
Public Member Functions | |
| oppositeFace (const face &f, const label masterIndex, const label oppositeIndex) | |
| Construct from components. More... | |
| label | masterIndex () const |
| Master face index. More... | |
| label | oppositeIndex () const |
| Slave face index. More... | |
| bool | found () const |
| Does the opposite face exist? More... | |
 Public Member Functions inherited from face | |
| face () | |
| Construct null. More... | |
| face (label) | |
| Construct given size. More... | |
| face (const labelUList &) | |
| Construct from list of labels. More... | |
| face (const labelList &) | |
| Construct from list of labels. More... | |
| face (labelList &&) | |
| Construct by transferring the parameter contents. More... | |
| face (const triFace &) | |
| Copy construct from triFace. More... | |
| face (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... | |
| point | centre (const pointField &) const |
| Centre point of face. More... | |
| template<class Type > | |
| Type | average (const pointField &, const Field< Type > &) const |
| Calculate average value at centroid of face. More... | |
| vector | area (const pointField &) const |
| Return vector area. More... | |
| scalar | mag (const pointField &) const |
| Return scalar magnitude. More... | |
| vector | normal (const pointField &) const |
| Return unit normal. More... | |
| face | reverseFace () const |
| Return face with reverse direction. More... | |
| label | which (const label globalIndex) const |
| Navigation through face vertices. More... | |
| label | nextLabel (const label i) const |
| Next vertex on face. More... | |
| label | prevLabel (const label i) const |
| Previous vertex on face. More... | |
| scalar | sweptVol (const pointField &oldPoints, const pointField &newPoints) const |
| Return the volume swept out by the face when its points move. 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 &n, const pointField &, const intersection::algorithm alg=intersection::algorithm::fullRay, const intersection::direction dir=intersection::direction::vector) const |
| Return potential intersection with face with a ray starting. More... | |
| pointHit | intersection (const point &p, const vector &q, const point &ctr, const pointField &, const intersection::algorithm alg, const scalar tol=0.0) const |
| Fast intersection with a ray. More... | |
| pointHit | nearestPoint (const point &p, const pointField &) const |
| Return nearest point to face. More... | |
| pointHit | nearestPointClassify (const point &p, const pointField &, label &nearType, label &nearLabel) const |
| Return nearest point to face and classify it: More... | |
| scalar | contactSphereDiameter (const point &p, const vector &n, const pointField &) const |
| Return contact sphere diameter. More... | |
| scalar | areaInContact (const pointField &, const scalarField &v) const |
| Return area in contact, given the displacement in vertices. 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... | |
| label | nTriangles () const |
| Size of the face's triangulation. More... | |
| void | operator= (labelList &&) |
| Move assignment labelList. More... | |
| template<class PointField > | |
| Foam::point | centre (const PointField &ps) |
| template<class PointField > | |
| Foam::vector | area (const PointField &ps) |
| Public Member Functions inherited from List< T > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const T &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initialising all elements to zero. More... | |
| List (const List< T > &) | |
| Copy constructor. More... | |
| template<class T2 > | |
| List (const List< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (List< T > &&) | |
| Move constructor. More... | |
| List (List< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< T > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| template<class InputIterator > | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| template<unsigned Size> | |
| List (const FixedList< T, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< T > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< T > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< T > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< T > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< T >) | |
| Construct from an initialiser list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| autoPtr< List< T > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const T &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const T &) |
| Reset size of List and value for new elements. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | append (const T &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< T > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< T > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< T > &) |
| Transfer the contents of the argument List into this list. More... | |
| template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> | |
| void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< T > &) |
| Transfer the contents of the argument List into this list. More... | |
| T & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< T > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< T > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< T > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (List< T > &&) |
| Move assignment operator. More... | |
| void | operator= (const SLList< T > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< T > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< T > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< T >) |
| Assignment to an initialiser list. More... | |
| void | operator= (const T &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| Public Member Functions inherited from UList< T > | |
| UList () | |
| Null constructor. More... | |
| UList (T *__restrict__ v, label size) | |
| Construct from components. 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... | |
| std::streamsize | byteSize () const |
| Return the binary size in number of characters of the UList. More... | |
| const T * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| T * | data () |
| Return a pointer to the first data element,. More... | |
| T & | first () |
| Return the first element of the list. More... | |
| const T & | first () const |
| Return first element of the list. More... | |
| T & | last () |
| Return the last element of the list. More... | |
| const T & | last () 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 | shallowCopy (const UList< T > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< T > &) |
| Copy elements of the given UList. More... | |
| T & | operator[] (const label) |
| Return element of UList. More... | |
| const T & | operator[] (const label) const |
| Return element of constant UList. More... | |
| operator const Foam::List< T > & () const | |
| Allow cast to a const List<T>&. More... | |
| void | operator= (const T &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cend () const |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant UList. More... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| label | max_size () const |
| Return size of the largest possible UList. More... | |
| bool | empty () const |
| Return true if the UList is empty (ie, size() is zero) More... | |
| void | swap (UList< T > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< T > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< T > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< T > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< T > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< T > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< T > &) const |
| Return true if !(a < b). Takes linear time. More... | |
| template<> | |
| const bool & | operator[] (const label i) const |
Additional Inherited Members | |
| Public Types inherited from face | |
| enum | proxType { NONE, POINT, EDGE } |
| Return types for classify. More... | |
| Public Types inherited from List< T > | |
| typedef SubList< T > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< T > | |
| typedef T | value_type |
| Type of values the UList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into. More... | |
| typedef const T & | const_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 UList. More... | |
| typedef T * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const T * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| Static Public Member Functions inherited from face | |
| template<class PointField > | |
| static vector | centre (const PointField &ps) |
| Return centre point given face points. More... | |
| template<class PointField > | |
| static vector | area (const PointField &ps) |
| Return vector area given face points. More... | |
| static int | compare (const face &, const face &) |
| Compare faces. More... | |
| static bool | sameVertices (const face &, const face &) |
| Return true if the faces have the same vertices. More... | |
| Static Public Member Functions inherited from List< T > | |
| static const List< T > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () |
| Return a null UList. More... | |
| Static Public Attributes inherited from face | |
| static const char *const | typeName = "face" |
| Protected Member Functions inherited from List< T > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
Class containing opposite face for a prismatic cell with addressing and a possibility of failure.
Definition at line 49 of file oppositeFace.H.
|
inline |
Construct from components.
Definition at line 68 of file oppositeFace.H.
|
inline |
Master face index.
Definition at line 84 of file oppositeFace.H.
|
inline |
Slave face index.
Definition at line 90 of file oppositeFace.H.
|
inline |
Does the opposite face exist?
Definition at line 96 of file oppositeFace.H.
1.8.13 
