faMesh Class Reference

Finite area mesh (used for 2-D non-Euclidian finite area method) defined using a patch of faces on a polyMesh (ie, uindirectPrimitivePatch). More...

Inheritance diagram for faMesh:
Collaboration diagram for faMesh:

Public Types

typedef faMesh Mesh
 The mesh type. More...
 
typedef faBoundaryMesh 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...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 

Public Member Functions

 TypeName ("faMesh")
 Runtime type information. More...
 
 faMesh (const faMesh &)=delete
 No copy construct. More...
 
void operator= (const faMesh &)=delete
 No copy assignment. More...
 
 faMesh (const word &meshName, const polyMesh &, Foam::zero)
 Construct zero-sized from polyMesh. More...
 
 faMesh (const polyMesh &, Foam::zero)
 Construct zero-sized from polyMesh. More...
 
 faMesh (const word &meshName, const polyMesh &, const bool doInit=true)
 Read construct from polyMesh, using its IOobject properties. More...
 
 faMesh (const polyMesh &, const bool doInit=true)
 Read construct from polyMesh, using its IOobject properties. More...
 
 faMesh (const word &meshName, const polyMesh &pMesh, labelList &&faceLabels, IOobjectOption ioOpt)
 Construct from components (face labels) without boundary, using specified read properties. More...
 
 faMesh (const word &meshName, const polyMesh &, labelList &&faceLabels)
 Construct from components (face labels) without boundary, using IOobject properties from polyMesh. More...
 
 faMesh (const polyMesh &, labelList &&faceLabels, IOobjectOption ioOpt)
 Construct from components (face labels) without boundary, using specified read properties. More...
 
 faMesh (const polyMesh &, labelList &&faceLabels)
 Construct from components (face labels) without boundary, using IOobject properties from polyMesh. More...
 
 faMesh (const word &meshName, const faMesh &baseMesh, Foam::zero)
 Construct as copy (for dictionaries) and zero-sized without boundary. More...
 
 faMesh (const faMesh &baseMesh, Foam::zero)
 Construct as copy (for dictionaries) and zero-sized without boundary, using IOobject properties from polyMesh. More...
 
 faMesh (const word &meshName, const faMesh &baseMesh, labelList &&faceLabels, IOobjectOption ioOpt)
 Construct as copy (for dictionaries) and faceLabels without boundary, using specified read properties. More...
 
 faMesh (const faMesh &baseMesh, labelList &&faceLabels, IOobjectOption ioOpt)
 Construct as copy (for dictionaries) and faceLabels without boundary, using specified read properties. More...
 
 faMesh (const word &meshName, const faMesh &baseMesh, labelList &&faceLabels)
 Construct as copy (for dictionaries) and faceLabels without boundary, using IOobject properties from polyMesh. More...
 
 faMesh (const faMesh &baseMesh, labelList &&faceLabels)
 Construct as copy (for dictionaries) and faceLabels without boundary, using read properties from baseMesh. More...
 
 faMesh (const word &meshName, const polyPatch &pp, const bool doInit=true)
 Construct from single polyPatch. More...
 
 faMesh (const polyPatch &pp, const bool doInit=true)
 Construct from single polyPatch. More...
 
 faMesh (const word &meshName, const polyMesh &pMesh, const dictionary &faMeshDefinition, const bool doInit=true)
 Construct from definition. More...
 
 faMesh (const polyMesh &pMesh, const dictionary &faMeshDefinition, const bool doInit=true)
 Construct from definition. More...
 
virtual ~faMesh ()
 Destructor. More...
 
void addFaPatches (faPatchList &plist, const bool validBoundary=true)
 Add boundary patches. Constructor helper. More...
 
void addFaPatches (const List< faPatch *> &p, const bool validBoundary=true)
 Add boundary patches. Constructor helper. More...
 
bool init (const bool doInit)
 Initialise non-demand-driven data etc. More...
 
void syncGeom ()
 Processor/processor synchronisation for geometry fields. More...
 
const polyMeshmesh () const
 Return access to polyMesh. More...
 
fileName meshDir () const
 Return the local mesh directory (dbDir()/meshSubDir) More...
 
const Timetime () const
 Return reference to time. More...
 
const fileNamepointsInstance () const
 Return the current instance directory for points. More...
 
const fileNamefacesInstance () const
 Return the current instance directory for faces. More...
 
const meshStatedata () const
 Const reference to the mesh and solver state data. More...
 
meshStatedata ()
 Reference to the mesh and solver state data. More...
 
label comm () const noexcept
 Return communicator used for parallel communication. More...
 
label & comm () noexcept
 Return communicator used for parallel communication. More...
 
bool hasGlobalData () const noexcept
 Is demand-driven parallel info available? More...
 
const faGlobalMeshDataglobalData () const
 Return parallel info (demand-driven) More...
 
const faSchemeshasSchemes () const
 Non-null if faSchemes exists (can test as bool). More...
 
const faSolutionhasSolution () const
 Non-null if faSolution exists (can test as bool). More...
 
const faSchemesschemes () const
 Read-access to the faSchemes controls. More...
 
faSchemesschemes ()
 Read/write-access to the faSchemes controls. More...
 
const faSolutionsolution () const
 Read-access to the faSolution controls. More...
 
faSolutionsolution ()
 Read/write-access to the faSolution controls. More...
 
label nPoints () const noexcept
 Number of local mesh points. More...
 
label nEdges () const noexcept
 Number of local mesh edges. More...
 
label nInternalEdges () const noexcept
 Number of internal faces. More...
 
label nBoundaryEdges () const noexcept
 Number of boundary edges (== nEdges - nInternalEdges) More...
 
label nFaces () const noexcept
 Number of patch faces. More...
 
const pointFieldpoints () const
 Return local points. More...
 
const edgeListedges () const noexcept
 Return local edges with reordered boundary. More...
 
const edgeList::subList internalEdges () const
 Sub-list of local internal edges. More...
 
const faceListfaces () const
 Return local faces. More...
 
const labelListedgeOwner () const noexcept
 Edge owner addressing. More...
 
const labelListedgeNeighbour () const noexcept
 Edge neighbour addressing. More...
 
bool hasInternalEdgeLabels () const noexcept
 True if the internalEdges use an ordering that does not correspond 1-to-1 with the patch internalEdges. More...
 
virtual bool hasDb () const
 True - thisDb() is a valid registry. More...
 
virtual const objectRegistrythisDb () const
 Reference to the mesh database. More...
 
virtual const fileNamedbDir () const
 Local directory path of the objectRegistry relative to Time with override for the single-region case. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited from base classes. More...
 
const wordregionName () const
 The mesh region name or word::null if polyMesh::defaultRegion. More...
 
const faBoundaryMeshboundary () const noexcept
 Return constant reference to boundary mesh. More...
 
const labelListfaceLabels () const noexcept
 Return the underlying polyMesh face labels. More...
 
label whichFace (const label meshFacei) const
 The area-face corresponding to the mesh-face, -1 if not found. More...
 
const labelListwhichPolyPatches () const
 The polyPatches related to the areaMesh, in sorted order. More...
 
const List< labelPair > & whichPatchFaces () const
 The polyPatch/local-face for each faceLabels() More...
 
virtual const lduAddressinglduAddr () const
 Return ldu addressing. More...
 
virtual lduInterfacePtrsList interfaces () const
 Return a list of pointers for each patch. More...
 
const labelUListowner () const
 Internal face owner. More...
 
const labelUListneighbour () const
 Internal face neighbour. More...
 
bool isInternalEdge (const label edgeIndex) const noexcept
 True if given edge label is internal to the mesh. More...
 
const List< labelPair > & boundaryConnections () const
 List of proc/face for the boundary edge neighbours using primitive patch edge numbering. More...
 
