polyDualMesh Class Reference

Creates dual of polyMesh. More...

Inheritance diagram for polyDualMesh:
Collaboration diagram for polyDualMesh:

Public Member Functions

 ClassName ("polyDualMesh")
 Runtime type information. More...
 
 polyDualMesh (const IOobject &)
 Construct from IOobject. More...
 
 polyDualMesh (const polyMesh &, const labelList &featureEdges, const labelList &featurePoints)
 Construct from polyMesh and list of edges and points to represent. More...
 
 polyDualMesh (const polyMesh &, const scalar featureCos)
 Construct from polyMesh and feature edge angle. Uses calcFeatures. More...
 
 ~polyDualMesh ()
 Destructor. More...
 
const labelIOListcellPoint () const
 From polyMesh cell to dual point. More...
 
const labelIOListboundaryFacePoint () const
 From polyMesh patch face to dual point. More...
 
- Public Member Functions inherited from polyMesh
 TypeName ("polyMesh")
 Runtime type information. More...
 
 polyMesh (const IOobject &io, const bool doInit=true)
 Read construct from IOobject. More...
 
 polyMesh (const IOobject &io, const Foam::zero, const bool syncPar=true)
 Construct from IOobject or as zero-sized mesh. More...
 
 polyMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&owner, labelList &&neighbour, const bool syncPar=true)
 Construct from IOobject and components. More...
 
 polyMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true)
 Construct without boundary with cells rather than owner/neighbour. More...
 
 polyMesh (const IOobject &io, pointField &&points, const cellShapeList &shapes, const faceListList &boundaryFaces, const wordList &boundaryPatchNames, const wordList &boundaryPatchTypes, const word &defaultBoundaryPatchName, const word &defaultBoundaryPatchType, const wordList &boundaryPatchPhysicalTypes, const bool syncPar=true)
 Construct from cell shapes. More...
 
 polyMesh (const IOobject &io, pointField &&points, const cellShapeList &shapes, const faceListList &boundaryFaces, const wordList &boundaryPatchNames, const PtrList< dictionary > &boundaryDicts, const word &defaultBoundaryPatchName, const word &defaultBoundaryPatchType, const bool syncPar=true)
 Construct from cell shapes, with patch information in dictionary format. More...
 
virtual ~polyMesh ()
 Destructor. More...
 
virtual const fileNamedbDir () const
 Override the objectRegistry dbDir for a single-region case. 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 &instance, const IOobjectOption::writeOption wOpt=IOobject::AUTO_WRITE)
 Set the instance for mesh files. More...
 
const wordregionName () const
 The mesh region name or word::null if polyMesh::defaultRegion. More...
 
virtual const meshStatedata () const noexcept
 Const reference to the mesh and solver state data. More...
 
virtual meshStatedata () noexcept
 Reference to the mesh and solver state data. More...
 
virtual const pointFieldpoints () const
 Return raw points. More...
 
virtual bool upToDatePoints (const regIOobject &io) const
 Return true if io is up-to-date with points. More...
 
virtual void setUpToDatePoints (regIOobject &io) const
 Set io to be up-to-date with points. More...
 
virtual const faceListfaces () const
 Return raw faces. More...
 
virtual const labelListfaceOwner () const
 Return face owner. More...
 
virtual const labelListfaceNeighbour () const
 Return face neighbour. More...
 
virtual const pointFieldoldPoints () const
 Return old points (mesh motion) More...
 
virtual const pointFieldoldCellCentres () const
 Return old cellCentres (mesh motion) More...
 
const polyBoundaryMeshboundaryMesh () const noexcept
 Return boundary mesh. More...
 
const boundBoxbounds () const noexcept
 Return mesh bounding box. More...
 
const Vector< label > & geometricD () const
 Return the vector of geometric directions in mesh. More...
 
label nGeometricD () const
 Return the number of valid geometric dimensions in the mesh. More...
 
const Vector< label > & solutionD () const
 Return the vector of solved-for directions in mesh. More...
 
label nSolutionD () const
 Return the number of valid solved-for dimensions in the mesh. More...
 
const labelIOListtetBasePtIs () const
 Return the tetBasePtIs. More...
 
const indexedOctree< treeDataCell > & cellTree () const
 Return the cell search tree. More...
 
const pointZoneMeshpointZones () const noexcept
 Return point zone mesh. More...
 
const faceZoneMeshfaceZones () const noexcept
 Return face zone mesh. More...
 
const cellZoneMeshcellZones () const noexcept
 Return cell zone mesh. More...
 
const objectRegistrythisDb () const noexcept
 Return the object registry. More...
 
label comm () const noexcept
 The communicator used for parallel communication. More...
 
label & comm () noexcept
 The communicator used for parallel communication. More...
 
bool hasGlobalData () const noexcept
 Is demand-driven parallel info available? More...
 
const globalMeshDataglobalData () const
 Return parallel info (demand-driven) More...
 
virtual bool dynamic () const
 Is mesh dynamic. More...
 
bool moving () const noexcept
 Is mesh moving. More...
 
bool moving (const bool on) noexcept
 Set the mesh to be moving. More...
 
bool topoChanging () const noexcept
 Is mesh topology changing. More...
 
