|
| | pTraits (Istream &is) |
| constexpr | face () noexcept=default |
| | Default construct.
|
| | face (const label sz) |
| | Construct given size, with invalid vertex labels (-1).
|
| | face (const labelUList &list) |
| | Copy construct from list of vertex labels.
|
| | face (labelList &&list) |
| | Move construct from list of vertex labels.
|
| | face (std::initializer_list< label > list) |
| | Copy construct from an initializer list of vertex labels.
|
| template<unsigned N> |
| | face (const FixedList< label, N > &list) |
| | Copy construct from list of vertex labels.
|
| | face (const labelUList &list, const labelUList &indices) |
| | Copy construct from subset of vertex labels.
|
| template<unsigned N> |
| | face (const labelUList &list, const FixedList< label, N > &indices) |
| | Copy construct from subset of vertex labels.
|
| | face (const triFace &f) |
| | Copy construct from triFace.
|
| | face (Istream &is) |
| | Construct from Istream.
|
| label | collapse () |
| | Collapse face by removing duplicate vertex labels.
|
| void | flip () |
| | Flip the face in-place.
|
| pointField | points (const UList< point > &pts) const |
| | Return the points corresponding to this face.
|
| point | centre (const UList< point > &points) const |
| | Centre point of face.
|
| point | average (const UList< point > &points) const |
| | Average of face points: a quick estimate of the face centre.
|
| template<class Type> |
| Type | average (const UList< point > &meshPoints, const Field< Type > &fld) const |
| | Calculate average value at centroid of face.
|
| vector | areaNormal (const UList< point > &p) const |
| | The area normal - with magnitude equal to area of face.
|
| vector | unitNormal (const UList< point > &p) const |
| | The unit normal.
|
| | FOAM_DEPRECATED_FOR (2018-12, "areaNormal() or unitNormal()") vector normal(const UList< point > &p) const |
| | Legacy name for areaNormal().
|
| scalar | mag (const UList< point > &p) const |
| | Magnitude of face area.
|
| scalar | magSqr (const UList< point > &p) const |
| | Magnitude squared of face area.
|
| Pair< point > | box (const UList< point > &pts) const |
| | The enclosing (bounding) box for the face.
|
| face | reverseFace () const |
| | Return face with reverse direction.
|
| label | which (const label vertex) const |
| | Find local vertex on face for the vertex label, same as find().
|
| label | thisLabel (const label i) const |
| | The vertex on face - identical to operator[], but with naming similar to nextLabel(), prevLabel().
|
| label | nextLabel (const label i) const |
| | Next vertex on face.
|
| label | prevLabel (const label i) const |
| | Previous vertex on face.
|
| scalar | sweptVol (const UList< point > &oldPoints, const UList< point > &newPoints) const |
| | Return the volume swept out by the face when its points move.
|
| 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.
|
| 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).
|
| 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.
|
| pointHit | nearestPoint (const point &p, const UList< point > &meshPoints) const |
| | Return nearest point to face.
|
| pointHit | nearestPointClassify (const point &p, const UList< point > &meshPoints, label &nearType, label &nearLabel) const |
| | Return nearest point to face and classify it:
|
| 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.
|
| scalar | contactSphereDiameter (const point &p, const vector &n, const UList< point > &meshPoints) const |
| | Return contact sphere diameter.
|
| scalar | areaInContact (const UList< point > &meshPoints, const scalarField &v) const |
| | Return area in contact, given the displacement in vertices.
|
| label | nEdges () const noexcept |
| | Return number of edges.
|
| Foam::edge | edge (const label edgei) const |
| | Return i-th face edge (forward walk order).
|
| vector | edge (const label edgei, const UList< point > &pts) const |
| | Return vector of i-th face edge (forward walk order).
|
| Foam::edge | rcEdge (const label edgei) const |
| | Return i-th face edge in reverse walk order.
|
| vector | rcEdge (const label edgei, const UList< point > &pts) const |
| | Return vector of i-th face edge in reverse walk order.
|
| edgeList | edges () const |
| | Return list of edges in forward walk order.
|
| edgeList | rcEdges () const |
| | Return list of edges in reverse walk order.
|
| bool | contains (const Foam::edge &e) const |
| | True if face contains(edge).
|
| label | find (const Foam::edge &e) const |
| | Find the edge within the face.
|
| int | edgeDirection (const Foam::edge &e) const |
| | Test the edge direction on the face.
|
| label | longestEdge (const UList< point > &pts) const |
| | Find the longest edge on a face.
|
| label | nTriangles () const noexcept |
| | Number of triangles after splitting.
|
| label | nTriangles (const UList< point > &unused) const |
| | Number of triangles after splitting.
|
| label | triangles (const UList< point > &points, label &triI, faceList &triFaces) const |
| | Split into triangles using existing points.
|
| template<int SizeMin> |
| label | triangles (const UList< point > &points, DynamicList< face, SizeMin > &triFaces) const |
| | Split into triangles using existing points.
|
| label | nTrianglesQuads (const UList< point > &points, label &nTris, label &nQuads) const |
| | Number of triangles and quads after splitting.
|
| label | trianglesQuads (const UList< point > &points, label &triI, label &quadI, faceList &triFaces, faceList &quadFaces) const |
| | Split into triangles and quads.
|
| bool | connected (const labelUList &other) const |
| | True if the face has at least one vertex in common with other.
|
| template<unsigned N> |
| bool | connected (const FixedList< label, N > &other) const |
| | True if the face has at least one vertex in common with other.
|
| void | operator+= (const label vertexOffset) |
| | Increment (offset) vertices by given amount.
|
| unsigned | hash_code (unsigned seed=0) const |
| | The hash value for face.
|
| unsigned | symmhash_code (unsigned seed=0) const |
| | The symmetric hash value for face.
|
| Foam::edge | faceEdge (label edgei) const |
| | Identical to edge().
|
| template<int SizeMin> |
| Foam::label | triangles (const UList< point > &points, DynamicList< face, SizeMin > &triFaces) const |
| constexpr | List () noexcept |
| | Default construct.
|
| | List (const label len) |
| | Construct with given size.
|
| | List (const label len, const label &val) |
| | Construct with given size and value for all elements.
|
| | List (const label len, Foam::zero) |
| | Construct with given size initializing all elements to zero.
|
| | List (Foam::one, const label &val) |
| | Construct with length=1, copying the value as the only content.
|
| | List (Foam::one, label &&val) |
| | Construct with length=1, moving the value as the only content.
|
| | List (Foam::one, Foam::zero) |
| | Construct with length=1, initializing content to zero.
|
| | List (const List< label > &list) |
| | Copy construct from list.
|
| | List (const UList< label > &list) |
| | Copy construct contents from list.
|
| | List (List< label > &list, bool reuse) |
| | Construct as copy or re-use as specified.
|
| | List (const UList< label > &list, const labelUList &indices) |
| | Copy construct subset of list.
|
| | List (const UList< label > &list, const FixedList< label, N > &indices) |
| | Copy construct subset of list.
|
| | List (const FixedList< label, N > &list) |
| | Construct as copy of FixedList<T, N>.
|
| | List (const UPtrList< label > &list) |
| | Construct as copy of UPtrList<T> content.
|
| | List (const IndirectListBase< label, Addr > &list) |
| | Construct as copy of IndirectList contents.
|
| | List (std::initializer_list< label > list) |
| | Construct from an initializer list.
|
| | List (List< label > &&list) noexcept |
| | Move construct from List.
|
| | List (DynamicList< label, SizeMin > &&list) |
| | Move construct from DynamicList.
|
| | List (Istream &is) |
| | Construct from Istream.
|
| autoPtr< List< label > > | clone () const |
| | Clone.
|
| | ~List () |
| | Destructor.
|
| void | clear () |
| | Clear the list, i.e. set size to zero.
|
| void | resize (const label len) |
| | Adjust allocated size of list.
|
| void | resize (const label len, const label &val) |
| | Adjust allocated size of list and set val for new elements.
|
| void | resize_copy (label count, const label len) |
| | Change allocated size of list, retaining the first count elements.
|
| void | resize_fill (const label len, const label &val) |
| | Adjust allocated size of list and set val for all elements.
|
| void | resize_nocopy (const label len) |
| | Adjust allocated size of list without necessarily.
|
| void | transfer (List< label > &list) |
| | Transfer the contents of the argument List into this list and annul the argument list.
|
| void | transfer (DynamicList< label, SizeMin > &list) |
| | Transfer the contents of the argument List into this list and annul the argument list.
|
| label & | newElmt (const label i) |
| | Return subscript-checked element of UList and resizing the list if required.
|
| label & | emplace_back (Args &&... args) |
| | Construct an element at the end of the list, return reference to the new list element.
|
| void | push_back (const label &val) |
| | Append an element at the end of the list.
|
| void | push_back (label &&val) |
| | Move append an element at the end of the list.
|
| void | push_back (const UList< label > &list) |
| | Append a List to the end of this list.
|
| void | push_back (const IndirectListBase< label, Addr > &list) |
| | Append IndirectList contents at the end of this list.
|
| label | push_uniq (const label &val) |
| | Append an element if not already in the list.
|
| void | pop_back (label n=1) |
| | Reduce size by 1 or more elements. Can be called on an empty list.
|
| void | operator= (const UList< label > &list) |
| | Assignment to UList operator. Takes linear time.
|
| void | operator= (const List< label > &list) |
| | Assignment operator. Takes linear time.
|
| void | operator= (const IndirectListBase< label, Addr > &list) |
| | Assignment from IndirectList. Takes linear time.
|
| void | operator= (const FixedList< label, N > &list) |
| | Copy assignment from FixedList.
|
| void | operator= (std::initializer_list< label > list) |
| | Assignment to an initializer list.
|
| void | operator= (const label &val) |
| | Assignment of all entries to the given value.
|
| void | operator= (Foam::zero) |
| | Assignment of all entries to zero.
|
| void | operator= (List< label > &&list) |
| | Move assignment. Takes constant time.
|
| void | operator= (DynamicList< label, SizeMin > &&list) |
| | Move assignment. Takes constant time.
|
| Istream & | readList (Istream &is) |
| | Read List from Istream, discarding contents of existing List.
|
| void | shallowCopy (const UList< label > &)=delete |
| | No shallowCopy permitted.
|
| bool | set (const label i, bool val=true) |
| | A bitSet::set() method for a list of bool.
|
| void | append (const label &val) |
| | Append an element at the end of the list.
|
| void | append (label &&val) |
| | Move append an element at the end of the list.
|
| void | append (const UList< label > &list) |
| | Append a List to the end of this list.
|
| void | append (const IndirectListBase< label, Addr > &list) |
| | Append IndirectList contents at the end of this list.
|
| label | appendUniq (const label &val) |
| | Same as push_uniq().
|
| void | setSize (label n) |
| | Alias for resize().
|
| void | setSize (label n, const label &val) |
| | Alias for resize().
|
| | List (const Expression::ListExpression< E > &expr) |
| | Construct from value expression.
|
| void | operator= (const Expression::ListExpression< E > &expr) |
| | Assign values from expression.
|
| void | resize (const label len) |
| | UList (const UList< label > &) noexcept=default |
| | Copy construct, shallow copy.
|
| | UList (UList< label > &&) noexcept=default |
| | Move construct, shallow copy.
|
| UList< label > & | operator= (const UList< label > &)=delete |
| | No copy assignment (default: shallow copy).
|
| UList< label > & | operator= (UList< label > &&) noexcept=default |
| | Move assignment, shallow copy.
|
| constexpr | UList () noexcept |
| | Default construct, zero-sized and nullptr.
|
| | UList (label *__restrict__ ptr, const label len) noexcept |
| | Construct from components.
|
| | UList (SubList< label > &&) noexcept |
| | Move construct from a SubList, shallow copy.
|
| 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.
|
| 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.
|
| const label & | fcValue (const label i) const |
| | Return forward circular value (ie, next value in the list).
|
| label & | fcValue (const label i) |
| | Return forward circular value (ie, next value in the list).
|
| const label & | rcValue (const label i) const |
| | Return reverse circular value (ie, previous value in the list).
|
| label & | rcValue (const label i) |
| | Return reverse circular value (ie, previous value in the list).
|
| const label * | cdata () const noexcept |
| | Return pointer to the underlying array serving as data storage.
|
| label * | data () noexcept |
| | Return pointer to the underlying array serving as data storage.
|
| const char * | cdata_bytes () const noexcept |
| | Return pointer to the underlying array serving as data storage,.
|
| char * | data_bytes () noexcept |
| | Return pointer to the underlying array serving as data storage,.
|
| label & | front () |
| | Access first element of the list, position [0].
|
| const label & | front () const |
| | Access first element of the list.
|
| label & | back () |
| | Access last element of the list, position [size()-1].
|
| const label & | back () const |
| | Access last element of the list, position [size()-1].
|
| std::streamsize | size_bytes () const noexcept |
| | Number of contiguous bytes for the List data.
|
| std::streamsize | byteSize () const |
| | Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
|
| void | checkStart (const label start) const |
| | Check start is within valid range [0,size).
|
| void | checkSize (const label size) const |
| | Check size is within valid range [0,size].
|
| void | checkRange (const label start, const label len) const |
| | Check that start and length define a valid range.
|
| void | checkIndex (const label i) const |
| | Check index is within valid range [0,size).
|
| bool | uniform () const |
| | True if all entries have identical values, and list is non-empty.
|
| bool | contains (const label &val) const |
| | True if the value is contained in the list.
|
| bool | contains (const label &val, label pos, label len=-1) const |
| | Is the value contained in the list?
|
| label | find (const label &val) const |
| | Find index of the first occurrence of the value.
|
| label | find (const label &val, label pos, label len=-1) const |
| | Find index of the first occurrence of the value.
|
| label | rfind (const label &val, label pos=-1) const |
| | Find index of the last occurrence of the value.
|
| void | moveFirst (const label i) |
| | Move element to the first position.
|
| void | moveLast (const label i) |
| | Move element to the last position.
|
| void | swapFirst (const label i) |
| | Swap element with the first element. Fatal on an empty list.
|
| void | swapLast (const label i) |
| | Swap element with the last element. Fatal on an empty list.
|
| void | shallowCopy (label *__restrict__ ptr, const label len) noexcept |
| | Copy the pointer and size.
|
| void | shallowCopy (std::nullptr_t) noexcept |
| | Copy nullptr and zero size.
|
| void | shallowCopy (const UList< label > &list) noexcept |
| | Copy the pointer and size held by the given UList.
|
| void | deepCopy (const UList< label > &list) |
| | Copy elements of the given UList. Sizes must match!
|
| void | deepCopy (const IndirectListBase< label, Addr > &list) |
| | Copy elements of the given indirect list. Sizes must match!
|
| SubList< label > | slice (const label pos, label len=-1) |
| | Return SubList slice (non-const access) - no range checking.
|
| const SubList< label > | slice (const label pos, label len=-1) const |
| | Return SubList slice (const access) - no range checking.
|
| SubList< label > | slice (const labelRange &range) |
| | Return SubList slice (non-const access) - with range checking.
|
| const SubList< label > | slice (const labelRange &range) const |
| | Return SubList slice (const access) - with range checking.
|
| label & | operator[] (const label i) |
| | Return element of UList.
|
| const label & | operator[] (const label i) const |
| | Return element of constant UList.
|
| | operator const Foam::List< label > & () const |
| | Allow cast to a const List<T>&.
|
| void | operator= (const label &val) |
| | Assignment of all entries to the given value.
|
| void | operator= (Foam::zero) |
| | Assignment of all entries to zero.
|
| iterator | begin () noexcept |
| | Return an iterator to begin traversing the UList.
|
| iterator | end () noexcept |
| | Return an iterator to end traversing the UList.
|
| iterator | begin (const label i) noexcept |
| | Return iterator at offset i from begin, clamped to [0,size] range.
|
| const_iterator | cbegin () const noexcept |
| | Return const_iterator to begin traversing the constant UList.
|
| const_iterator | cend () const noexcept |
| | Return const_iterator to end traversing the constant UList.
|
| const_iterator | begin () const noexcept |
| | Return const_iterator to begin traversing the constant UList.
|
| const_iterator | end () const noexcept |
| | Return const_iterator to end traversing the constant UList.
|
| const_iterator | cbegin (const label i) const noexcept |
| | Return const_iterator at offset i from begin, clamped to [0,size] range.
|
| const_iterator | begin (const label i) const noexcept |
| | Return const_iterator at offset i from begin, clamped to [0,size] range.
|
| 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.
|
| bool | empty () const noexcept |
| | True if List is empty (ie, size() is zero).
|
| label | size () const noexcept |
| | The number of elements in the container.
|
| label | capacity () const noexcept |
| | Size of the underlying storage.
|
| void | swap (UList< label > &list) noexcept |
| | Swap content with another UList of the same type in constant time.
|
| bool | operator== (const UList< label > &list) const |
| | Equality operation on ULists of the same type.
|
| bool | operator!= (const UList< label > &list) const |
| | The opposite of the equality operation. Takes linear time.
|
| bool | operator< (const UList< label > &list) const |
| | Compare two ULists lexicographically. Takes linear time.
|
| bool | operator> (const UList< label > &list) const |
| | Compare two ULists lexicographically. Takes linear time.
|
| bool | operator<= (const UList< label > &list) const |
| | Return true if !(a > b). Takes linear time.
|
| bool | operator>= (const UList< label > &list) const |
| | Return true if !(a < b). Takes linear time.
|
| Istream & | readList (Istream &is) |
| | Read List contents from Istream.
|
| void | writeEntry (const word &keyword, Ostream &os) const |
| | Write the List as a dictionary entry with keyword.
|
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| | Write List, with line-breaks in ASCII when length exceeds shortLen.
|
| bool | all () const |
| | True if all entries are 'true' or if the list is empty.
|
| bool | any () const |
| | True if any entries are 'true'.
|
| bool | none () const |
| | True if no entries are 'true'.
|
| bool | test (const label i) const |
| | Test bool value at specified position, always false for out-of-range access.
|
| bool | get (const label i) const |
| | Return bool value at specified position, always false for out-of-range access.
|
| bool | unset (const label i) |
| | Unset the bool entry at specified position, always false for out-of-range access.
|
| std::string_view | view () const |
| | Return a string_view of the charList. Content is non-modifiable.
|
| label & | first () |
| | Access first element of the list, position [0].
|
| const label & | first () const |
| | Access first element of the list.
|
| label & | last () |
| | Access last element of the list, position [size()-1].
|
| const label & | last () const |
| | Access last element of the list, position [size()-1].
|
| bool | found (const label &val, label pos=0) const |
| | Same as contains().
|
| auto | expr () const |
| | Wrap value as expression.
|
| void | operator= (const Expression::ListExpression< E > &expr) |
| | Assign values from expression.
|
| | operator const Foam::List< label > & () const |
| | Allow cast to a const List<T>&.
|