labelList boundaryProcs () const
 Boundary edge neighbour processors (does not include own proc) More...
 
List< labelPairboundaryProcSizes () const
 List of proc/size for the boundary edge neighbour processors (does not include own proc) More...
 
const faMeshBoundaryHaloboundaryHaloMap () const
 Mapping/swapping for boundary halo neighbours. More...
 
const pointFieldhaloFaceCentres () const
 Face centres of boundary halo neighbours. More...
 
const vectorFieldhaloFaceNormals () const
 Face unit-normals of boundary halo neighbours. More...
 
tmp< pointFieldhaloFaceCentres (const label patchi) const
 Face centres of boundary halo neighbours for specified patch. More...
 
tmp< vectorFieldhaloFaceNormals (const label patchi) const
 Face unit-normals of boundary halo neighbours for specified patch. More...
 
labelList faceCells () const
 The volume (owner) cells associated with the area-mesh. 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 hasFaceAreas () const noexcept
 Has face areas: S() More...
 
bool hasAreaCentres () const noexcept
 Has face centres: areaCentres() More...
 
bool hasEdgeCentres () const noexcept
 Has edge centres: edgeCentres() More...
 
bool hasLe () const noexcept
 Has edge length vectors: Le() More...
 
bool hasMagLe () const noexcept
 Has edge length magnitudes: magLe() More...
 
bool hasFaceAreaNormals () const noexcept
 Has face area normals: faceAreaNormals() More...
 
bool hasEdgeAreaNormals () const noexcept
 Has edge area normals: edgeAreaNormals() More...
 
bool hasPointAreaNormals () const noexcept
 Has point area normals: pointAreaNormals() More...
 
bool hasFaceCurvatures () const noexcept
 Has face curvatures: faceCurvatures() More...
 
bool hasPatchPointNormalsCorrection () const noexcept
 Has patch point normals corrections. More...
 
bool moving () const
 Is mesh moving. More...
 
virtual bool movePoints ()
 Update after mesh motion. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update after topo change. More...
 
virtual void mapFields (const faMeshMapper &mapper) const
 Map all fields in time using given map. More...
 
virtual void mapOldAreas (const faMeshMapper &mapper) const
 Map face areas in time using given map. More...
 
const uindirectPrimitivePatchpatch () const
 Return constant reference to primitive patch. More...
 
uindirectPrimitivePatchpatch ()
 Return reference to primitive patch. More...
 
const labelListpatchStarts () const
 Return patch starts. More...
 
const edgeVectorFieldLe () const
 Return edge length vectors. More...
 
const edgeScalarFieldmagLe () const
 Return edge length magnitudes. More...
 
tmp< edgeVectorFieldunitLe () const
 Return normalised edge length vectors. More...
 
const areaVectorFieldareaCentres () const
 Return face centres as areaVectorField. More...
 
const edgeVectorFieldedgeCentres () const
 Return edge centres as edgeVectorField. More...
 
const DimensionedField< scalar, areaMesh > & S () const
 Return face areas. More...
 
const DimensionedField< scalar, areaMesh > & S0 () const
 Return old-time face areas. More...
 
const DimensionedField< scalar, areaMesh > & S00 () const
 Return old-old-time face areas. More...
 
const areaVectorFieldfaceAreaNormals () const
 Return face area normals. More...
 
const edgeVectorFieldedgeAreaNormals () const
 Return edge area normals. More...
 
const vectorFieldpointAreaNormals () const
 Return point area normals. More...
 
const areaScalarFieldfaceCurvatures () const
 Return face curvatures. More...
 
const FieldField< Field, tensor > & edgeTransformTensors () const
 Return edge transformation tensors. More...
 
labelList internalPoints () const
 Return internal point labels. More...
 
labelList boundaryPoints () const
 Return boundary point labels. More...
 
tmp< edgeScalarFieldedgeLengthCorrection () const
 Return edge length correction. More...
 
bool correctPatchPointNormals (const label patchID) const
 Whether point normals should be corrected for a patch. More...
 
boolListcorrectPatchPointNormals () const
 Set whether point normals should be corrected for a patch. More...
 
virtual bool write (const bool writeOnProc=true) const
 Write mesh. More...
 
bool operator!= (const faMesh &m) const
 
bool operator== (const faMesh &m) const
 
void operator() () const =delete
 No call operator. Prior to 2312 was used to obtain polyMesh. More...
 
- Public Member Functions inherited from faMeshRegistry
 faMeshRegistry (const word &areaRegion, const polyMesh &mesh)
 Construct an objectRegistry for given area region name. 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...
 
IOobject newIOobject (const word &name, IOobjectOption ioOpt) const
 Create an IOobject at the current time instance (timeName) with the specified options. More...
 
IOobject newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const
 Create an IOobject at the current time instance (timeName). 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...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
 Write the objects using stream options. 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 object from registry, and remove all file watches. 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...
 
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 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...
 
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, const bool overwrite=false)
 Construct from key/value pairs in initializer list. More...
 
 HashTable (const UList< word > &keys, const UList< regIOobject * > &values, const bool overwrite=false)
 Construct from key/value pairs. 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 lduMesh
 TypeName ("lduMesh")
 Runtime type information. More...
 
virtual ~lduMesh ()=default
 Destructor. More...
 
template<class T , class BinaryOp >
void reduce (T &Value, const BinaryOp &bop) const
 Helper: reduce with current communicator. More...
 
InfoProxy< lduMeshinfo () const noexcept
 Return info proxy, used to print mesh information to a stream. More...
 
- Public Member Functions inherited from faSchemes
 faSchemes (const faSchemes &)=delete
 No copy construct. More...
 
void operator= (const faSchemes &)=delete
 No copy assignment. More...
 
 faSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 faSchemes (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, (system) dictionary name using the readOption from the registry. More...
 
 faSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption with the default dictionary name ("faSchemes"). More...
 
 faSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary &dict)
 Construct for objectRegistry, readOption with the default dictionary name ("faSchemes") and fallback dictionary content. More...
 
 faSchemes (const objectRegistry &obr, const dictionary *fallback=nullptr)
 Construct for objectRegistry with the default dictionary name ("faSchemes"). More...
 
 faSchemes (const objectRegistry &obr, const dictionary &dict)
 Construct for objectRegistry with the default dictionary name ("faSchemes") and fallback dictionary content. More...
 
