A face is a list of labels corresponding to mesh vertices. More...
Public Types | |
| enum | proxType { NONE , POINT , EDGE } |
| Return types for classify. 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 |
| Type of values the UList contains. More... | |
| typedef label & | reference |
| Type that can be used for storing into. More... | |
| typedef const label & | 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 label * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const label * | 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... | |
Public Member Functions | |
| 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::vector | area (const PointField &ps) |
| template<class PointField > | |
| Foam::point | centre (const PointField &ps) |
| template<class PointField > | |
| Foam::Tuple2< Foam::vector, Foam::point > | areaAndCentre (const PointField &ps) |
| template<class PointField > | |
| Foam::Tuple2< Foam::vector, Foam::point > | areaAndCentreStabilised (const PointField &ps) |
| Public Member Functions inherited from List< label > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const label &) | |
| 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< label > &) | |
| Copy constructor. More... | |
| List (const UList< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (List< label > &&) | |
| Move constructor. More... | |
| List (List< label > &, bool reuse) | |
| Construct as copy or reuse as specified. More... | |
| List (const UList< label > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| List (const FixedList< label, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< label > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< label > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< label > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< label > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< label >) | |
| Construct from an initialiser list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| autoPtr< List< label > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const label &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const label &) |
| 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 label &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< label > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< label > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< label > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (DynamicList< label, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< label > &) |
| Transfer the contents of the argument List into this list. More... | |
| label & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< label > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< label > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< label > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (List< label > &&) |
| Move assignment operator. More... | |
| void | operator= (const SLList< label > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< label > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< label > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< label >) |
| Assignment to an initialiser list. More... | |
| void | operator= (const label &) |
| 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< label > | |
| void | operator= (const label &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| UList () | |
| Null constructor. More... | |
| UList (label *__restrict__ v, label size) | |
| Construct from components. More... | |
| UList (const UList< label > &)=default | |
| Copy construct. 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 label * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| label * | data () |
| Return a pointer to the first data element,. More... | |
| label & | first () |
| Return the first element of the list. More... | |
| const label & | first () const |
| Return first element of the list. More... | |
| label & | last () |
| Return the last element of the list. More... | |
| const label & | 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< label > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< label > &) |
| Copy elements of the given UList. More... | |
| label & | operator[] (const label) |
| Return element of UList. More... | |
| const label & | operator[] (const label) const |
| Return element of constant UList. More... | |
| const bool & | operator[] (const label i) const |
| operator const Foam::List< label > & () const | |
| Allow cast to a const List<T>&. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant 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... | |
| 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... | |
| 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< label > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< label > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< label > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< label > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< label > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< label > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< label > &) const |
| Return true if !(a < b). Takes linear time. More... | |
Static Public Member Functions | |
| template<class PointField > | |
| static vector | area (const PointField &ps) |
| Return vector area given face points. More... | |
| template<class PointField > | |
| static vector | centre (const PointField &ps) |
| Return centre point given face points. More... | |
| template<class PointField > | |
| static Tuple2< vector, point > | areaAndCentre (const PointField &) |
| Return vector area and centre point given face points. More... | |
| template<class PointField > | |
| static Tuple2< vector, point > | areaAndCentreStabilised (const PointField &) |
| Return vector area and centre point given face points. Stabilised. 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< label > | |
| static const List< label > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< label > | |
| static const UList< label > & | null () |
| Return a null UList. More... | |
Static Public Attributes | |
| static const char *const | typeName = "face" |
Friends | |
| bool | operator== (const face &a, const face &b) |
| bool | operator!= (const face &a, const face &b) |
| Istream & | operator>> (Istream &, face &) |
Additional Inherited Members | |
| Protected Member Functions inherited from List< label > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
| enum proxType |
|
inline |
Construct null.
Definition at line 28 of file faceI.H.
Referenced by face::areaInContact().
|
inlineexplicit |
|
static |
Return vector area given face points.
Referenced by face::contactSphereDiameter(), MPLICface::Sf(), intersection::srcBoxStatic(), and polygonTriangulate::triangulate().
|
static |
Return centre point given face points.
Referenced by face::contactSphereDiameter().
|
static |
Return vector area and centre point given face points.
Referenced by primitiveMesh::makeFaceCentresAndAreas().
|
static |
Return vector area and centre point given face points. Stabilised.
version. More expensive, but less likely to generate wildly inaccurate face-centres on degenerate faces.
Referenced by intersection::part::part().
| Foam::label collapse | ( | ) |
| void flip | ( | ) |
Flip the face in-place.
The starting points of the original and flipped face are identical.
Definition at line 224 of file face.C.
References n, and Foam::Swap().
|
inline |
Return the points corresponding to this face.
Definition at line 64 of file faceI.H.
Referenced by face::ray().
| Foam::point centre | ( | const pointField & | ps | ) | const |
| Type average | ( | const pointField & | ps, |
| const Field< Type > & | fld | ||
| ) | const |
Calculate average value at centroid of face.
Definition at line 222 of file faceTemplates.C.
References f(), fld(), forAll, Foam::normalised(), p, Foam::constant::mathematical::pi(), and Foam::Zero.
| Foam::vector area | ( | const pointField & | ps | ) | const |
|
inline |
Return scalar magnitude.
Definition at line 81 of file faceI.H.
References Foam::mag(), and points.
Referenced by face::areaInContact(), and hexCellLooper::cut().
| Foam::vector normal | ( | const pointField & | points | ) | const |
Return unit normal.
Definition at line 250 of file face.C.
References Foam::normalised(), and points.
| Foam::face reverseFace | ( | ) | const |
Return face with reverse direction.
The starting points of the original and reverse face are identical.
Definition at line 256 of file face.C.
References f(), and List< T >::size().
Referenced by perfectInterface::setRefinement(), createShellMesh::setRefinement(), and cellsToCells::trimLocalTgt().
| Foam::label which | ( | const label | globalIndex | ) | const |
|
inline |
Next vertex on face.
Definition at line 100 of file faceI.H.
Referenced by combineFaces::getOutsideFace().
|
inline |
| Foam::scalar sweptVol | ( | const pointField & | oldPoints, |
| const pointField & | newPoints | ||
| ) | const |
Return the volume swept out by the face when its points move.
Definition at line 291 of file face.C.
References nPoints, and Foam::constant::mathematical::pi().
| Foam::tensor inertia | ( | const pointField & | p, |
| const point & | refPt = vector::zero, |
||
| scalar | density = 1.0 |
||
| ) | const |
Return the inertia tensor, with optional reference.
point and density specification
Definition at line 370 of file face.C.
References forAll, p, and Foam::Zero.
| Foam::pointHit ray | ( | const point & | p, |
| const vector & | n, | ||
| const pointField & | meshPoints, | ||
| const intersection::algorithm | alg = intersection::algorithm::fullRay, |
||
| const intersection::direction | dir = intersection::direction::vector |
||
| ) | const |
Return potential intersection with face with a ray starting.
at p, direction n (does not need to be normalised) Does face-centre decomposition and returns triangle intersection point closest to p. Face-centre is calculated from point average. For a hit, the distance is signed. Positive number represents the point in front of triangle In case of miss the point is the nearest point on the face and the distance is the distance between the intersection point and the original point. The half-ray or full-ray intersection and the contact sphere adjustment of the projection vector is set by the intersection parameters
Definition at line 33 of file faceIntersection.C.
References Foam::average(), PointHit< Point >::distance(), PointHit< Point >::eligibleMiss(), f(), UList< label >::fcIndex(), PointHit< Point >::hit(), PointHit< Point >::hitPoint(), Foam::mag(), PointHit< Point >::missPoint(), n, nPoints, p, face::points(), PointHit< Point >::setDistance(), PointHit< Point >::setHit(), PointHit< Point >::setMiss(), PointHit< Point >::setPoint(), and List< label >::size().
| Foam::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.
Does face-centre decomposition and returns triangle intersection point closest to p. See triangle::intersection for details.
Definition at line 140 of file faceIntersection.C.
References PointHit< Point >::distance(), f(), forAll, PointHit< Point >::hit(), PointHit< Point >::hitPoint(), Foam::mag(), p, PointHit< Point >::setDistance(), PointHit< Point >::setHit(), and PointHit< Point >::setPoint().
Referenced by face::areaInContact().
| Foam::pointHit nearestPoint | ( | const point & | p, |
| const pointField & | meshPoints | ||
| ) | const |
Return nearest point to face.
Definition at line 198 of file faceIntersection.C.
References p.
Referenced by wallFace::update().
| Foam::pointHit nearestPointClassify | ( | const point & | p, |
| const pointField & | meshPoints, | ||
| label & | nearType, | ||
| label & | nearLabel | ||
| ) | const |
Return nearest point to face and classify it:
+ near point (nearType=POINT, nearLabel=0, 1, 2) + near edge (nearType=EDGE, nearLabel=0, 1, 2) Note: edges are counted from starting vertex so e.g. edge n is from f[n] to f[0], where the face has n + 1 points
Definition at line 212 of file faceIntersection.C.
References PointHit< Point >::distance(), triangle< Point, PointRef >::EDGE, f(), PointHit< Point >::hit(), PointHit< Point >::hitPoint(), Foam::mag(), PointHit< Point >::missPoint(), triangle< Point, PointRef >::nearestPointClassify(), nPoints, p, triangle< Point, PointRef >::POINT, PointHit< Point >::setDistance(), PointHit< Point >::setHit(), PointHit< Point >::setMiss(), PointHit< Point >::setPoint(), and List< T >::size().
| Foam::scalar contactSphereDiameter | ( | const point & | p, |
| const vector & | n, | ||
| const pointField & | meshPoints | ||
| ) | const |
Return contact sphere diameter.
Definition at line 33 of file faceContactSphere.C.
References face::area(), face::centre(), Foam::mag(), n, and p.
| Foam::scalar areaInContact | ( | const pointField & | meshPoints, |
| const scalarField & | v | ||
| ) | const |
Return area in contact, given the displacement in vertices.
Definition at line 32 of file faceAreaInContact.C.
References face::face(), forAll, face::intersection(), face::mag(), List< T >::setSize(), List< label >::size(), and List< T >::size().
|
inline |
| Foam::edgeList edges | ( | ) | const |
Return edges in face point ordering,.
i.e. edges()[0] is edge between [0] and [1]
Definition at line 406 of file face.C.
References Foam::e, UList< T >::last(), points, and List< T >::size().
Referenced by Foam::polyMeshZipUpCells().
|
inline |
| int edgeDirection | ( | const edge & | e | ) | const |
|
inline |
Compare faces.
0: different +1: identical -1: same face, but different orientation
Definition at line 48 of file face.C.
References CirculatorBase::anticlockwise, b, ConstCirculator< ContainerType >::circulate(), CirculatorBase::clockwise, ConstCirculator< ContainerType >::setFulcrumToIterator(), ConstCirculator< ContainerType >::setIteratorToFulcrum(), and List< T >::size().
Referenced by Foam::operator!=(), Foam::operator==(), and Foam::primitivePatchGetZones().
Return true if the faces have the same vertices.
Definition at line 150 of file face.C.
References b, forAll, and List< T >::size().
Referenced by blockFace::compare().
Move assignment labelList.
Definition at line 120 of file faceI.H.
References List< label >::operator=().
| Foam::vector area | ( | const PointField & | ps | ) |
Definition at line 32 of file faceTemplates.C.
References UList< T >::fcIndex(), forAll, p, Foam::constant::mathematical::pi(), List< T >::size(), and Foam::Zero.
| Foam::point centre | ( | const PointField & | ps | ) |
Definition at line 69 of file faceTemplates.C.
| Foam::Tuple2<Foam::vector, Foam::point> areaAndCentre | ( | const PointField & | ps | ) |
Definition at line 79 of file faceTemplates.C.
References Foam::constant::universal::c, UList< T >::fcIndex(), forAll, Foam::normalised(), p, Foam::constant::mathematical::pi(), List< T >::size(), and Foam::Zero.
| Foam::Tuple2<Foam::vector, Foam::point> areaAndCentreStabilised | ( | const PointField & | ps | ) |
Definition at line 153 of file faceTemplates.C.
References Foam::constant::universal::c, scalarAndError::error, f(), UList< T >::fcIndex(), forAll, Foam::max(), Foam::min(), Foam::normalised(), p, Foam::constant::mathematical::pi(), Tuple2< Type1, Type2 >::second(), List< T >::size(), scalarAndError::value, vectorAndError::value(), and Foam::Zero.
1.9.1 
