Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
surfMesh Class Reference

A surface mesh consisting of general polygon faces. More...

Inheritance diagram for surfMesh:
Inheritance graph
[legend]
Collaboration diagram for surfMesh:
Collaboration graph
[legend]

Public Types

enum  readUpdateState { UNCHANGED, POINTS_MOVED, TOPO_CHANGE, TOPO_PATCH_CHANGE }
 Enumeration defining the state of the mesh after a read update. More...
 
typedef surfMesh Mesh
 
typedef bool BoundaryMesh
 Placeholder only, but do not remove - it is needed for GeoMesh. More...
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Public Types inherited from HashTable< regIOobject * >
typedef regIOobjectvalue_type
 Type of values the HashTable contains. More...
 
typedef regIOobject * & reference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const regIOobject * & const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
- Public Types inherited from PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
 
typedef face FaceType
 
typedef ::Foam::UList< faceFaceListType
 
typedef ::Foam::SubField< pointPointFieldType
 
- Public Types inherited from UList< face >
typedef face value_type
 Type of values the UList contains. More...
 
typedef facereference
 Type that can be used for storing into. More...
 
typedef const faceconst_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 faceiterator
 Random access iterator for traversing UList. More...
 
typedef const faceconst_iterator
 Random access iterator for traversing UList. More...
 
typedef facereverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const faceconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 TypeName ("surfMesh")
 Runtime type information. More...
 
 surfMesh (const IOobject &, const word &surfName="")
 Construct from IOobject, with alternative surface name. More...
 
 surfMesh (const IOobject &, const Xfer< pointField > &, const Xfer< faceList > &, const word &surfName="")
 Construct by transferring components (points, faces) without zones. More...
 
 surfMesh (const IOobject &, const Xfer< MeshedSurface< face > > &surf, const word &surfName="")
 Construct copy/move from MeshedSurface. More...
 
virtual ~surfMesh ()
 Destructor. More...
 
fileName meshDir () const
 Return the local mesh directory (dbDir()/meshSubDir) More...
 
const fileNamepointsInstance () const
 Return the current instance directory for points. More...
 
const fileNamefacesInstance () const
 Return the current instance directory for faces. More...
 
void setInstance (const fileName &)
 Set the instance for mesh files. More...
 
virtual label nPoints () const
 Return the number of raw points. More...
 
virtual label nFaces () const
 Return the number of raw faces. More...
 
virtual label size () const
 Return number of faces. More...
 
virtual const pointFieldpoints () const
 Return points. More...
 
virtual const faceListfaces () const
 Return faces. More...
 
virtual const surfZoneListsurfZones () const
 Return surface zones. More...
 
void checkZones ()
 Check the surface zone definitions. More...
 
void addZones (const List< surfZone > &, const bool validate=true)
 Add surface zones. More...
 
virtual readUpdateState readUpdate ()
 Update the mesh based on the mesh files saved in. More...
 
void removeZones ()
 Update the mesh corresponding to given map. More...
 
void resetPrimitives (const Xfer< pointField > &points, const Xfer< faceList > &faces, const Xfer< surfZoneList > &zones, const bool validate=true)
 Reset mesh primitive data. More...
 
void transfer (MeshedSurface< face > &)
 Transfer the contents of the argument and annul the argument. More...
 
void write (const fileName &)
 Write to file. More...
 
Xfer< MeshedSurface< face > > xfer ()
 Transfer contents to the Xfer container as a MeshedSurface. More...
 
void clearGeom ()
 Clear geometry. More...
 
void clearAddressing ()
 Clear addressing. More...
 
void clearOut ()
 Clear all geometry and addressing unnecessary for CFD. More...
 
void clearPrimitives ()
 Clear primitive data (points, faces and cells) More...
 
void removeFiles (const fileName &instanceDir) const
 Remove all files from mesh instance. More...
 
void removeFiles () const
 Remove all files from mesh instance() More...
 
- Public Member Functions inherited from surfaceRegistry
 TypeName ("surfaceRegistry")
 Runtime type information. More...
 
 surfaceRegistry (const objectRegistry &, const word &surfName="")
 Construct for the given objectRegistry and named surface. More...
 
virtual ~surfaceRegistry ()
 Destructor. More...
 
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label nIoObjects=128)
 Construct the time objectRegistry given an initial estimate. More...
 
 objectRegistry (const IOobject &io, const label nIoObjects=128)
 Construct a sub-registry given an IObject to describe the registry. More...
 