- Public Member Functions inherited from schemesLookup
 schemesLookup (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 schemesLookup (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, (system) dictionary name using the readOption from the registry. More...
 
bool steady () const noexcept
 True if default ddt scheme is steady-state. More...
 
bool transient () const noexcept
 True if default ddt scheme is not steady-state. More...
 
const dictionaryschemesDict () const
 The entire dictionary or the optional "select" sub-dictionary. More...
 
ITstreamddtScheme (const word &name) const
 Get ddt scheme for given name, or default. More...
 
ITstreamd2dt2Scheme (const word &name) const
 Get d2dt2 scheme for given name, or default. More...
 
ITstreaminterpolationScheme (const word &name) const
 Get interpolation scheme for given name, or default. More...
 
ITstreamdivScheme (const word &name) const
 Get div scheme for given name, or default. More...
 
ITstreamgradScheme (const word &name) const
 Get grad scheme for given name, or default. More...
 
ITstreamlnGradScheme (const word &name) const
 Get (finiteArea) lnGrad scheme for given name, or default. More...
 
ITstreamsnGradScheme (const word &name) const
 Get (finiteVolume) snGrad scheme for given name, or default. More...
 
ITstreamlaplacianScheme (const word &name) const
 Get laplacian scheme for given name, or default. More...
 
void setFluxRequired (const word &name) const
 Set flux-required for given name (mutable) More...
 
bool fluxRequired (const word &name) const
 Get flux-required for given name, or default. More...
 
const dictionaryddtSchemes () const noexcept
 Access ddt schemes dictionary. More...
 
const dictionaryd2dt2Schemes () const noexcept
 Access d2dt2 schemes dictionary. More...
 
const dictionaryinterpolationSchemes () const noexcept
 Access interpolation schemes dictionary. More...
 
const dictionarydivSchemes () const noexcept
 Access div schemes dictionary. More...
 
const dictionarygradSchemes () const noexcept
 Access grad schemes dictionary. More...
 
const dictionarylnGradSchemes () const noexcept
 Access lnGrad schemes dictionary (finiteArea) More...
 
const dictionarysnGradSchemes () const noexcept
 Access snGrad schemes dictionary (finiteVolume) More...
 
const dictionarylaplacianSchemes () const noexcept
 Access laplacian schemes dictionary. More...
 
const dictionaryfluxRequired () const noexcept
 Access flux-required dictionary. More...
 
dictionaryddtSchemes () noexcept
 Access ddt schemes dictionary. More...
 
dictionaryd2dt2Schemes () noexcept
 Access d2dt2 schemes dictionary. More...
 
dictionaryinterpolationSchemes () noexcept
 Access interpolation schemes dictionary. More...
 
dictionarydivSchemes () noexcept
 Access div schemes dictionary. More...
 
dictionarygradSchemes () noexcept
 Access grad schemes dictionary. More...
 
dictionarylnGradSchemes () noexcept
 Access lnGrad schemes dictionary (finiteArea) More...
 
dictionarysnGradSchemes () noexcept
 Access snGrad schemes dictionary (finiteVolume) More...
 
dictionarylaplacianSchemes () noexcept
 Access laplacian schemes dictionary. More...
 
dictionaryfluxRequired () noexcept
 Access flux-required dictionary. More...
 
bool read ()
 Read schemes from IOdictionary, respects the "select" keyword. More...
 
void writeDicts (Ostream &os) const
 Write dictionary (possibly modified) settings. More...
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 Construct given an IOobject and optional fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 Construct given an IOobject and fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 Construct given an IOobject, wanted typeName and optional fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()=default
 Destructor. More...
 
virtual bool global () const
 The object is global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists either in the case/processor or case otherwise null. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 Declare type-name, virtual type (with debug switch) More...
 
 baseIOdictionary (const baseIOdictionary &)=default
 Copy construct. More...
 
 baseIOdictionary (baseIOdictionary &&)=default
 Move construct. More...
 
virtual ~baseIOdictionary ()=default
 Destructor. More...
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 Construct given an IOobject and optional fallback dictionary content (ununsed) More...
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 Construct given an IOobject and fallback dictionary content (ununsed) More...
 
 baseIOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream (ununsed) More...
 
const wordname () const
 Name function is needed to disambiguate those inherited from regIOobject and dictionary. More...
 
virtual bool readData (Istream &)
 The readData function required by regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 The writeData function required by regIOobject write operation. More...
 
void operator= (const baseIOdictionary &rhs)
 Copy assignment of dictionary entries (leave regIOobject untouched) More...
 
void operator= (const dictionary &rhs)
 Copy assignment of dictionary entries. More...
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Default construct, a top-level empty dictionary. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header. More...
 
 dictionary (Istream &is)
 Construct top-level dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
 dictionary (Istream &is, bool keepHeader)
 Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header. More...
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const noexcept
 The dictionary name. More...
 
fileNamename () noexcept
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) More...
 
fileName relativeName (const bool caseTag=false) const
 The dictionary name relative to the case. More...
 
bool isNullDict () const noexcept
 The dictionary is actually dictionary::null (root dictionary) More...
 
const dictionaryparent () const noexcept
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find an entry (non-const access) with the given keyword. More...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr. More...
 
ITstreamfindStream (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return an entry stream if present (and it is a stream) otherwise return nullptr. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return an entry data stream. FatalIOError if not found, or not a stream. More...
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect. More...
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 Find and return a sub-dictionary as a copy, otherwise return an empty dictionary. More...
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place. More...
 
bool read (Istream &is)
 Read dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream (optionally keeping the header) Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
void writeEntry (Ostream &os) const
 Write sub-dictionary with its dictName as its header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option matchOpt)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
 Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed. More...
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
 Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed. More...
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return an entry data stream, using any compatibility names if needed. More...
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens. More...
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value using any compatibility names if needed. More...
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens. More...
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens. More...
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Check for existence of a sub-dictionary. Generally prefer findDict() for more flexibility. More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Same as getOrDefault() More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 Same as getOrAdd() More...
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) - use lookup() method. More...
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 Deprecated(2018-10) More...
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const dictionarysubDictPtr (const word &keyword) const
 Deprecated(2018-10) More...
 
dictionarysubDictPtr (const word &keyword)
 Deprecated(2018-10) Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 Deprecated(2018-10) More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 Deprecated(2018-10) find and return a T. More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Default construct. More...
 
 ILList (T *item)
 Construct and add initial item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. Calls clear() More...
 
void clear ()
 Clear the contents of the list. More...
 
void pop_front (label n=1)
 Remove first element(s) from the list (deletes pointers) More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void transfer (ILList< LListBase, T > &lst)
 Transfer the contents of the argument into this List and annul the argument list. More...
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()=default
 Default construct. More...
 
 UILList (T *item)
 Construct and add initial item pointer. More...
 
 UILList (const UILList< LListBase, T > &list)
 Construct as copy. More...
 
Tfront ()
 The first entry in the list. More...
 
const Tfront () const
 The first entry in the list (const access) More...
 
Tback ()
 The last entry in the list. More...
 
const Tback () const
 The last entry in the list (const access) More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *item)
 Remove and return element. More...
 
Tremove (iterator &iter)
 Remove and return item specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &lst)
 Copy assignment. More...
 
bool operator== (const UILList< LListBase, T > &lst) const
 Equality. True both lists are element-wise equal. More...
 
bool operator!= (const UILList< LListBase, T > &lst) const
 The opposite of the equality operation. Takes linear time. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write UILList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) More...
 
- Public Member Functions inherited from faSolution
 faSolution (const faSolution &)=delete
 No copy construct. More...
 
void operator= (const faSolution &)=delete
 No copy assignment. More...
 
 faSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 faSolution (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, (system) dictionary name using the readOption from the registry. More...
 
 faSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption with the default dictionary name ("faSolution"). More...
 
 faSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary &dict)
 Construct for objectRegistry, readOption with the default dictionary name ("faSolution") and fallback dictionary content. More...
 
 faSolution (const objectRegistry &obr, const dictionary *fallback=nullptr)
 Construct for objectRegistry with the default dictionary name ("faSolution"). More...
 
 faSolution (const objectRegistry &obr, const dictionary &dict)
 Construct for objectRegistry with the default dictionary name ("faSolution") and optional contents. More...
 
