FreeFOAM The Cross-Platform CFD Toolkit
faceMesh Class Reference

Storage for surface mesh i.e. points and faces. More...


Detailed Description

Storage for surface mesh i.e. points and faces.

Source files

Definition at line 49 of file faceMesh.H.

+ Inheritance diagram for faceMesh:
+ Collaboration diagram for faceMesh:

List of all members.

Public Member Functions

 faceMesh (const faceList &faces, const pointField &points)
 Construct from components.
 faceMesh (Istream &is)
 Construct from Istream.
void flip ()
- Public Member Functions inherited from PrimitivePatch< face, List, pointField >
 PrimitivePatch (const List< face > &faces, const Field< point > &points)
 Construct from components.
 PrimitivePatch (List< face > &faces, Field< point > &points, const bool reUse)
 Construct from components, reuse storage.
 PrimitivePatch (const PrimitivePatch< face, List, pointField, point > &)
 Construct as copy.
virtual ~PrimitivePatch ()
void clearOut ()
void clearGeom ()
void clearTopology ()
void clearPatchMeshAddr ()
const Field< point > & points () const
 Return reference to global points.
label nPoints () const
 Return number of points supporting patch faces.
label nEdges () const
 Return number of edges in patch.
const edgeListedges () const
 Return list of edges, address into LOCAL point list.
label nInternalEdges () const
 Number of internal edges.
bool isInternalEdge (const label edgeI) const
 Is internal edge?
const labelListboundaryPoints () const
 Return list of boundary points,.
const labelListListfaceFaces () const
 Return face-face addressing.
const labelListListedgeFaces () const
 Return edge-face addressing.
const labelListListfaceEdges () const
 Return face-edge addressing.
const labelListListpointEdges () const
 Return point-edge addressing.
const labelListListpointFaces () const
 Return point-face addressing.
const List< face > & localFaces () const
 Return patch faces addressing into local point list.
const labelListmeshPoints () const
 Return labelList of mesh points in patch. They are constructed.
const Map< label > & meshPointMap () const
 Mesh point map. Given the global point index find its.
const Field< point > & localPoints () const
 Return pointField of points in patch.
const labelListlocalPointOrder () const
 Return orders the local points for most efficient search.
label whichPoint (const label gp) const
 Given a global point index, return the local point index.
label whichEdge (const edge &) const
 Given an edge in local point labels, return its.
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 Return labels of patch edges in the global edge list using.
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of patch edges in the global edge list using.
const Field< point > & faceCentres () const
 Return face centres for patch.
const Field< point > & faceNormals () const
 Return face normals for patch.
const Field< point > & pointNormals () const
 Return point normals for patch.
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch.
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch.
const labelListListedgeLoops () const
 Return list of closed loops of boundary vertices.
surfaceTopo surfaceType () const
 Calculate surface type formed by patch.
bool checkTopology (const bool report=false, labelHashSet *setPtr=NULL) const
 Check surface formed by patch for manifoldness (see above).
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=NULL) const
 Checks primitivePatch for faces sharing point but not edge.
virtual void movePoints (const Field< point > &)
 Correct patch after moving points.
void operator= (const PrimitivePatch< face, List, pointField, point > &)
 Assignment.
- Public Member Functions inherited from List< face >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const face &)
 Construct with given size and value for all elements.
 List (const List< face > &)
 Copy constructor.
 List (const Xfer< List< face > > &)
 Construct by transferring the parameter contents.
 List (List< face > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< face > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< face, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< face > &)
 Construct as copy of PtrList<T>
 List (const SLList< face > &)
 Construct as copy of SLList<T>
 List (const IndirectList< face > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< face > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< face > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< face > > clone () const
 Clone.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const face &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const face &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< face > &)
 Append a List at the end of this list.
void append (const UIndirectList< face > &)
 Append a UIndirectList at the end of this list.
void transfer (List< face > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< face, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< face > &)
 Transfer the contents of the argument List into this list.
Xfer< List< face > > xfer ()
 Transfer contents to the Xfer container.
facenewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< face > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< face > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< face > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< face > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< face > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< face > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const face &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< face >
 UList ()
 Null constructor.
 UList (face *__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 facecdata () const
 Return a const pointer to the first data element,.
facedata ()
 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< face > &)
 Assign elements to those from UList.
faceoperator[] (const label)
 Return element of UList.
const faceoperator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< face > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant 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.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_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.
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< face > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< face > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< face > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< face > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< face > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< face > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< face > &) const
 Return true if !(a < b). Takes linear time.

Friends

Ostreamoperator<< (Ostream &os, const faceMesh &fm)

Additional Inherited Members

- Public Types inherited from PrimitivePatch< face, List, pointField >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
typedef face FaceType
typedef List< faceFaceListType
typedef pointField PointFieldType
- Public Types inherited from List< face >
typedef SubList< facesubList
 Declare type of subList.
- Public Types inherited from UList< face >
typedef face value_type
 Type of values the UList contains.
typedef facereference
 Type that can be used for storing into.
typedef const faceconst_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef faceiterator
 Random access iterator for traversing UList.
typedef const faceconst_iterator
 Random access iterator for traversing UList.
typedef facereverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const faceconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.

Constructor & Destructor Documentation

faceMesh ( const faceList faces,
const pointField points 
)
inline

Construct from components.

Definition at line 68 of file faceMesh.H.

faceMesh ( Istream is)
inline

Construct from Istream.

Definition at line 74 of file faceMesh.H.


Member Function Documentation


Friends And Related Function Documentation

Ostream& operator<< ( Ostream os,
const faceMesh fm 
)
friend

Definition at line 94 of file faceMesh.H.


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