virtual ~objectRegistry ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistryparent () const
 Return the parent objectRegistry. More...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
wordList names () const
 Return the list of names of the IOobjects. More...
 
wordList sortedNames () const
 Return the sorted list of names of the IOobjects. More...
 
wordList names (const word &className) const
 Return the list of names of IOobjects of given class name. More...
 
wordList sortedNames (const word &className) const
 Return the sorted list of names of IOobjects of given class name. More...
 
template<class Type >
wordList names () const
 Return the list of names of the IOobjects of given type. More...
 
template<class Type >
wordList names (const wordRe &name) const
 Return the list of objects whose name matches the input regExp. More...
 
template<class Type >
wordList names (const wordReList &name) const
 Return the list of objects whose name matches the input regExp. More...
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false) const
 Lookup and return a const sub-objectRegistry. Optionally create. More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Lookup and return all objects of the given Type. More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 Lookup and return all objects of the given Type. More...
 
template<class Type >
bool foundObject (const word &name) const
 Is the named Type found? More...
 
template<class Type >
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type. More...
 
label getEvent () const
 Return new event number. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool checkIn (regIOobject &) const
 Add an regIOobject to registry. More...
 
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry. More...
 
virtual bool modified () const
 Return true if any of the object's files have been modified. More...
 
void readModifiedObjects ()
 Read the objects that have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified. More...
 
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write the objects. More...
 
template<class Type >
Foam::wordList names () const
 
template<class Type >
Foam::wordList names (const wordRe &name) const
 
template<class Type >
Foam::wordList names (const wordReList &patterns) const
 
template<class Type >
Foam::HashTable< const Type * > lookupClass (const bool strict) const
 
template<class Type >
Foam::HashTable< Type * > lookupClass (const bool strict)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from HashTable< regIOobject * >
bool set (const word &, const regIOobject * &newElmt)
 Assign a new hashedEntry, overwriting existing entries. More...
 
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const HashTable< regIOobject *, word, string::hash > &)
 Construct as copy. More...
 
 HashTable (const Xfer< HashTable< regIOobject *, word, string::hash > > &)
 Construct by transferring the parameter contents. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const word &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const word &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< wordtoc () const
 Return the table of contents. More...
 
List< wordsortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const word &, const regIOobject * &newElmt)
 Insert a new hashedEntry. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const word &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< regIOobject *, word, string::hash > &)
 Transfer the contents of the argument table into this table. More...
 
Xfer< HashTable< regIOobject *, word, string::hash > > xfer ()
 Transfer contents to the Xfer container. More...
 
regIOobject * & operator[] (const word &)
 Find and return a hashedEntry. More...
 
const regIOobject * & operator[] (const word &) const
 Find and return a hashedEntry. More...
 
regIOobject * & operator() (const word &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< regIOobject *, word, string::hash > &)
 Assignment. More...
 
bool operator== (const HashTable< regIOobject *, word, string::hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< regIOobject *, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 Iterator set to the beginning of the HashTable. More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. More...
 
- Public Member Functions inherited from PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >
 PrimitivePatch (const ::Foam::UList< face > &faces, const Field< point > &points)
 Construct from components. More...
 
 PrimitivePatch (const Xfer< ::Foam::UList< face > > &faces, const Xfer< List< point > > &points)
 Construct from components. More...
 
 PrimitivePatch (::Foam::UList< face > &faces, Field< point > &points, const bool reUse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point > &)
 Construct as copy. More...
 
virtual ~PrimitivePatch ()
 Destructor. More...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
const Field< point > & points () const
 Return reference to global points. More...
 
label nPoints () const
 Return number of points supporting patch faces. More...
 
label nEdges () const
 Return number of edges in patch. More...
 
const edgeListedges () const
 Return list of edges, address into LOCAL point list. More...
 
label nInternalEdges () const
 Number of internal edges. More...
 
bool isInternalEdge (const label edgeI) const
 Is internal edge? More...
 
const labelListboundaryPoints () const
 Return list of boundary points,. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< face > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () const
 Return labelList of mesh points in patch. They are constructed. More...
 
const Map< label > & meshPointMap () const
 Mesh point map. Given the global point index find its. More...
 
const Field< point > & localPoints () const
 Return pointField of points in patch. More...
 
const labelListlocalPointOrder () const
 Return orders the local points for most efficient search. More...
 
label whichPoint (const label gp) const
 Given a global point index, return the local point index. More...
 
label whichEdge (const edge &) const
 Given an edge in local point labels, return its. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 Return labels of patch edges in the global edge list using. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of patch edges in the global edge list using. More...
 
const Field< point > & faceCentres () const
 Return face centres for patch. More...
 
const Field< point > & faceNormals () const
 Return face normals for patch. More...
 
const Field< point > & pointNormals () const
 Return point normals for patch. More...
 
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. More...
 
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. More...
 
const labelListListedgeLoops () const
 Return list of closed loops of boundary vertices. More...
 
surfaceTopo surfaceType () const
 Calculate surface type formed by patch. More...
 
bool checkTopology (const bool report=false, labelHashSet *setPtr=NULL) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=NULL) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< point > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point > &)
 Assignment. More...
 