- Public Member Functions inherited from solution
 solution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const fileName &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 solution (const objectRegistry &obr, const fileName &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, (system) dictionary name using the readOption from the registry. More...
 
virtual ~solution ()
 Destructor. Non-default in header (incomplete types) More...
 
bool cache (const word &name) const
 True if the given field should be cached. More...
 
bool relaxField (const word &name) const
 True if the relaxation factor is given for the field. More...
 
bool relaxField (const word &name, scalar &factor) const
 Get the relaxation factor specified for the field or the specified "default" entry, if present. Does not change factor if neither direct nor "default" can be used,. More...
 
bool relaxEquation (const word &name) const
 True if the relaxation factor is given for the equation. More...
 
bool relaxEquation (const word &name, scalar &factor) const
 Get the relaxation factor specified for the equation or the specified "default" entry, if present. Does not change factor if neither direct nor "default" can be used,. More...
 
scalar fieldRelaxationFactor (const word &name) const
 Get the relaxation factor for the given field. Fatal if not found. More...
 
scalar equationRelaxationFactor (const word &name) const
 Get the relaxation factor for the given equation. Fatal if not found. More...
 
const dictionarysolutionDict () const
 The entire dictionary or the optional "select" sub-dictionary. More...
 
const dictionarysolutionDict (const word &name) const
 Return name sub-dictionary within the solutionDict(). More...
 
const dictionarysolversDict () const
 The solver controls dictionary (all fields) More...
 
const dictionarysolverDict (const word &name) const
 The solver controls dictionary for the given field. Same as solversDict().subDict(...) More...
 
const dictionarysolver (const word &name) const
 The solver controls dictionary for the given field. Same as solverDict(...) More...
 
bool read ()
 Read the solution dictionary. More...
 
- Public Member Functions inherited from edgeInterpolation
 ClassName ("edgeInterpolation")
 
 edgeInterpolation (const edgeInterpolation &)=delete
 No copy construct. More...
 
void operator= (const edgeInterpolation &)=delete
 No copy assignment. More...
 
 edgeInterpolation (const faMesh &)
 Construct given an faMesh. More...
 
 ~edgeInterpolation ()=default
 Destructor. More...
 
const faMeshmesh () const noexcept
 Return mesh reference. More...
 
const edgeScalarFieldlPN () const
 Return reference to PN geodesic distance. More...
 
const edgeScalarFieldweights () const
 Return reference to weighting factors array. More...
 
const edgeScalarFielddeltaCoeffs () const
 Return reference to difference factors array. More...
 
const edgeVectorFieldcorrectionVectors () const
 Return reference to non-orthogonality correction vectors array. More...
 
const edgeVectorFieldskewCorrectionVectors () const
 Return reference to skew vectors array. More...
 
bool orthogonal () const
 Return whether mesh is orthogonal or not. More...
 
bool skew () const
 Return whether mesh is skew or not. More...
 
bool movePoints () const
 Do what is necessary if the mesh has moved. More...
 
bool hasWeights () const noexcept
 True if weights exist. More...
 

Static Public Member Functions

static const wordprefix () noexcept
 The prefix to the parent registry name: finite-area. More...
 
static int geometryOrder () noexcept
 Return the current geometry treatment. More...
 
static int geometryOrder (int order) noexcept
 Set the preferred geometry treatment. More...
 
static autoPtr< faMeshTryNew (const word &meshName, const polyMesh &pMesh)
 Read construction from polyMesh if all files are available. More...
 
static autoPtr< faMeshTryNew (const polyMesh &pMesh)
 Read construction from polyMesh if all files are available. More...
 
static const objectRegistryregistry (const polyMesh &pMesh)
 The parent registry containing all finite-area meshes on the polyMesh. More...
 
static const faMeshmesh (const polyMesh &pMesh)
 The single-region finite-area region on the polyMesh. Uses lookupObject semantics - Fatal if non-existent. More...
 
static const faMeshmesh (const polyMesh &, const word &areaRegion)
 The single-region or specified finite-area region on the polyMesh. Uses lookupObject semantics - Fatal if non-existent. More...
 
static fileName dbDir (const word &areaRegion)
 Local registry directory path (relative to Time) for specified area mesh (of a single-region volume mesh) More...
 
static fileName dbDir (const word &volRegion, const word &areaRegion)
 Local registry directory path (relative to Time) for specified volume mesh and area mesh combination. More...
 
static fileName dbDir (const polyMesh &pMesh, const word &areaRegion=word::null)
 Local registry directory path (relative to Time) for specified volume mesh and area mesh combination. More...
 
static fileName meshDir (const word &areaRegion)
 The local mesh directory name (eg, "faMesh") for specified area mesh (of a single-region volume mesh) More...
 
static fileName meshDir (const word &volRegion, const word &areaRegion)
 The local mesh directory name (eg, "faMesh") for specified volume mesh and area mesh combination. More...
 
static fileName meshDir (const polyMesh &pMesh, const word &areaRegion=word::null)
 The local mesh directory name (eg, "faMesh") for specified volume mesh and area mesh combination. 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 (std::unique_ptr< 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 (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 IOdictionary
static dictionary readContents (const IOobject &io)
 Read and return contents, testing for "dictionary" type. The IOobject will not be registered. More...
 
static dictionary readContents (const IOobject &io, const word &wantedType)
 Read and return contents, testing for expected type. The IOobject will not be registered. More...
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 Return the state of reporting optional (default) entries. More...
 
static int reportOptional (const int level) noexcept
 Change the state of reporting optional (default) entries. More...
 
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 
- Static Public Member Functions inherited from solution
static label upgradeSolverDict (dictionary &dict, const bool verbose=true)
 Update from older solver controls syntax. More...
 
template<class FieldType >
static void cachePrintMessage (const char *message, const word &name, const FieldType &fld)
 Helper for printing cache message. More...
 

Static Public Attributes

static int geometryOrder_
 Geometry treatment. More...
 
static word meshSubDir
 The mesh sub-directory name (usually "faMesh") 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 schemesLookup
static int debug
 Debug switch. More...
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 Report optional keywords and values if not present in dictionary. More...
 
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
static refPtr< OSstreamreportingOutput
 Output location when reporting default values. More...
 
- Static Public Attributes inherited from solution
static int debug
 Debug switch (registered name: "solution") More...
 

Additional Inherited Members

- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- 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...
 
- 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...
 

Detailed Description

Finite area mesh (used for 2-D non-Euclidian finite area method) defined using a patch of faces on a polyMesh (ie, uindirectPrimitivePatch).

The ordering of faces and points on the faMesh corresponds to the localFaces and localPoints as per Foam::PrimitivePatch but the edge addressing is handled slightly differently. The internal edges of the faMesh will generally correspond identically to the internalEdges of the PrimitivePatch (may change in the future) but the boundaryEdges will be reordered compared to the PrimitivePatch to allow edge boundary slices to be obtained.

Source files
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Definition at line 133 of file faMesh.H.

Member Typedef Documentation

◆ Mesh

typedef faMesh Mesh

The mesh type.

Definition at line 721 of file faMesh.H.

◆ BoundaryMesh

The boundary type associated with the mesh.

Definition at line 726 of file faMesh.H.

Constructor & Destructor Documentation

◆ faMesh() [1/19]

faMesh ( const faMesh )
delete

No copy construct.

◆ faMesh() [2/19]

faMesh ( const word meshName,
const polyMesh pMesh,
Foam::zero   
)

Construct zero-sized from polyMesh.

Boundary is added using addFaPatches() member function

Definition at line 445 of file faMesh.C.

◆ faMesh() [3/19]

faMesh ( const polyMesh pMesh,
Foam::zero   
)

Construct zero-sized from polyMesh.

Boundary is added using addFaPatches() member function

Definition at line 456 of file faMesh.C.

◆ faMesh() [4/19]

faMesh ( const word meshName,
const polyMesh pMesh,
const bool  doInit = true 
)

◆ faMesh() [5/19]

faMesh ( const polyMesh pMesh,
const bool  doInit = true 
)
explicit

Read construct from polyMesh, using its IOobject properties.

Definition at line 465 of file faMesh.C.

◆ faMesh() [6/19]

faMesh ( const word meshName,
const polyMesh pMesh,
labelList &&  faceLabels,
IOobjectOption  ioOpt 
)

Construct from components (face labels) without boundary, using specified read properties.

Boundary is added using addFaPatches() member function.

Definition at line 735 of file faMesh.C.

◆ faMesh() [7/19]

faMesh ( const word meshName,
const polyMesh pMesh,
labelList &&  faceLabels 
)

Construct from components (face labels) without boundary, using IOobject properties from polyMesh.

Boundary is added using addFaPatches() member function.

Definition at line 676 of file faMesh.C.

◆ faMesh() [8/19]

faMesh ( const polyMesh pMesh,
labelList &&  faceLabels,
IOobjectOption  ioOpt 
)

Construct from components (face labels) without boundary, using specified read properties.

Boundary is added using addFaPatches() member function.

Definition at line 526 of file faMesh.C.

◆ faMesh() [9/19]

faMesh ( const polyMesh pMesh,
labelList &&  faceLabels 
)

Construct from components (face labels) without boundary, using IOobject properties from polyMesh.

Boundary is added using addFaPatches() member function.

Definition at line 543 of file faMesh.C.

◆ faMesh() [10/19]

faMesh ( const word meshName,
const faMesh baseMesh,
Foam::zero   
)

Construct as copy (for dictionaries) and zero-sized without boundary.

Boundary is added using addFaPatches() member function

Definition at line 472 of file faMesh.C.

◆ faMesh() [11/19]

faMesh ( const faMesh baseMesh,
Foam::zero   
)

Construct as copy (for dictionaries) and zero-sized without boundary, using IOobject properties from polyMesh.

Boundary is added using addFaPatches() member function

Definition at line 483 of file faMesh.C.

◆ faMesh() [12/19]

faMesh ( const word meshName,
const faMesh baseMesh,
labelList &&  faceLabels,
IOobjectOption  ioOpt 
)

Construct as copy (for dictionaries) and faceLabels without boundary, using specified read properties.

Boundary is added using addFaPatches() member function

Definition at line 798 of file faMesh.C.

◆ faMesh() [13/19]

faMesh ( const faMesh baseMesh,
labelList &&  faceLabels,
IOobjectOption  ioOpt 
)

Construct as copy (for dictionaries) and faceLabels without boundary, using specified read properties.

Boundary is added using addFaPatches() member function

◆ faMesh() [14/19]

faMesh ( const word meshName,
const faMesh baseMesh,
labelList &&  faceLabels 
)

Construct as copy (for dictionaries) and faceLabels without boundary, using IOobject properties from polyMesh.

Boundary is added using addFaPatches() member function

Definition at line 493 of file faMesh.C.

◆ faMesh() [15/19]

faMesh ( const faMesh baseMesh,
labelList &&  faceLabels 
)

Construct as copy (for dictionaries) and faceLabels without boundary, using read properties from baseMesh.

Boundary is added using addFaPatches() member function

Definition at line 510 of file faMesh.C.

◆ faMesh() [16/19]

faMesh ( const word meshName,
const polyPatch pp,
const bool  doInit = true 
)

Construct from single polyPatch.

Definition at line 859 of file faMesh.C.

References DebugInFunction, Foam::endl(), faMesh::init(), and pp().

Here is the call graph for this function:

◆ faMesh() [17/19]

faMesh ( const polyPatch pp,
const bool  doInit = true 
)
explicit

Construct from single polyPatch.

Definition at line 553 of file faMesh.C.

◆ faMesh() [18/19]

faMesh ( const word meshName,
const polyMesh pMesh,
const dictionary faMeshDefinition,
const bool  doInit = true 
)

◆ faMesh() [19/19]

faMesh ( const polyMesh pMesh,
const dictionary faMeshDefinition,
const bool  doInit = true 
)

Construct from definition.

Definition at line 563 of file faMesh.C.

◆ ~faMesh()

~faMesh ( )
virtual

Destructor.

Definition at line 966 of file faMesh.C.

Member Function Documentation

◆ TypeName()

TypeName ( "faMesh"  )

Runtime type information.

◆ prefix()

const Foam::word & prefix ( )
staticnoexcept

The prefix to the parent registry name: finite-area.

Definition at line 66 of file faMesh.C.

Referenced by faMesh::dbDir(), faMesh::meshDir(), faMesh::registry(), and sensitivitySurface::smoothSensitivities().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const faMesh )
delete

No copy assignment.

◆ geometryOrder() [1/2]

static int geometryOrder ( )
inlinestaticnoexcept

Return the current geometry treatment.

A zero level or negative is with restricted neighbour information

Definition at line 944 of file faMesh.H.

References faMesh::geometryOrder_.

◆ geometryOrder() [2/2]

static int geometryOrder ( int  order)
inlinestaticnoexcept

Set the preferred geometry treatment.

Returns
the previous value

Definition at line 954 of file faMesh.H.

References faMesh::geometryOrder_.

◆ TryNew() [1/2]

Foam::autoPtr< Foam::faMesh > TryNew ( const word meshName,
const polyMesh pMesh 
)
static

Read construction from polyMesh if all files are available.

Definition at line 188 of file faMeshNew.C.

References autoPtr< T >::New().

Referenced by sensitivitySurface::smoothSensitivities().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TryNew() [2/2]

Foam::autoPtr< Foam::faMesh > TryNew ( const polyMesh pMesh)
static

Read construction from polyMesh if all files are available.

Definition at line 203 of file faMeshNew.C.

References polyMesh::defaultRegion.

◆ addFaPatches() [1/2]

void addFaPatches ( faPatchList plist,
const bool  validBoundary = true 
)

Add boundary patches. Constructor helper.

Definition at line 68 of file faMeshPatches.C.

References Foam::abort(), boundary, Foam::FatalError, and FatalErrorInFunction.

Referenced by faMeshDecomposition::writeDecomposition().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addFaPatches() [2/2]

void addFaPatches ( const List< faPatch *> &  p,
const bool  validBoundary = true 
)

Add boundary patches. Constructor helper.

Definition at line 94 of file faMeshPatches.C.

References p.

◆ init()

bool init ( const bool  doInit)

Initialise non-demand-driven data etc.

Definition at line 417 of file faMesh.C.

References UPstream::parRun().

Referenced by faMesh::faMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ syncGeom()

void syncGeom ( )

Processor/processor synchronisation for geometry fields.

Largely internal use only (slightly hacky).

Definition at line 396 of file faMesh.C.

References UPstream::parRun().

Here is the call graph for this function:

◆ registry()

const Foam::objectRegistry * registry ( const polyMesh pMesh)
static

The parent registry containing all finite-area meshes on the polyMesh.

Definition at line 145 of file faMesh.C.

References objectRegistry::cfindObject(), and faMesh::prefix().

Referenced by faMesh::mesh(), and areaWrite::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh() [1/3]

const Foam::faMesh & mesh ( const polyMesh pMesh)
static

The single-region finite-area region on the polyMesh. Uses lookupObject semantics - Fatal if non-existent.

Definition at line 158 of file faMesh.C.

References polyMesh::defaultRegion, and faMesh::mesh().

Referenced by faMeshDistributor::distribute(), and wedgeFaPatch::wedgeFaPatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh() [2/3]

const Foam::faMesh & mesh ( const polyMesh pMesh,
const word areaRegion 
)
static

The single-region or specified finite-area region on the polyMesh. Uses lookupObject semantics - Fatal if non-existent.

Definition at line 167 of file faMesh.C.

References polyMesh::defaultRegion, objectRegistry::lookupObject(), faMesh::registry(), and polyMesh::thisDb().

Here is the call graph for this function:

◆ mesh() [3/3]

const Foam::polyMesh & mesh ( ) const

Return access to polyMesh.

Definition at line 1010 of file faMesh.C.

References objectRegistry::parent().

Referenced by faMesh::data(), faMesh::mesh(), and faMesh::moving().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ meshDir() [1/4]

Foam::fileName meshDir ( ) const

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

Definition at line 1016 of file faMesh.C.

References faMesh::meshSubDir.

Referenced by faMesh::meshDir(), and faMeshTools::newMesh().

Here is the caller graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return reference to time.

Definition at line 1022 of file faMesh.C.

References objectRegistry::time().

Here is the call graph for this function:

◆ pointsInstance()

const Foam::fileName & pointsInstance ( ) const

Return the current instance directory for points.

Used in the construction of geometric mesh data dependent on points

Definition at line 1028 of file faMesh.C.

References mesh, and polyMesh::pointsInstance().

Here is the call graph for this function:

◆ facesInstance()

const Foam::fileName & facesInstance ( ) const

Return the current instance directory for faces.

Definition at line 1034 of file faMesh.C.

References polyMesh::facesInstance(), and mesh.

Here is the call graph for this function:

◆ data() [1/2]

const meshState& data ( ) const
inline

Const reference to the mesh and solver state data.

Definition at line 1062 of file faMesh.H.

References polyMesh::data(), and faMesh::mesh().

Here is the call graph for this function:

◆ data() [2/2]

meshState& data ( )
inline

Reference to the mesh and solver state data.

Definition at line 1067 of file faMesh.H.

References faMesh::data(), and faMesh::mesh().

Referenced by faMesh::data().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ comm() [1/2]

label comm ( ) const
inlinevirtualnoexcept

Return communicator used for parallel communication.

Implements lduMesh.

Definition at line 1075 of file faMesh.H.

◆ comm() [2/2]

label& comm ( )
inlinenoexcept

Return communicator used for parallel communication.

Definition at line 1080 of file faMesh.H.

◆ hasGlobalData()

bool hasGlobalData ( ) const
noexcept

Is demand-driven parallel info available?

Definition at line 1246 of file faMesh.C.

◆ globalData()

const Foam::faGlobalMeshData & globalData ( ) const

Return parallel info (demand-driven)

Definition at line 1252 of file faMesh.C.

Referenced by faMesh::updateMesh().

Here is the caller graph for this function:

◆ hasSchemes()

const Foam::faSchemes * hasSchemes ( ) const

Non-null if faSchemes exists (can test as bool).

Definition at line 974 of file faMesh.C.

◆ hasSolution()

const Foam::faSolution * hasSolution ( ) const

Non-null if faSolution exists (can test as bool).

Definition at line 980 of file faMesh.C.

◆ schemes() [1/2]

const Foam::faSchemes & schemes ( ) const

Read-access to the faSchemes controls.

Definition at line 986 of file faMesh.C.

◆ schemes() [2/2]

Foam::faSchemes & schemes ( )

Read/write-access to the faSchemes controls.

Definition at line 992 of file faMesh.C.

◆ solution() [1/2]

const Foam::faSolution & solution ( ) const

Read-access to the faSolution controls.

Definition at line 998 of file faMesh.C.

◆ solution() [2/2]

Read/write-access to the faSolution controls.

Definition at line 1004 of file faMesh.C.

◆ nPoints()

Foam::label nPoints ( ) const
inlinenoexcept

Number of local mesh points.

Definition at line 30 of file faMeshI.H.

Referenced by Foam::createReconstructMap(), and faMeshDecomposition::writeDecomposition().

Here is the caller graph for this function:

◆ nEdges()

Foam::label nEdges ( ) const
inlinenoexcept

Number of local mesh edges.

Definition at line 36 of file faMeshI.H.

Referenced by Foam::createReconstructMap().

Here is the caller graph for this function:

◆ nInternalEdges()

Foam::label nInternalEdges ( ) const
inlinenoexcept

Number of internal faces.

Definition at line 42 of file faMeshI.H.

Referenced by faMesh::updateMesh().

Here is the caller graph for this function:

◆ nBoundaryEdges()

Foam::label nBoundaryEdges ( ) const
inlinenoexcept

Number of boundary edges (== nEdges - nInternalEdges)

Definition at line 48 of file faMeshI.H.

Referenced by faMesh::updateMesh().

Here is the caller graph for this function:

◆ nFaces()

Foam::label nFaces ( ) const
inlinenoexcept

Number of patch faces.

Definition at line 54 of file faMeshI.H.

Referenced by injectionModelList::correct(), Foam::createReconstructMap(), and faMeshDecomposition::writeDecomposition().

Here is the caller graph for this function:

◆ points()

const Foam::pointField & points ( ) const
inline

Return local points.

Definition at line 60 of file faMeshI.H.

References Foam::foamVersion::patch.

◆ edges()

const Foam::edgeList & edges ( ) const
inlinenoexcept

Return local edges with reordered boundary.

Definition at line 66 of file faMeshI.H.

◆ internalEdges()

const Foam::edgeList::subList internalEdges ( ) const
inline

Sub-list of local internal edges.

Definition at line 72 of file faMeshI.H.

◆ faces()

const Foam::faceList & faces ( ) const
inline

Return local faces.

Definition at line 78 of file faMeshI.H.

References Foam::foamVersion::patch.

◆ edgeOwner()

const Foam::labelList & edgeOwner ( ) const
inlinenoexcept

Edge owner addressing.

Definition at line 84 of file faMeshI.H.

◆ edgeNeighbour()

const Foam::labelList & edgeNeighbour ( ) const
inlinenoexcept

Edge neighbour addressing.

Definition at line 90 of file faMeshI.H.

◆ hasInternalEdgeLabels()

bool hasInternalEdgeLabels ( ) const
inlinenoexcept

True if the internalEdges use an ordering that does not correspond 1-to-1 with the patch internalEdges.

Definition at line 148 of file faMeshI.H.

Referenced by faMeshDistributor::distribute().

Here is the caller graph for this function:

◆ hasDb()

virtual bool hasDb ( ) const
inlinevirtual

True - thisDb() is a valid registry.

Reimplemented from faMeshRegistry.

Definition at line 1198 of file faMesh.H.

◆ thisDb()

virtual const objectRegistry& thisDb ( ) const
inlinevirtual

Reference to the mesh database.

Reimplemented from faMeshRegistry.

Definition at line 1203 of file faMesh.H.

References faMeshRegistry::thisDb().

Referenced by faMesh::edgeLengthCorrection(), faMesh::faMesh(), faMeshMapper::thisDb(), faMesh::unitLe(), faMeshDecomposition::writeDecomposition(), and faMeshTools::writeProcAddressing().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dbDir() [1/4]

virtual const fileName& dbDir ( ) const
inlinevirtual

Local directory path of the objectRegistry relative to Time with override for the single-region case.

Reimplemented from faMeshRegistry.

Definition at line 1212 of file faMesh.H.

References faMeshRegistry::dbDir().

Referenced by faMesh::dbDir().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ name()

const word& name ( ) const
inline

Name function is needed to disambiguate those inherited from base classes.

Definition at line 1221 of file faMesh.H.

References IOobject::name(), and faMeshRegistry::thisDb().

Here is the call graph for this function:

◆ dbDir() [2/4]

Foam::fileName dbDir ( const word areaRegion)
static

Local registry directory path (relative to Time) for specified area mesh (of a single-region volume mesh)

Definition at line 72 of file faMesh.C.

References polyMesh::defaultRegion, and faMesh::prefix().

Here is the call graph for this function:

◆ dbDir() [3/4]

Foam::fileName dbDir ( const word volRegion,
const word areaRegion 
)
static

Local registry directory path (relative to Time) for specified volume mesh and area mesh combination.

Definition at line 84 of file faMesh.C.

References faMesh::prefix(), and polyMesh::regionName().

Here is the call graph for this function:

◆ dbDir() [4/4]

Foam::fileName dbDir ( const polyMesh pMesh,
const word areaRegion = word::null 
)
static

Local registry directory path (relative to Time) for specified volume mesh and area mesh combination.

Definition at line 99 of file faMesh.C.

References faMesh::dbDir(), and polyMesh::regionName().

Here is the call graph for this function:

◆ meshDir() [2/4]

Foam::fileName meshDir ( const word areaRegion)
static

The local mesh directory name (eg, "faMesh") for specified area mesh (of a single-region volume mesh)

Definition at line 108 of file faMesh.C.

References polyMesh::defaultRegion, and faMesh::meshSubDir.

◆ meshDir() [3/4]

Foam::fileName meshDir ( const word volRegion,
const word areaRegion 
)
static

The local mesh directory name (eg, "faMesh") for specified volume mesh and area mesh combination.

Definition at line 120 of file faMesh.C.

References faMesh::meshSubDir, faMesh::prefix(), and polyMesh::regionName().

Here is the call graph for this function:

◆ meshDir() [4/4]

Foam::fileName meshDir ( const polyMesh pMesh,
const word areaRegion = word::null 
)
static

The local mesh directory name (eg, "faMesh") for specified volume mesh and area mesh combination.

Definition at line 136 of file faMesh.C.

References faMesh::meshDir(), and polyMesh::regionName().

Here is the call graph for this function:

◆ regionName()

const Foam::word & regionName ( ) const

The mesh region name or word::null if polyMesh::defaultRegion.

Definition at line 1040 of file faMesh.C.

References IOobject::name(), and polyMesh::regionName().

Here is the call graph for this function:

◆ boundary()

const Foam::faBoundaryMesh & boundary ( ) const
inlinenoexcept

Return constant reference to boundary mesh.

Definition at line 24 of file faMeshI.H.

Referenced by Foam::createReconstructMap(), faMeshDistributor::distribute(), faMesh::interfaces(), faFieldDecomposer::reset(), faMeshDecomposition::writeDecomposition(), and faMeshReconstructor::writeMesh().

Here is the caller graph for this function:

◆ faceLabels()

const Foam::labelList & faceLabels ( ) const
inlinenoexcept

Return the underlying polyMesh face labels.

Definition at line 96 of file faMeshI.H.

Referenced by faMeshDistributor::distribute().

Here is the caller graph for this function:

◆ whichFace()

Foam::label whichFace ( const label  meshFacei) const
inline

The area-face corresponding to the mesh-face, -1 if not found.

Definition at line 122 of file faMeshI.H.

◆ whichPolyPatches()

const Foam::labelList & whichPolyPatches ( ) const
inline

The polyPatches related to the areaMesh, in sorted order.

Definition at line 128 of file faMeshI.H.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), liquidFilmBase::Up(), and liquidFilmBase::Uw().

Here is the caller graph for this function:

◆ whichPatchFaces()

const Foam::List< Foam::labelPair > & whichPatchFaces ( ) const
inline

The polyPatch/local-face for each faceLabels()

Definition at line 138 of file faMeshI.H.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), and injectionModelList::correct().