bool topoChanging (const bool on) noexcept
 Set the mesh topology to be changing. More...
 
bool changing () const noexcept
 Is mesh changing (topology changing and/or moving) More...
 
virtual void movePoints (const pointField &)
 Move points. More...
 
void resetMotion () const
 Reset motion. More...
 
pointZoneMeshpointZones () noexcept
 Return non-const access to the pointZones. More...
 
faceZoneMeshfaceZones () noexcept
 Return non-const access to the faceZones. More...
 
cellZoneMeshcellZones () noexcept
 Return non-const access to the cellZones. More...
 
void addPatches (polyPatchList &plist, const bool validBoundary=true)
 Add boundary patches. More...
 
void addPatches (const List< polyPatch *> &p, const bool validBoundary=true)
 Add boundary patches. More...
 
void addZones (PtrList< pointZone > &&pz, PtrList< faceZone > &&fz, PtrList< cellZone > &&cz)
 Add mesh zones. More...
 
void addZones (const List< pointZone *> &pz, const List< faceZone *> &fz, const List< cellZone *> &cz)
 Add mesh zones. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
virtual readUpdateState readUpdate ()
 Update the mesh based on the mesh files saved in. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update the mesh corresponding to given map. More...
 
void removeBoundary ()
 Remove boundary patches. More...
 
void resetPrimitives (autoPtr< pointField > &&points, autoPtr< faceList > &&faces, autoPtr< labelList > &&owner, autoPtr< labelList > &&neighbour, const labelUList &patchSizes, const labelUList &patchStarts, const bool validBoundary=true)
 Reset mesh primitive data. Assumes all patch info correct. More...
 
void clearGeom ()
 Clear geometry. More...
 
void updateGeomPoints (pointIOField &&newPoints, autoPtr< labelIOList > &newTetBasePtIsPtr)
 Update geometry points; keep topology. Optionally with new face decomposition. More...
 
void clearAddressing (const bool isMeshUpdate=false)
 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 clearTetBasePtIs ()
 Clear tet base points. More...
 
void clearCellTree ()
 Clear cell tree data. More...
 
void removeFiles (const fileName &instanceDir) const
 Remove all files from mesh instance. More...
 
void removeFiles () const
 Remove all files from mesh instance() More...
 
bool hasTetBasePtIs () const
 
virtual bool checkFaceOrthogonality (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check non-orthogonality. More...
 
virtual bool checkFaceSkewness (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face skewness. More...
 
virtual bool checkEdgeAlignment (const bool report, const Vector< label > &directions, labelHashSet *setPtr) const
 Check edge alignment for 1D/2D cases. More...
 
virtual bool checkCellDeterminant (const bool report, labelHashSet *setPtr) const
 
virtual bool checkMeshMotion (const pointField &newPoints, const bool report=false, const bool detailedReport=false) const
 Check mesh motion for correctness given motion points. More...
 
virtual bool checkFaceWeight (const bool report, const scalar minWeight=0.05, labelHashSet *setPtr=nullptr) const
 Check for face weights. More...
 
virtual bool checkVolRatio (const bool report, const scalar minRatio=0.01, labelHashSet *setPtr=nullptr) const
 Check for neighbouring cell volumes. More...
 
void findCellFacePt (const point &p, label &celli, label &tetFacei, label &tetPti) const
 Find the cell, tetFacei and tetPti for point p. More...
 
void findTetFacePt (const label celli, const point &p, label &tetFacei, label &tetPti) const
 Find the tetFacei and tetPti for point p in celli. More...
 
bool pointInCell (const point &p, label celli, const cellDecomposition=CELL_TETS) const
 Test if point p is in the celli. More...
 
label findCell (const point &p, const cellDecomposition=CELL_TETS) const
 Find cell enclosing this location and return index. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool writeOnProc=true) const
 Write items held in the objectRegistry. Normally includes mesh components (points, faces, etc) and any registered fields. More...
 
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label initialCapacity=128)
 Construct the time objectRegistry, with estimated table capacity (default: 128) More...
 
 objectRegistry (const IOobject &io, const label initialCapacity=128)
 Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128) More...
 
virtual ~objectRegistry ()
 Destructor, with checkOut() for all objects that are ownedByRegistry. More...
 
const objectRegistrythisDb () const noexcept
 Return the object registry. More...
 
const objectRegistryparent () const noexcept
 Return the parent objectRegistry. More...
 
const Timetime () const noexcept
 Return time registry. More...
 
bool isTimeDb () const noexcept
 True if the registry is Time. More...
 
HashTable< wordHashSetclasses () const
 A summary hash of classes used and their associated object names. More...
 
template<class MatchPredicate >
HashTable< wordHashSetclasses (const MatchPredicate &matchName) const
 A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. More...
 
template<class Type , bool Strict = false>
UPtrList< const Type > cobjects () const
 Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
UPtrList< Type > objects ()
 Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > cobjects (const MatchPredicate &matchName) const
 Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , class MatchPredicate >
UPtrList< Type > objects (const MatchPredicate &matchName)
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , bool Strict = false>
UPtrList< const Type > csorted () const
 Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
UPtrList< Type > sorted ()
 Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