- Public Member Functions inherited from UList< face >
 UList ()
 Null constructor. More...
 
 UList (face *__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 facecdata () const
 Return a const pointer to the first data element,. More...
 
facedata ()
 Return a pointer to the first data element,. More...
 
facefirst ()
 Return the first element of the list. More...
 
const facefirst () const
 Return first element of the list. More...
 
facelast ()
 Return the last element of the list. More...
 
const facelast () 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< face > &)
 Assign elements to those from UList. More...
 
faceoperator[] (const label)
 Return element of UList. More...
 
const faceoperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< face > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const face &)
 Assignment of all entries to the given value. 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< face > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< face > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< face > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< face > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< face > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< face > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< face > &) const
 Return true if !(a < b). Takes linear time. More...
 

Static Public Member Functions

static void write (const fileName &, const surfMesh &)
 Write to file. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Member Functions inherited from UList< face >
static const UList< face > & null ()
 Return a null UList. More...
 

Static Public Attributes

static word meshSubDir = "surfMesh"
 Return the mesh sub-directory name (normally "surfMesh") More...
 
- Static Public Attributes inherited from surfaceRegistry
static const word prefix
 The prefix to local: surfaces. More...
 
static word defaultName
 The default surface name: default. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 

Protected Member Functions

pointFieldstoredPoints ()
 Non-const access to global points. More...
 
faceListstoredFaces ()
 Non-const access to the faces. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
virtual void updateFacesRef ()
 Update references to storedFaces. More...
 
virtual void updatePointsRef ()
 Update references to storedPoints. More...
 
virtual void updateRefs ()
 Update references to storedPoints/storedFaces. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 

Friends

template<class Face >
class MeshedSurface
 
template<class Face >
class UnsortedMeshedSurface
 

Additional Inherited Members

- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

A surface mesh consisting of general polygon faces.

Source files

Definition at line 55 of file surfMesh.H.

Member Typedef Documentation

typedef surfMesh Mesh

Definition at line 142 of file surfMesh.H.

typedef bool BoundaryMesh

Placeholder only, but do not remove - it is needed for GeoMesh.

Definition at line 145 of file surfMesh.H.

Member Enumeration Documentation

Enumeration defining the state of the mesh after a read update.

Used for post-processing applications, where the mesh needs to update based on the files written in time directores

Enumerator
UNCHANGED 
POINTS_MOVED 
TOPO_CHANGE 
TOPO_PATCH_CHANGE 

Definition at line 72 of file surfMesh.H.

Constructor & Destructor Documentation

surfMesh ( const IOobject io,
const word surfName = "" 
)
explicit

Construct from IOobject, with alternative surface name.

Definition at line 74 of file surfMesh.C.

surfMesh ( const IOobject io,
const Xfer< pointField > &  pointLst,
const Xfer< faceList > &  faceLst,
const word surfName = "" 
)

Construct by transferring components (points, faces) without zones.

surfZones are added using addZones() member function

Definition at line 112 of file surfMesh.C.

surfMesh ( const IOobject io,
const Xfer< MeshedSurface< face > > &  surf,
const word surfName = "" 
)

Construct copy/move from MeshedSurface.

Definition at line 158 of file surfMesh.C.

References IOobject::db(), objectRegistry::dbDir(), Foam::endl(), Foam::Info, IOobject::instance(), IOobject::local(), IOobject::name(), Foam::nl, Foam::notNull(), IOobject::path(), and surfMesh::transfer().

Here is the call graph for this function:

~surfMesh ( )
virtual

Destructor.

Definition at line 221 of file surfMesh.C.

Member Function Documentation