Here is the caller graph for this function:

◆ lduAddr()

const Foam::lduAddressing & lduAddr ( ) const
virtual

Return ldu addressing.

Implements lduMesh.

Definition at line 1263 of file faMesh.C.

Referenced by faMesh::neighbour(), and faMesh::owner().

Here is the caller graph for this function:

◆ interfaces()

virtual lduInterfacePtrsList interfaces ( ) const
inlinevirtual

Return a list of pointers for each patch.

with only those pointing to interfaces being set

Implements lduMesh.

Definition at line 1316 of file faMesh.H.

References faMesh::boundary(), and faBoundaryMesh::interfaces().

Here is the call graph for this function:

◆ owner()

const labelUList& owner ( ) const
inline

Internal face owner.

Definition at line 1324 of file faMesh.H.

References faMesh::lduAddr(), and lduAddressing::lowerAddr().

Referenced by contactAngleForce::correct().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ neighbour()

const labelUList& neighbour ( ) const
inline

Internal face neighbour.

Definition at line 1332 of file faMesh.H.

References faMesh::lduAddr(), and lduAddressing::upperAddr().

Referenced by contactAngleForce::correct().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isInternalEdge()

bool isInternalEdge ( const label  edgeIndex) const
inlinenoexcept

True if given edge label is internal to the mesh.