UPtrList< const regIOobjectcsorted () const
 Return sorted list of objects. More...
 
UPtrList< regIOobjectsorted ()
 Return sorted list of objects. More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , class MatchPredicate >
UPtrList< Type > sorted (const MatchPredicate &matchName)
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
label count (const char *clsName) const
 The number of objects of the given class name. More...
 
template<class MatchPredicate >
label count (const MatchPredicate &matchClass) const
 The number of objects of the given class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The number of objects of the given class name. More...
 
template<class Type >
label count (const bool strict=false) const
 The names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
label count (const MatchPredicate &matchName) const
 The names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
wordList names () const
 The unsorted names of all objects. More...
 
wordList names (const char *clsName) const
 The unsorted names of objects with the given class name. More...
 
template<class MatchPredicate >
wordList names (const MatchPredicate &matchClass) const
 The unsorted names of objects with a matching class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The unsorted names of objects with a matching class name that also have a matching object name. More...
 
template<class Type >
wordList names () const
 The unsorted names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
wordList names (const MatchPredicate &matchName) const
 The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
wordList sortedNames () const
 The sorted names of all objects. More...
 
wordList sortedNames (const char *clsName) const
 The sorted names of objects with the given class name. More...
 
template<class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchClass) const
 The sorted names objects with a matching class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The sorted names of objects with a matching class name that also have a matching object name. More...
 
template<class Type >
wordList sortedNames () const
 The sorted names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchName) const
 The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
 Lookup and return a const sub-objectRegistry. More...
 
template<class Type , bool Strict = false>
HashTable< const Type * > lookupClass () const
 Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
HashTable< Type * > lookupClass ()
 Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict) const
 Return all objects with a class satisfying isA<Type> More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict)
 Return all objects with a class satisfying isA<Type> More...
 
const regIOobjectcfindIOobject (const word &name, const bool recursive=false) const
 Return const pointer to the regIOobject. More...
 
bool contains (const word &name, const bool recursive=false) const
 Does the registry contain the regIOobject object (by name). More...
 
template<class Type >
bool foundObject (const word &name, const bool recursive=false) const
 Is the named Type found? More...
 
template<class Type >
const Type * cfindObject (const word &name, const bool recursive=false) const
 Return const pointer to the object of the given Type. More...
 
template<class Type >
const Type * findObject (const word &name, const bool recursive=false) const
 Return const pointer to the object of the given Type. More...
 
template<class Type >
Type * findObject (const word &name, const bool recursive=false)
 Return non-const pointer to the object of the given Type. More...
 
template<class Type >
Type * getObjectPtr (const word &name, const bool recursive=false) const
 Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. More...
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. More...
 
label getEvent () const
 Return new event number. More...
 
bool checkIn (regIOobject *io) const
 Add a regIOobject to registry. A nullptr is ignored. More...
 
bool checkIn (regIOobject &io) const
 Add a regIOobject to registry. More...
 
bool checkOut (regIOobject *io) const
 Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. More...
 
bool checkOut (regIOobject &io) const
 Remove a regIOobject from registry and free memory if the object is ownedByRegistry. More...
 
bool checkOut (const word &key) const
 Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. More...
 
void clear ()
 Clear all entries from the registry. More...
 
void clearStorage ()
 Clear all entries from the registry and the table itself. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by the given iterator. More...
 
bool erase (const word &key)
 Erase an entry specified by the given key. More...
 
label erase (std::initializer_list< word > keys)
 Remove entries given by the listed keys. More...
 
label erase (const UList< word > &keys)
 Remove entries given by the listed keys. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool is_cacheTemporaryObject (const word &name) const
 True if given name is in the cacheTemporaryObjects set. More...
 
bool is_cacheTemporaryObject (const regIOobject *io) const
 True if name of object is in the cacheTemporaryObjects set. More...
 
bool is_cacheTemporaryObject (const regIOobject &io) const
 True if name of object is in the cacheTemporaryObjects set. More...
 
template<class Type >
bool cacheTemporaryObject (Type &obj) const
 Cache the given object. Moves content and stores. More...
 
void resetCacheTemporaryObject (const regIOobject *io) const
 Reset the cache state of the given object (nullptr is ignored) More...
 
void resetCacheTemporaryObject (const regIOobject &io) const
 Reset the cache state of the given object in the cacheTemporaryObjects set. More...
 
bool checkCacheTemporaryObjects () const
 Check that all objects specified in the cacheTemporaryObjects were also cached. 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
 The writeData function is required by regIOobject but not used. More...
 
bool found (const word &name, bool recursive=false) const
 Same as contains() More...
 
template<class Type >
const Type * lookupObjectPtr (const word &name, bool recursive=false) const
 Deprecated(2018-10) find object. More...
 
template<class Type >
Type * lookupObjectRefPtr (const word &name, bool recursive=false) const
 Deprecated(2018-10) get object pointer, ignoring constness. More...
 
template<class Type >
UPtrList< const Type > sorted () const
 Deprecated(2023-07) use csorted() method. More...
 
UPtrList< const regIOobjectsorted () const
 Deprecated(2023-07) use csorted() method. More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > sorted (const MatchPredicate &matchName) const
 Deprecated(2023-07) use csorted() method. More...
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclassesImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)
 