pointField& storedPoints ( )
inlineprotected

Non-const access to global points.

Definition at line 111 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOPoints().

Referenced by MeshedSurface< Face >::MeshedSurface(), surfMesh::updatePointsRef(), and surfMesh::xfer().

Here is the call graph for this function:

Here is the caller graph for this function:

faceList& storedFaces ( )
inlineprotected

Non-const access to the faces.

Definition at line 117 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOFaces().

Referenced by MeshedSurface< Face >::MeshedSurface(), surfMesh::readUpdate(), surfMesh::updateFacesRef(), and surfMesh::xfer().

Here is the call graph for this function:

Here is the caller graph for this function:

surfZoneList& storedZones ( )
inlineprotected

Non-const access to the zones.

Definition at line 123 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOZones(), surfMesh::updateFacesRef(), surfMesh::updatePointsRef(), and surfMesh::updateRefs().

Referenced by MeshedSurface< Face >::MeshedSurface(), surfMesh::removeZones(), and surfMesh::xfer().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateFacesRef ( )
protectedvirtual

Update references to storedFaces.

Definition at line 240 of file surfMesh.C.

References surfMesh::storedFaces().

Referenced by surfMesh::storedZones(), and surfMesh::updateRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

void updatePointsRef ( )
protectedvirtual

Update references to storedPoints.

Definition at line 230 of file surfMesh.C.

References PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >::points(), and surfMesh::storedPoints().

Referenced by surfMesh::storedZones(), and surfMesh::updateRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateRefs ( )
protectedvirtual

Update references to storedPoints/storedFaces.

Definition at line 247 of file surfMesh.C.

References surfMesh::resetPrimitives(), surfMesh::updateFacesRef(), and surfMesh::updatePointsRef().

Referenced by surfMesh::resetPrimitives(), surfMesh::storedZones(), surfMesh::transfer(), and surfMesh::xfer().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "surfMesh"  )

Runtime type information.

Foam::fileName meshDir ( ) const

Return the local mesh directory (dbDir()/meshSubDir)

Definition at line 309 of file surfMesh.C.

References objectRegistry::dbDir(), and surfMesh::meshSubDir.

Referenced by surfMesh::readUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::fileName & pointsInstance ( ) const

Return the current instance directory for points.

Used in the consruction of geometric mesh data dependent on points

Definition at line 315 of file surfMesh.C.

References IOobject::instance(), and MeshedSurfaceIOAllocator::storedIOPoints().

Referenced by surfMesh::readUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::fileName & facesInstance ( ) const

Return the current instance directory for faces.

Definition at line 321 of file surfMesh.C.

References IOobject::instance(), and MeshedSurfaceIOAllocator::storedIOFaces().

Referenced by surfMesh::readUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

void setInstance ( const fileName inst)

Set the instance for mesh files.

Definition at line 31 of file surfMeshIO.C.

References IOobject::AUTO_WRITE, Foam::endl(), Foam::Info, IOobject::instance(), MeshedSurfaceIOAllocator::storedIOFaces(), MeshedSurfaceIOAllocator::storedIOPoints(), MeshedSurfaceIOAllocator::storedIOZones(), and IOobject::writeOpt().

Referenced by surfMesh::readUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label nPoints ( ) const
virtual

Return the number of raw points.

Definition at line 327 of file surfMesh.C.

References surfMesh::points(), and List< T >::size().

Referenced by surfPointGeoMesh::size().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label nFaces ( ) const
virtual

Return the number of raw faces.

Definition at line 333 of file surfMesh.C.

References surfMesh::faces(), and List< T >::size().

Referenced by surfMesh::checkZones(), surfGeoMesh::size(), and surfMesh::size().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual label size ( ) const
inlinevirtual

Return number of faces.

Definition at line 210 of file surfMesh.H.

References surfMesh::faces(), surfMesh::nFaces(), and surfMesh::points().

Referenced by surfMesh::checkZones().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::pointField & points ( ) const
virtual

Return points.

Definition at line 339 of file surfMesh.C.

References MeshedSurfaceIOAllocator::storedIOPoints().

Referenced by MeshedSurface< Face >::MeshedSurface(), surfMesh::nPoints(), surfMesh::size(), and surfMesh::write().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::faceList & faces ( ) const
virtual

Return faces.

Definition at line 345 of file surfMesh.C.

References MeshedSurfaceIOAllocator::storedIOFaces().