Definition at line 1340 of file faMesh.H.

◆ boundaryConnections()

const Foam::List< Foam::labelPair > & boundaryConnections ( ) const
inline

List of proc/face for the boundary edge neighbours using primitive patch edge numbering.

Definition at line 155 of file faMeshI.H.

◆ boundaryProcs()

Foam::labelList boundaryProcs ( ) const

Boundary edge neighbour processors (does not include own proc)

Definition at line 937 of file faMeshTopology.C.

References HashTable< T, Key, Hash >::erase(), HashSet< Key, Hash >::insert(), UPstream::myProcNo(), UPstream::nProcs(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ boundaryProcSizes()

Foam::List< Foam::labelPair > boundaryProcSizes ( ) const

List of proc/size for the boundary edge neighbour processors (does not include own proc)

Definition at line 955 of file faMeshTopology.C.

References Foam::BitOps::count(), HashTable< T, Key, Hash >::erase(), UPstream::myProcNo(), UPstream::nProcs(), Foam::output(), HashTable< T, Key, Hash >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ boundaryHaloMap()

const Foam::faMeshBoundaryHalo & boundaryHaloMap ( ) const

Mapping/swapping for boundary halo neighbours.

Definition at line 982 of file faMeshTopology.C.

◆ haloFaceCentres() [1/2]

const Foam::pointField & haloFaceCentres ( ) const

Face centres of boundary halo neighbours.

Definition at line 1043 of file faMeshTopology.C.

◆ haloFaceNormals() [1/2]

const Foam::vectorField & haloFaceNormals ( ) const

Face unit-normals of boundary halo neighbours.

Definition at line 1055 of file faMeshTopology.C.

◆ haloFaceCentres() [2/2]

Foam::tmp< Foam::pointField > haloFaceCentres ( const label  patchi) const

Face centres of boundary halo neighbours for specified patch.

Definition at line 1068 of file faMeshTopology.C.

References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, tmp< T >::New(), Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ haloFaceNormals() [2/2]

Foam::tmp< Foam::vectorField > haloFaceNormals ( const label  patchi) const

Face unit-normals of boundary halo neighbours for specified patch.

Definition at line 1093 of file faMeshTopology.C.

References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, tmp< T >::New(), Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ faceCells()

The volume (owner) cells associated with the area-mesh.

Definition at line 1046 of file faMesh.C.

References polyMesh::faceOwner(), and mesh.

Here is the call graph for this function:

◆ removeFiles() [1/2]

void removeFiles ( const fileName instanceDir) const

Remove all files from mesh instance.

Definition at line 1062 of file faMesh.C.

References fileName::path(), and Foam::rm().

Here is the call graph for this function:

◆ removeFiles() [2/2]

void removeFiles ( ) const

Remove all files from mesh instance()

Definition at line 1071 of file faMesh.C.

◆ hasFaceAreas()

bool hasFaceAreas ( ) const
inlinenoexcept

Has face areas: S()

Definition at line 1413 of file faMesh.H.

◆ hasAreaCentres()

bool hasAreaCentres ( ) const
inlinenoexcept

Has face centres: areaCentres()

Definition at line 1418 of file faMesh.H.

◆ hasEdgeCentres()

bool hasEdgeCentres ( ) const
inlinenoexcept

Has edge centres: edgeCentres()

Definition at line 1423 of file faMesh.H.

◆ hasLe()

bool hasLe ( ) const
inlinenoexcept

Has edge length vectors: Le()

Definition at line 1428 of file faMesh.H.

◆ hasMagLe()

bool hasMagLe ( ) const
inlinenoexcept

Has edge length magnitudes: magLe()

Definition at line 1433 of file faMesh.H.

◆ hasFaceAreaNormals()

bool hasFaceAreaNormals ( ) const
inlinenoexcept

Has face area normals: faceAreaNormals()

Definition at line 1438 of file faMesh.H.

◆ hasEdgeAreaNormals()

bool hasEdgeAreaNormals ( ) const
inlinenoexcept

Has edge area normals: edgeAreaNormals()

Definition at line 1446 of file faMesh.H.

◆ hasPointAreaNormals()

bool hasPointAreaNormals ( ) const
inlinenoexcept

Has point area normals: pointAreaNormals()

Definition at line 1454 of file faMesh.H.

◆ hasFaceCurvatures()

bool hasFaceCurvatures ( ) const
inlinenoexcept

Has face curvatures: faceCurvatures()

Definition at line 1462 of file faMesh.H.

◆ hasPatchPointNormalsCorrection()

bool hasPatchPointNormalsCorrection ( ) const
inlinenoexcept

Has patch point normals corrections.

Definition at line 1470 of file faMesh.H.

◆ moving()

bool moving ( ) const
inline

Is mesh moving.

Definition at line 1481 of file faMesh.H.

References faMesh::mesh(), and polyMesh::moving().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update after mesh motion.

Definition at line 1274 of file faMesh.C.

References DebugInfo, Foam::endl(), mesh, edgeInterpolation::movePoints(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, polyMesh::points(), timeIndex, and timeName.

Here is the call graph for this function:

◆ updateMesh()

◆ mapFields()

void mapFields ( const faMeshMapper mapper) const
virtual

Map all fields in time using given map.

Definition at line 144 of file faMeshUpdate.C.

Referenced by faMesh::updateMesh().

Here is the caller graph for this function:

◆ mapOldAreas()

void mapOldAreas ( const faMeshMapper mapper) const
virtual

Map face areas in time using given map.

Definition at line 166 of file faMeshUpdate.C.

References faMeshMapper::areaMap(), DebugInFunction, Foam::endl(), Foam::faceMap(), forAll, faAreaMapper::newFaceLabelsMap(), and List< T >::setSize().

Referenced by faMesh::updateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ patch() [1/2]

const Foam::uindirectPrimitivePatch & patch ( ) const
inline

Return constant reference to primitive patch.

Definition at line 102 of file faMeshI.H.

Referenced by faMeshDecomposition::decomposeMesh(), faMeshDistributor::distribute(), and faMesh::updateMesh().

Here is the caller graph for this function:

◆ patch() [2/2]

Foam::uindirectPrimitivePatch & patch ( )
inline

Return reference to primitive patch.

Definition at line 112 of file faMeshI.H.

◆ patchStarts()

const Foam::labelList & patchStarts ( ) const

Return patch starts.

Definition at line 1077 of file faMesh.C.

◆ Le()

const Foam::edgeVectorField & Le ( ) const

Return edge length vectors.

Definition at line 1088 of file faMesh.C.

Referenced by kinematicThinFilm::evolveRegion().

Here is the caller graph for this function:

◆ magLe()

const Foam::edgeScalarField & magLe ( ) const

Return edge length magnitudes.

Definition at line 1099 of file faMesh.C.

Referenced by kinematicThinFilm::evolveRegion().

Here is the caller graph for this function:

◆ unitLe()

Foam::tmp< Foam::edgeVectorField > unitLe ( ) const

Return normalised edge length vectors.

Definition at line 2373 of file faMeshDemandDrivenData.C.

References Foam::dimless, mesh, faMesh::meshSubDir, tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, and faMesh::thisDb().

Here is the call graph for this function:

◆ areaCentres()

const Foam::areaVectorField & areaCentres ( ) const

Return face centres as areaVectorField.

Definition at line 1110 of file faMesh.C.

Referenced by areaMesh::C().

Here is the caller graph for this function:

◆ edgeCentres()

const Foam::edgeVectorField & edgeCentres ( ) const

Return edge centres as edgeVectorField.

Definition at line 1121 of file faMesh.C.

Referenced by edgeMesh::C().

Here is the caller graph for this function:

◆ S()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S ( ) const

Return face areas.

Definition at line 1133 of file faMesh.C.

Referenced by sensitivitySurface::computeRadius(), contactAngleForce::correct(), liquidFilmModel::info(), and liquidFilmModel::postEvolveRegion().

Here is the caller graph for this function:

◆ S0()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S0 ( ) const

Return old-time face areas.

Definition at line 1145 of file faMesh.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ S00()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S00 ( ) const

Return old-old-time face areas.

Definition at line 1159 of file faMesh.C.

References IOobjectOption::AUTO_WRITE, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and timeName.

◆ faceAreaNormals()

const Foam::areaVectorField & faceAreaNormals ( ) const

Return face area normals.

Definition at line 1183 of file faMesh.C.

Referenced by kinematicThinFilm::evolveRegion(), sensitivitySurface::smoothSensitivities(), liquidFilmBase::Up(), and liquidFilmBase::Uw().

Here is the caller graph for this function:

◆ edgeAreaNormals()

const Foam::edgeVectorField & edgeAreaNormals ( ) const

Return edge area normals.

Definition at line 1194 of file faMesh.C.

◆ pointAreaNormals()

const Foam::vectorField & pointAreaNormals ( ) const

Return point area normals.

Definition at line 1205 of file faMesh.C.

References nPoints.

◆ faceCurvatures()

const Foam::areaScalarField & faceCurvatures ( ) const

Return face curvatures.

Definition at line 1223 of file faMesh.C.

◆ edgeTransformTensors()

const Foam::FieldField< Foam::Field, Foam::tensor > & edgeTransformTensors ( ) const

Return edge transformation tensors.

Definition at line 1235 of file faMesh.C.

◆ internalPoints()

Foam::labelList internalPoints ( ) const

Return internal point labels.

Definition at line 1454 of file faMeshDemandDrivenData.C.

References DebugInFunction, Foam::endl(), bitSet::flip(), Foam::markupBoundaryPoints(), Foam::foamVersion::patch, and bitSet::sortedToc().

Here is the call graph for this function:

◆ boundaryPoints()

Foam::labelList boundaryPoints ( ) const

Return boundary point labels.

Definition at line 1466 of file faMeshDemandDrivenData.C.

References DebugInFunction, Foam::endl(), Foam::markupBoundaryPoints(), Foam::foamVersion::patch, and bitSet::sortedToc().

Here is the call graph for this function:

◆ edgeLengthCorrection()

◆ correctPatchPointNormals() [1/2]

bool correctPatchPointNormals ( const label  patchID) const

Whether point normals should be corrected for a patch.

Definition at line 1336 of file faMesh.C.

References boundary, and patchID.

◆ correctPatchPointNormals() [2/2]

Foam::boolList & correctPatchPointNormals ( ) const

Set whether point normals should be corrected for a patch.

Definition at line 1351 of file faMesh.C.

References boundary, and UList< T >::size().

Here is the call graph for this function:

◆ write()

bool write ( const bool  writeOnProc = true) const
virtual

Write mesh.

Reimplemented from regIOobject.

Definition at line 1363 of file faMesh.C.

Referenced by faMeshDecomposition::writeDecomposition().

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const faMesh m) const

Definition at line 1374 of file faMesh.C.

◆ operator==()

bool operator== ( const faMesh m) const

Definition at line 1380 of file faMesh.C.

◆ operator()()

void operator() ( ) const
delete

No call operator. Prior to 2312 was used to obtain polyMesh.

Member Data Documentation

◆ geometryOrder_

int geometryOrder_
static

Geometry treatment.

Definition at line 734 of file faMesh.H.

Referenced by faMesh::geometryOrder().

◆ meshSubDir


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