template<class Type , class MatchPredicate >
Foam::label countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)
 
template<class Type , class MatchPredicate >
Foam::wordList namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
 
template<class Type >
Foam::HashTable< Type * > lookupClassTypeImpl (const bool strict, const objectRegistry &list)
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclasses (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::label count (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type , class MatchPredicate >
Foam::label count (const MatchPredicate &matchName) const
 
template<class Type >
Foam::label count (const bool strict) const
 
template<class Type , bool Strict>
Foam::UPtrList< const Type > cobjects () const
 
template<class Type , bool Strict>
Foam::UPtrList< Type > objects ()
 
template<class Type , bool Strict>
Foam::UPtrList< const Type > csorted () const
 
template<class Type , bool Strict>
Foam::UPtrList< Type > sorted ()
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > cobjects (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > objects (const MatchPredicate &matchName)
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > sorted (const MatchPredicate &matchName)
 
template<class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList names () const
 
template<class Type , class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList sortedNames () const
 
template<class Type , class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchName) const
 
template<class Type , bool Strict>
Foam::HashTable< const Type * > lookupClass () const
 
template<class Type , bool Strict>
Foam::HashTable< Type * > lookupClass ()
 
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
void operator= (const regIOobject &)=delete
 No copy assignment. More...
 
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 Copy construct, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 Register object with its registry and transfer ownership to the registry. More...
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 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 as up-to-date. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (const word &, const bool readOnProc=true)
 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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool write (const bool writeOnProc=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from path, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
 IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
 Copy construct, resetting register option. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const noexcept
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
void resetHeader (const word &newName=word::null)
 Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...
 
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const noexcept
 Return the Time::rootPath() More...
 
const fileNamecaseName () const noexcept
 Return the Time::caseName() More...
 
const fileNameglobalCaseName () const noexcept
 Return the Time::globalCaseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path for the object (with instance, local,...). More...
 
fileName globalPath () const
 The complete global path for the object (with instance, local,...) More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName globalPath (const word &instance, const fileName &local=fileName::null) const
 The complete global path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName globalObjectPath () const
 The complete global path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
 
bool readHeader (Istream &is)
 Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
bool readHeader (dictionary &headerDict, Istream &is)
 Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (respects is_globalIOobject trait) and check its info. More...
 
template<class Type >
fileName typeFilePath (const bool search=true) const
 Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 Write header into a dictionary with current type() and given output format. More...
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 Write header into a dictionary with override of type and given output format. More...
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const noexcept
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class Type >
Foam::fileName typeFilePath (const bool search) const
 
- Public Member Functions inherited from IOobjectOption
constexpr IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
 
constexpr IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_WRITE with specified read/register options. More...
 
constexpr IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_READ with specified write/register options. More...
 
constexpr IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option. More...
 
constexpr IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
 Construct from components with specified register option as bool. More...
 
constexpr IOobjectOption (bool registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
 
readOption readOpt () const noexcept
 Get the read option. More...
 
readOption readOpt (readOption opt) noexcept
 Set the read option. More...
 
writeOption writeOpt () const noexcept
 Get the write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Set the write option. More...
 
bool registerObject () const noexcept
 Should objects created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference. More...
 
bool globalObject () const noexcept
 True if object is treated the same for all processors. More...
 
bool globalObject (bool on) noexcept
 Change global-object status. More...
 
bool isAnyRead () const noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
bool isReadRequired () const noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
bool isReadOptional () const noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
bool & registerObject () noexcept
 Access to the register object option. More...
 
bool & globalObject () noexcept
 Access to the global object option. More...
 
- Public Member Functions inherited from HashTable< regIOobject *>
 HashTable () noexcept
 Default construct: empty without allocation (capacity=0) More...
 
 HashTable (const Foam::zero) noexcept
 Construct empty without allocation (capacity=0) More...
 
 HashTable (const label initialCapacity)
 Construct empty with initial table capacity. More...
 
 HashTable (Istream &is)
 Construct from Istream. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs) noexcept
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< word, regIOobject * >> list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
label size () const noexcept
 The number of elements in table. More...
 
label capacity () const noexcept
 The size of the underlying table (the number of buckets) More...
 
regIOobject * & at (const word &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const regIOobject * & at (const word &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool contains (const word &key) const
 True if hashed key is contained (found) in table. More...
 
iterator find (const word &key)
 Find and return an iterator set at the hashed entry. More...
 
const_iterator find (const word &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const_iterator cfind (const word &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const regIOobject * & lookup (const word &key, const regIOobject * &deflt) const
 Return hashed entry if it exists, or return the given default. More...
 
List< wordtoc () const
 The table of contents (the keys) in unsorted order. More...
 
List< wordsortedToc () const
 The table of contents (the keys) in sorted order. More...
 
List< wordsortedToc (const Compare &comp) const
 The table of contents (the keys) sorted according to the specified comparator. More...
 
Foam::List< wordsortedToc (const Compare &comp) const
 
List< wordtocKeys (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the keys. More...
 
Foam::List< wordtocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocValues (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the values. More...
 
Foam::List< wordtocValues (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocEntries (const BinaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More...
 
Foam::List< wordtocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 Const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< node_typesorted ()
 Non-const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< const node_typesorted () const
 Deprecated(2023-07) use csorted() method. More...
 
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of keys that satisfy the unary predicate. More...
 
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of values that satisfy the unary predicate. More...
 
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 Count the number of entries that satisfy the binary predicate. More...
 
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
bool emplace (const word &key, Args &&... args)
 Emplace insert a new entry, not overwriting existing entries. More...
 
bool emplace_set (const word &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const word &key, const regIOobject * &obj)
 Copy insert a new entry, not overwriting existing entries. More...
 
bool insert (const word &key, regIOobject * &&obj)
 Move insert a new entry, not overwriting existing entries. More...
 
bool set (const word &key, const regIOobject * &obj)
 Copy assign a new entry, overwriting existing entries. More...
 
bool set (const word &key, regIOobject * &&obj)
 Move assign a new entry, overwriting existing entries. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by given iterator. More...
 
bool erase (const word &key)
 Erase an entry specified by the given key. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &other)
 Remove table entries given by keys of the other hash-table. More...
 
label erase (std::initializer_list< word > keys)
 Remove table entries given by the listed keys. More...
 
label erase (InputIter first, InputIter last)
 Remove multiple entries using an iterator range of keys. More...
 
label erase (const FixedList< word, N > &keys)
 Remove table entries given by the listed keys. More...
 
label erase (const UList< word > &keys)
 Remove table entries given by the listed keys. More...
 
Foam::label erase (InputIter first, InputIter last)
 
Foam::label erase (const FixedList< word, N > &keys)
 
Foam::label erase (const HashTable< AnyType, word, AnyHash > &other)
 
label retain (const HashTable< AnyType, word, AnyHash > &other)
 Retain table entries given by keys of the other hash-table. More...
 
Foam::label retain (const HashTable< AnyType, word, AnyHash > &other)
 
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their keys. More...
 
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their values. More...
 
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their key/value. More...
 
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
void clear ()
 Remove all entries from table. More...
 
void clearStorage ()
 Remove all entries from table and the table itself. More...
 
void setCapacity (label newCapacity)
 Change the hash table capacity (number of buckets). More...
 
void resize (label newCapacity)
 Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...
 
void reserve (label numEntries)
 Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...
 
void swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept
 Swap contents into this table. More...
 
void transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Transfer contents into this table. More...
 
void merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source)
 Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More...
 
void merge (HashTable< regIOobject *, word, Foam::Hash< word > > &&source)
 Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More...
 
regIOobject * & operator[] (const word &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const regIOobject * & operator[] (const word &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
regIOobject * & operator() (const word &key)
 Return existing entry or create a new entry. More...
 
regIOobject * & operator() (const word &key, const regIOobject * &deflt)
 Return existing entry or insert a new entry. More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
bool operator== (const this_type &rhs) const
 Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () const
 A const iterator begin/end pair for iterating over keys. 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...
 
iterator end () noexcept
 iterator to signal the end (for any HashTable) More...
 
const_iterator end () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
constexpr const_iterator cend () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 Write unordered keys (list), with line-breaks when length exceeds shortLen. More...
 
bool found (const word &key) const
 Same as contains() More...
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore () noexcept=default
 Default construct. More...
 
- Public Member Functions inherited from primitiveMesh
 ClassName ("primitiveMesh")
 
 primitiveMesh (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells)
 Construct from components. More...
 
virtual ~primitiveMesh ()
 Destructor. More...
 
void reset (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells)
 Reset this primitiveMesh given the primitive array sizes. More...
 
void reset (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells, cellList &cells)
 Reset this primitiveMesh given the primitive array sizes and cells. More...
 
void resetGeometry (pointField &&faceCentres, pointField &&faceAreas, pointField &&cellCentres, scalarField &&cellVolumes)
 Reset the local geometry. More...
 
label nPoints () const noexcept
 Number of mesh points. More...
 
label nEdges () const
 Number of mesh edges. More...
 
label nFaces () const noexcept
 Number of mesh faces. More...
 
label nCells () const noexcept
 Number of mesh cells. More...
 
label nInternalFaces () const noexcept
 Number of internal faces. More...
 
label nBoundaryFaces () const noexcept
 Number of boundary faces (== nFaces - nInternalFaces) More...
 
label nInternalPoints () const noexcept
 Points not on boundary. More...
 
label nInternal0Edges () const
 Internal edges (i.e. not on boundary face) using no boundary point. More...
 
label nInternal1Edges () const
 Internal edges using 0 or 1 boundary point. More...
 
label nInternalEdges () const
 Internal edges using 0,1 or 2 boundary points. More...
 
const cellShapeListcellShapes () const
 Return cell shapes. More...
 
const edgeListedges () const
 Return mesh edges. Uses calcEdges. More...
 
const labelListListcellCells () const
 
const labelListListedgeCells () const
 
const labelListListpointCells () const
 
const cellListcells () const
 
const labelListListedgeFaces () const
 
const labelListListpointFaces () const
 
const labelListListcellEdges () const
 
const labelListListfaceEdges () const
 
const labelListListpointEdges () const
 
const labelListListpointPoints () const
 
const labelListListcellPoints () const
 
const vectorFieldcellCentres () const
 
const vectorFieldfaceCentres () const
 
const scalarFieldcellVolumes () const
 
const vectorFieldfaceAreas () const
 
void movePoints (const pointField &p, const pointField &oldP)
 Move points. More...
 
bool isInternalFace (const label faceIndex) const noexcept
 Return true if given face label is internal to the mesh. More...
 
virtual bool checkUpperTriangular (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face ordering. More...
 
virtual bool checkCellsZipUp (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check cell zip-up. More...
 
virtual bool checkFaceVertices (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check uniqueness of face vertices. More...
 
virtual bool checkPoints (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for unused points. More...
 
virtual bool checkFaceFaces (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face-face connectivity. More...
 
virtual bool checkClosedBoundary (const bool report=false) const
 Check boundary for closedness. More...
 
virtual bool checkClosedCells (const bool report=false, labelHashSet *setPtr=nullptr, labelHashSet *highAspectSetPtr=nullptr, const Vector< label > &solutionD=Vector< label >::one) const
 Check cells for closedness. More...
 
virtual bool checkFaceAreas (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for negative face areas. More...
 
virtual bool checkCellVolumes (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for negative cell volumes. More...
 
virtual bool checkFacePyramids (const bool report=false, const scalar minPyrVol=-SMALL, labelHashSet *setPtr=nullptr) const
 Check face pyramid volume. More...
 
virtual bool checkFaceAngles (const bool report=false, const scalar maxSin=10, labelHashSet *setPtr=nullptr) const
 Check face angles. More...
 
virtual bool checkFaceFlatness (const bool report, const scalar warnFlatness, labelHashSet *setPtr) const
 Check face warpage: decompose face and check ratio between. More...
 
virtual bool checkPointNearness (const bool report, const scalar reportDistSqr, labelHashSet *setPtr=nullptr) const
 Check for point-point-nearness,. More...
 
virtual bool checkEdgeLength (const bool report, const scalar minLenSqr, labelHashSet *setPtr=nullptr) const
 Check edge length. More...
 
virtual bool checkConcaveCells (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for concave cells by the planes of faces. More...
 
virtual bool checkTopology (const bool report=false) const
 Check mesh topology for correctness. More...
 
virtual bool checkGeometry (const bool report=false) const
 Check mesh geometry (& implicitly topology) for correctness. More...
 
virtual bool checkMesh (const bool report=false) const
 Check mesh for correctness. Returns false for no error. More...
 
boundBox cellBb (const label celli) const
 The bounding box for given cell index. More...
 
bool pointInCellBB (const point &p, label celli, scalar inflationFraction=0) const
 Return true if the point in the cell bounding box. More...
 
bool pointInCell (const point &p, label celli) const
 Return true if the point is in the cell. More...
 
label findNearestCell (const point &location) const
 Find the cell with the nearest cell centre to location. More...
 
label findCell (const point &location) const
 Find cell enclosing this location (-1 if not in mesh) More...
 
void printAllocated () const
 Print a list of all the currently allocated mesh data. More...
 
bool hasCellShapes () const noexcept
 
bool hasEdges () const noexcept
 
bool hasCellCells () const noexcept
 
bool hasEdgeCells () const noexcept
 
bool hasPointCells () const noexcept
 
bool hasCells () const noexcept
 
bool hasEdgeFaces () const noexcept
 
bool hasPointFaces () const noexcept
 
bool hasCellEdges () const noexcept
 
bool hasFaceEdges () const noexcept
 
bool hasPointEdges () const noexcept
 
bool hasPointPoints () const noexcept
 
bool hasCellPoints () const noexcept
 
bool hasCellCentres () const noexcept
 
bool hasCellVolumes () const noexcept
 
bool hasFaceCentres () const noexcept
 
bool hasFaceAreas () const noexcept
 
const labelListcellCells (const label celli, DynamicList< label > &) const
 cellCells using cells. More...
 
const labelListcellCells (const label celli) const
 
const labelListcellPoints (const label celli, labelHashSet &, DynamicList< label > &) const
 cellPoints using cells More...
 
const labelListcellPoints (const label celli) const
 
const labelListpointCells (const label pointi, DynamicList< label > &) const
 pointCells using pointFaces More...
 
const labelListpointCells (const label pointi) const
 
const labelListpointPoints (const label pointi, DynamicList< label > &) const
 pointPoints using edges, pointEdges More...
 
const labelListpointPoints (const label pointi) const
 
const labelListfaceEdges (const label facei, DynamicList< label > &) const
 faceEdges using pointFaces, edges, pointEdges More...
 
const labelListfaceEdges (const label facei) const
 
const labelListedgeFaces (const label edgeI, DynamicList< label > &) const
 edgeFaces using pointFaces, edges, pointEdges More...
 
const labelListedgeFaces (const label edgeI) const
 
const labelListedgeCells (const label edgeI, DynamicList< label > &) const
 edgeCells using pointFaces, edges, pointEdges More...
 
const labelListedgeCells (const label edgeI) const
 
const labelListcellEdges (const label celli, labelHashSet &, DynamicList< label > &) const
 cellEdges using cells, pointFaces, edges, pointEdges More...
 
const labelListcellEdges (const label celli) const
 
virtual void updateGeom ()
 Update all geometric data. More...
 
void clearGeom ()
 Clear geometry. More...
 
void clearCellGeom ()
 Clear cell-based geometry only. More...
 
void clearAddressing ()
 Clear topological data. More...
 
void clearOut ()
 Clear all geometry and addressing unnecessary for CFD. More...
 

Static Public Member Functions

static void calcFeatures (const polyMesh &, const scalar featureCos, labelList &featureEdges, labelList &featurePoints)
 Helper function to create feature edges and points based on. More...
 
- Static Public Member Functions inherited from polyMesh
static fileName meshDir (const word &region)
 Return the local mesh directory name (eg, "polyMesh") after applying filter for defaultRegion. More...
 
static const wordregionName (const word &region)
 The mesh region name or word::null if polyMesh::defaultRegion. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static word scopedName (const std::string &scope, const word &name1, const word &name2)
 Create scope:name1:name2 or scope_name1_name2 string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from IOobjectOption
static bool isAnyRead (readOption opt) noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
static bool isReadOptional (readOption opt) noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
static readOption lazierRead (readOption opt) noexcept
 Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label requested_size)
 Return a canonical (power-of-two) of the requested size. More...
 
- Static Public Member Functions inherited from primitiveMesh
static void calcCells (cellList &, const labelUList &own, const labelUList &nei, const label nCells=-1)
 Helper function to calculate cell-face addressing from. More...
 
static bool calcPointOrder (label &nInternalPoints, labelList &pointMap, const faceList &, const label nInternalFaces, const label nPoints)
 Helper function to calculate point ordering. Returns true. More...
 
static scalar setClosedThreshold (const scalar)
 Set the closedness ratio warning threshold. More...
 
static scalar setAspectThreshold (const scalar)
 Set the aspect ratio warning threshold. More...
 
static scalar setNonOrthThreshold (const scalar)
 Set the non-orthogonality warning threshold in degrees. More...
 
static scalar setSkewThreshold (const scalar)
 Set the skewness warning threshold as percentage. More...
 

Additional Inherited Members

- Public Types inherited from polyMesh
enum  readUpdateState { UNCHANGED, POINTS_MOVED, TOPO_CHANGE, TOPO_PATCH_CHANGE }
 Enumeration defining the state of the mesh after a read update. More...
 
enum  cellDecomposition { FACE_PLANES, FACE_CENTRE_TRIS, FACE_DIAG_TRIS, CELL_TETS }
 Enumeration defining the decomposition of the cell for. More...
 
typedef polyMesh Mesh
 The mesh type. More...
 
typedef polyBoundaryMesh BoundaryMesh
 The boundary type associated with the mesh. More...
 
- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from IOobjectOption
enum  readOption : unsigned char {
  NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3,
  LAZY_READ = 0x4, READ_IF_PRESENT = 0x4
}
 Enumeration defining read preferences. More...
 
enum  writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
 Enumeration defining write preferences. More...
 
enum  registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
 Enumeration for use with registerObject(). Values map to bool (false/true) More...
 
- Public Types inherited from HashTable< regIOobject *>
typedef HashTable< regIOobject *, word, Foam::Hash< word > > this_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type node_type
 A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...
 
typedef word key_type
 The second template parameter, type of keys used. More...
 
typedef regIOobjectmapped_type
 The first template parameter, type of objects contained. More...
 
typedef regIOobjectvalue_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Foam::Hash< wordhasher
 The third template parameter, the hash index method. More...
 
typedef regIOobject * * pointer
 Pointer type for storing into value_type objects. More...
 
typedef regIOobject * & reference
 Reference to the stored value_type. More...
 
typedef const regIOobject * * const_pointer
 Const pointer type for the stored value_type. More...
 
typedef const regIOobject * & const_reference
 Const reference to the stored value_type. More...
 
typedef label difference_type
 The type to represent the difference between two iterators. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
using key_iterator = key_iterator_base< iterator >
 Forward iterator returning the key. More...
 
using const_key_iterator = key_iterator_base< const_iterator >
 Forward const iterator returning the key. More...
 
- Static Public Attributes inherited from polyMesh
static word defaultRegion = "region0"
 Return the default region name. More...
 
static word meshSubDir = "polyMesh"
 Return the mesh sub-directory name (usually "polyMesh") More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable internal table size. Approximately labelMax/4. More...
 
- Static Public Attributes inherited from primitiveMesh
static const unsigned cellsPerEdge_ = 4
 Estimated number of cells per edge. More...
 
static const unsigned cellsPerPoint_ = 8
 Estimated number of cells per point. More...
 
static const unsigned facesPerCell_ = 6
 Estimated number of faces per cell. More...
 
static const unsigned facesPerEdge_ = 4
 Estimated number of faces per edge. More...
 
static const unsigned facesPerPoint_ = 12
 Estimated number of faces per point. More...
 
static const unsigned edgesPerCell_ = 12
 Estimated number of edges per cell. More...
 
static const unsigned edgesPerFace_ = 4
 Estimated number of edges per cell. More...
 
static const unsigned edgesPerPoint_ = 6
 Estimated number of edges per point. More...
 
static const unsigned pointsPerCell_ = 8
 Estimated number of points per cell. More...
 
static const unsigned pointsPerFace_ = 4
 Estimated number of points per face. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from primitiveMesh
void calcFaceCentresAndAreas () const
 Calculate face centres and areas. More...
 
void calcCellCentresAndVols () const
 Calculate cell centres and volumes. More...
 
void calcEdgeVectors () const
 Calculate edge vectors. More...
 
bool checkDuplicateFaces (const label, const Map< label > &, label &nBaffleFaces, labelHashSet *) const
 Check if all points on face are shared with another face. More...
 
bool checkCommonOrder (const label, const Map< label > &, labelHashSet *) const
 Check that shared points are in consecutive order. More...
 
bool checkClosedBoundary (const vectorField &areas, const bool report, const bitSet &internalOrCoupledFaces) const
 Check boundary for closedness. More...
 
bool checkClosedCells (const vectorField &faceAreas, const scalarField &cellVolumes, const bool report, labelHashSet *setPtr, labelHashSet *aspectSetPtr, const Vector< label > &meshD) const
 Check cells for closedness. More...
 
bool checkFaceAreas (const vectorField &faceAreas, const bool report, const bool detailedReport, labelHashSet *setPtr) const
 Check for negative face areas. More...
 
bool checkCellVolumes (const scalarField &vols, const bool report, const bool detailedReport, labelHashSet *setPtr) const
 Check for negative cell volumes. More...
 
bool checkFaceOrthogonality (const vectorField &fAreas, const vectorField &cellCtrs, const bool report, labelHashSet *setPtr) const
 Check for non-orthogonality. More...
 
bool checkFacePyramids (const pointField &points, const vectorField &ctrs, const bool report, const bool detailedReport, const scalar minPyrVol, labelHashSet *setPtr) const
 Check face pyramid volume. More...
 
bool checkFaceSkewness (const pointField &points, const vectorField &fCtrs, const vectorField &fAreas, const vectorField &cellCtrs, const bool report, labelHashSet *setPtr) const
 Check face skewness. More...
 
bool checkFaceAngles (const pointField &points, const vectorField &faceAreas, const bool report, const scalar maxDeg, labelHashSet *setPtr) const
 Check face angles. More...
 
bool checkFaceFlatness (const pointField &points, const vectorField &faceCentres, const vectorField &faceAreas, const bool report, const scalar warnFlatness, labelHashSet *setPtr) const
 Check face warpage. More...
 
bool checkConcaveCells (const vectorField &fAreas, const pointField &fCentres, const bool report, labelHashSet *setPtr) const
 Check for concave cells by the planes of faces. More...
 
 primitiveMesh ()
 Construct null. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 Helper: write content for FoamFile IOobject header with optional meta information. More...
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 Helper: write dictionary content for FoamFile header with optional meta information. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 
- Static Protected Attributes inherited from primitiveMesh
static scalar closedThreshold_ = 1.0e-6
 Static data to control mesh checking. More...
 
static scalar aspectThreshold_ = 1000
 Aspect ratio warning threshold. More...
 
static scalar nonOrthThreshold_ = 70
 Non-orthogonality warning threshold in deg. More...
 
static scalar skewThreshold_ = 4
 Skewness warning threshold. More...
 
static scalar planarCosAngle_ = 1.0e-6
 Threshold where faces are considered coplanar. More...
 

Detailed Description

Creates dual of polyMesh.

Every polyMesh point becomes a cell on the dual mesh

Every polyMesh cell and patchFace becomes a point on the dual mesh.

Source files

Definition at line 53 of file polyDualMesh.H.

Constructor & Destructor Documentation

◆ polyDualMesh() [1/3]

polyDualMesh ( const IOobject io)

Construct from IOobject.

Definition at line 1345 of file polyDualMesh.C.

◆ polyDualMesh() [2/3]

polyDualMesh ( const polyMesh mesh,
const labelList featureEdges,
const labelList featurePoints 
)

Construct from polyMesh and list of edges and points to represent.

Feature edge and point labels are in local addressing of a patch over all boundary faces.

Definition at line 1377 of file polyDualMesh.C.

References mesh.

◆ polyDualMesh() [3/3]

polyDualMesh ( const polyMesh mesh,
const scalar  featureCos 
)

Construct from polyMesh and feature edge angle. Uses calcFeatures.

below to determine feature edges and points.

Definition at line 1417 of file polyDualMesh.C.

References mesh.

◆ ~polyDualMesh()

Destructor.

Definition at line 1609 of file polyDualMesh.C.

Member Function Documentation

◆ ClassName()

ClassName ( "polyDualMesh"  )

Runtime type information.

◆ calcFeatures()

void calcFeatures ( const polyMesh mesh,
const scalar  featureCos,
labelList featureEdges,
labelList featurePoints 
)
static

◆ cellPoint()

const labelIOList& cellPoint ( ) const
inline

From polyMesh cell to dual point.

Definition at line 228 of file polyDualMesh.H.

◆ boundaryFacePoint()

const labelIOList& boundaryFacePoint ( ) const
inline

From polyMesh patch face to dual point.

Definition at line 236 of file polyDualMesh.H.


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