Referenced by MeshedSurface< Face >::MeshedSurface(), surfMesh::nFaces(), surfMesh::size(), and surfMesh::write().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const surfZoneList& surfZones ( ) const
inlinevirtual
void checkZones ( )

Check the surface zone definitions.

Definition at line 351 of file surfMesh.C.

References surfMesh::addZones(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, UList< T >::last(), surfMesh::nFaces(), surfMesh::removeZones(), List< T >::size(), surfMesh::size(), MeshedSurfaceIOAllocator::storedIOZones(), and WarningIn.

Referenced by surfMesh::addZones(), surfMesh::resetPrimitives(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void addZones ( const List< surfZone > &  ,
const bool  validate = true 
)

Add surface zones.

Definition at line 397 of file surfMesh.C.

References surfMesh::checkZones(), forAll, and MeshedSurfaceIOAllocator::storedIOZones().

Referenced by surfMesh::checkZones(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::surfMesh::readUpdateState readUpdate ( )
virtual
void removeZones ( )

Update the mesh corresponding to given map.

Remove surface zones

Definition at line 32 of file surfMeshClear.C.

References List< T >::clear(), surfMesh::clearOut(), Foam::endl(), Foam::Info, and surfMesh::storedZones().

Referenced by surfMesh::checkZones(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void resetPrimitives ( const Xfer< pointField > &  points,
const Xfer< faceList > &  faces,
const Xfer< surfZoneList > &  zones,
const bool  validate = true 
)

Reset mesh primitive data.

Definition at line 255 of file surfMesh.C.

References surfMesh::checkZones(), PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >::clearGeom(), MeshedSurfaceIOAllocator::reset(), surfMesh::transfer(), and surfMesh::updateRefs().

Referenced by surfMesh::surfZones(), and surfMesh::updateRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

void transfer ( MeshedSurface< face > &  surf)
void write ( const fileName name,
const surfMesh surf 
)
static

Write to file.

Definition at line 432 of file surfMesh.C.

References surfMesh::faces(), surfMesh::points(), surfMesh::surfZones(), and regIOobject::write().

Here is the call graph for this function:

void write ( const fileName name)

Write to file.

Definition at line 443 of file surfMesh.C.

References regIOobject::write().

Here is the call graph for this function:

Transfer contents to the Xfer container as a MeshedSurface.

Definition at line 291 of file surfMesh.C.

References PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >::clearGeom(), surfMesh::storedFaces(), surfMesh::storedPoints(), surfMesh::storedZones(), and surfMesh::updateRefs().

Referenced by surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearGeom ( )

Clear geometry.

Definition at line 50 of file surfMeshClear.C.

References PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >::clearGeom(), Foam::endl(), and Foam::Info.

Referenced by surfMesh::clearOut(), surfMesh::readUpdate(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearAddressing ( )

Clear addressing.

Definition at line 63 of file surfMeshClear.C.

References PrimitivePatch< face,::Foam::UList,::Foam::SubField< point >, point >::clearPatchMeshAddr(), Foam::endl(), and Foam::Info.

Referenced by surfMesh::clearOut(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearOut ( )

Clear all geometry and addressing unnecessary for CFD.

Definition at line 76 of file surfMeshClear.C.

References surfMesh::clearAddressing(), and surfMesh::clearGeom().

Referenced by surfMesh::readUpdate(), surfMesh::removeZones(), and surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearPrimitives ( )

Clear primitive data (points, faces and cells)

Referenced by surfMesh::surfZones().

Here is the caller graph for this function:

void removeFiles ( const fileName instanceDir) const

Remove all files from mesh instance.

Definition at line 417 of file surfMesh.C.

References IOobject::db(), surfMesh::meshSubDir, IOobject::path(), and Foam::rm().

Here is the call graph for this function:

void removeFiles ( ) const

Remove all files from mesh instance()

Definition at line 426 of file surfMesh.C.

References IOobject::instance().

Referenced by surfMesh::surfZones().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class MeshedSurface
friend

Definition at line 62 of file surfMesh.H.

friend class UnsortedMeshedSurface
friend

Definition at line 63 of file surfMesh.H.

Member Data Documentation

Foam::word meshSubDir = "surfMesh"
static

Return the mesh sub-directory name (normally "surfMesh")

Definition at line 152 of file surfMesh.H.

Referenced by edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), surfMesh::meshDir(), surfMesh::readUpdate(), and surfMesh::removeFiles().


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