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 noexcept |
Master face index. More... | |
label | oppositeIndex () const noexcept |
Opposite face index. More... | |
bool | good () const noexcept |
Does the opposite face exist? More... | |
bool | found () const noexcept |
Does the opposite face exist? More... | |
Public Member Functions inherited from face | |
constexpr | face () noexcept=default |
Default construct. More... | |
face (const label sz) | |
Construct given size, with invalid vertex labels (-1) More... | |
face (const labelUList &list) | |
Copy construct from list of vertex labels. More... | |
face (labelList &&list) | |
Move construct from list of vertex labels. More... | |
face (std::initializer_list< label > list) | |
Copy construct from an initializer list of vertex labels. More... | |
template<unsigned N> | |
face (const FixedList< label, N > &list) | |
Copy construct from list of vertex labels. More... | |
face (const labelUList &list, const labelUList &indices) | |
Copy construct from subset of vertex labels. More... | |
template<unsigned N> | |
face (const labelUList &list, const FixedList< label, N > &indices) | |
Copy construct from subset of vertex labels. More... | |
face (const triFace &f) | |
Copy construct from triFace. More... | |
face (Istream &is) | |
Construct from Istream. More... | |
label | collapse () |
Collapse face by removing duplicate vertex labels. More... | |
void | flip () |
Flip the face in-place. More... | |
pointField | points (const UList< point > &pts) const |
Return the points corresponding to this face. More... | |
point | centre (const UList< point > &points) const |
Centre point of face. More... | |
template<class Type > | |
Type | average (const UList< point > &meshPoints, const Field< Type > &fld) const |
Calculate average value at centroid of face. More... | |
vector | areaNormal (const UList< point > &p) const |
The area normal - with magnitude equal to area of face. More... | |
vector | unitNormal (const UList< point > &p) const |
The unit normal. More... | |
FOAM_DEPRECATED_FOR (2018-12, "areaNormal() or unitNormal()") vector normal(const UList< point > &p) const | |
Legacy name for areaNormal() More... | |
scalar | mag (const UList< point > &p) const |
Magnitude of face area. More... | |
Pair< point > | box (const UList< point > &pts) const |
The enclosing (bounding) box for the face. More... | |
face | reverseFace () const |
Return face with reverse direction. More... | |
label | which (const label vertex) const |
Find local vertex on face for the vertex label, same as find() More... | |
label | thisLabel (const label i) const |
The vertex on face - identical to operator[], but with naming similar to nextLabel(), prevLabel() 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 UList< point > &oldPoints, const UList< point > &newPoints) const |
Return the volume swept out by the face when its points move. More... | |
tensor | inertia (const UList< point > &p, const point &refPt=vector::zero, scalar density=1.0) const |
Return the inertia tensor, with optional reference point and density specification. More... | |
pointHit | ray (const point &p, const vector &n, const UList< point > &meshPoints, const intersection::algorithm alg=intersection::FULL_RAY, const intersection::direction dir=intersection::VECTOR) const |
Return potential intersection with face with a ray starting at p, direction n (does not need to be normalized) More... | |
pointHit | intersection (const point &p, const vector &q, const point &ctr, const UList< point > &meshPoints, const intersection::algorithm alg, const scalar tol=0.0) const |
Fast intersection with a ray. More... | |
pointHit | nearestPoint (const point &p, const UList< point > &meshPoints) const |
Return nearest point to face. More... | |
pointHit | nearestPointClassify (const point &p, const UList< point > &meshPoints, label &nearType, label &nearLabel) const |
Return nearest point to face and classify it: More... | |
int | sign (const point &p, const UList< point > &points, const scalar tol=SMALL) const |
The sign for the side of the face plane the point is on, using three evenly distributed face points for the estimated normal. More... | |
scalar | contactSphereDiameter (const point &p, const vector &n, const UList< point > &meshPoints) const |
Return contact sphere diameter. More... | |
scalar | areaInContact (const UList< point > &meshPoints, const scalarField &v) const |
Return area in contact, given the displacement in vertices. More... | |
label | nEdges () const noexcept |
Return number of edges. More... | |
Foam::edge | edge (const label edgei) const |
Return i-th face edge (forward walk order). More... | |
vector | edge (const label edgei, const UList< point > &pts) const |
Return vector of i-th face edge (forward walk order). More... | |
Foam::edge | rcEdge (const label edgei) const |
Return i-th face edge in reverse walk order. More... | |
vector | rcEdge (const label edgei, const UList< point > &pts) const |
Return vector of i-th face edge in reverse walk order. More... | |
edgeList | edges () const |
Return list of edges in forward walk order. More... | |
edgeList | rcEdges () const |
Return list of edges in reverse walk order. More... | |
bool | contains (const Foam::edge &e) const |
True if face contains(edge) More... | |
label | find (const Foam::edge &e) const |
Find the edge within the face. More... | |
int | edgeDirection (const Foam::edge &e) const |
Test the edge direction on the face. More... | |
label | longestEdge (const UList< point > &pts) const |
Find the longest edge on a face. More... | |
label | nTriangles () const noexcept |
Number of triangles after splitting. More... | |
label | nTriangles (const UList< point > &unused) const |
Number of triangles after splitting. More... | |
label | triangles (const UList< point > &points, label &triI, faceList &triFaces) const |
Split into triangles using existing points. More... | |
template<int SizeMin> | |
label | triangles (const UList< point > &points, DynamicList< face, SizeMin > &triFaces) const |
Split into triangles using existing points. More... | |
label | nTrianglesQuads (const UList< point > &points, label &nTris, label &nQuads) const |
Number of triangles and quads after splitting. More... | |
label | trianglesQuads (const UList< point > &points, label &triI, label &quadI, faceList &triFaces, faceList &quadFaces) const |
Split into triangles and quads. More... | |
bool | connected (const labelUList &other) const |
True if the face has at least one vertex in common with other. More... | |
template<unsigned N> | |
bool | connected (const FixedList< label, N > &other) const |
True if the face has at least one vertex in common with other. More... | |
void | operator+= (const label vertexOffset) |
Increment (offset) vertices by given amount. More... | |
unsigned | hash_code (unsigned seed=0) const |
The hash value for face. More... | |
unsigned | symmhash_code (unsigned seed=0) const |
The symmetric hash value for face. More... | |
Foam::edge | faceEdge (label edgei) const |
Identical to edge() More... | |
template<int SizeMin> | |
Foam::label | triangles (const UList< point > &points, DynamicList< face, SizeMin > &triFaces) const |
Public Member Functions inherited from List< label > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const label &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const label &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, label &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< label > &list) | |
Copy construct from list. More... | |
List (const UList< label > &list) | |
Copy construct contents from list. More... | |
List (List< label > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< label > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< label > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< label, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< label > &list) | |
Construct as copy of PtrList<T> More... | |
List (const IndirectListBase< label, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< label > list) | |
Construct from an initializer list. More... | |
List (List< label > &&list) noexcept | |
Move construct from List. More... | |
List (DynamicList< label, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
List (const SLList< label > &list) | |
Copy construct from SLList. More... | |
autoPtr< List< label > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const label &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_fill (const label len, const label &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const label &val) |
Alias for resize() More... | |
void | transfer (List< label > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< label, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
label & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
label & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const label &val) |
Append an element at the end of the list. More... | |
void | push_back (label &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< label > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< label, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const label &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< label > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< label > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< label, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< label, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< label > list) |
Assignment to an initializer list. More... | |
void | operator= (const label &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< label > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< label, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (const SLList< label > &list) |
Copy assign from SLList in linear time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< label > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const label &val) |
Append an element at the end of the list. More... | |
void | append (label &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< label > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< label, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const label &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from UList< label > | |
label | size () const noexcept |
The number of elements in the container. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
void | operator= (const label &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
UList (const UList< label > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (label *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const label & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
label & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const label & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
label & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const label * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
label * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
label & | front () |
Access first element of the list, position [0]. More... | |
const label & | front () const |
Access first element of the list. More... | |
label & | back () |
Access last element of the list, position [size()-1]. More... | |
const label & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
bool | contains (const label &val) const |
True if the value is contained in the list. More... | |
bool | contains (const label &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const label &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const label &val, label pos, label len=-1) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const label &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (label *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< label > &list) noexcept |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< label > &list) |
Copy elements of the given UList. Sizes must match! More... | |
void | deepCopy (const IndirectListBase< label, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< label > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< label > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< label > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< label > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
label & | operator[] (const label i) |
Return element of UList. More... | |
const label & | operator[] (const label i) const |
Return element of constant UList. More... | |
const bool & | operator[] (const label i) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
operator const Foam::List< label > & () const | |
Allow cast to a const List<T>&. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_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 | rend () const |
Return const_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... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< label > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< label > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< label > &list) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< label > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< label > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< label > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< label > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
label & | first () |
Access first element of the list, position [0]. More... | |
const label & | first () const |
Access first element of the list. More... | |
label & | last () |
Access last element of the list, position [size()-1]. More... | |
const label & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const label &val, label pos=0) const |
Same as contains() More... | |
Additional Inherited Members | |
Public Types inherited from face | |
enum | proxType { NONE = 0, POINT, EDGE } |
The proximity classifications. More... | |
Public Types inherited from List< label > | |
typedef SubList< label > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< label > | |
typedef label | value_type |
The value type the list contains. More... | |
typedef label * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const label * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef label & | reference |
The type used for storing into value_type objects. More... | |
typedef const label & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef label * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const label * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Static Public Member Functions inherited from face | |
static int | compare (const face &a, const face &b) |
Compare faces. More... | |
static bool | sameVertices (const face &a, const face &b) |
True if the faces have all the same vertices. More... | |
static unsigned | symmhash_code (const UList< label > &f, unsigned seed=0) |
The symmetric hash value for face. More... | |
Static Public Member Functions inherited from List< label > | |
static const List< label > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< label > | |
static const UList< label > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Public Attributes inherited from face | |
static const char *const | typeName = "face" |
Protected Member Functions inherited from UList< label > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
void | writeEntry (Ostream &os) const |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
void | fill_uniform (const label &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< label > & | operator= (const UList< label > &)=delete |
No copy assignment (default: shallow copy) More... | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
void | operator= (const Foam::zero) |
Class containing opposite face for a prismatic cell with addressing and a possibility of failure.
Definition at line 42 of file oppositeFace.H.
|
inline |
Construct from components.
Definition at line 67 of file oppositeFace.H.
|
inlinenoexcept |
Master face index.
Definition at line 85 of file oppositeFace.H.
|
inlinenoexcept |
Opposite face index.
Definition at line 93 of file oppositeFace.H.
|
inlinenoexcept |
Does the opposite face exist?
Definition at line 101 of file oppositeFace.H.
Referenced by oppositeFace::found().
|
inlinenoexcept |
Does the opposite face exist?
Definition at line 109 of file oppositeFace.H.
References oppositeFace::good().