faMeshDecomposition Class Reference

Automatic faMesh decomposition class. More...

Inheritance diagram for faMeshDecomposition:
Collaboration diagram for faMeshDecomposition:

Public Member Functions

 faMeshDecomposition (const polyMesh &mesh, const label nProcessors, const dictionary &params=dictionary::null)
 Construct from components. Values will come from the volume decomposition. More...
 
 ~faMeshDecomposition ()=default
 Destructor. More...
 
label nProcs () const noexcept
 Number of processor in decomposition. More...
 
bool distributed () const noexcept
 Is decomposition data to be distributed for each processor. More...
 
bool distributed (const bool on) noexcept
 Change distributed flag. More...
 
bool useGlobalFaceZones () const noexcept
 Are global face zones used. More...
 
bool useGlobalFaceZones (const bool on) noexcept
 Change global face zones flag. More...
 
void updateParameters (const dictionary &params)
 Update flags based on the decomposition model settings. More...
 
const labelListfaceToProc () const noexcept
 Face-processor decomposition labels. More...
 
void decomposeMesh ()
 Decompose mesh. More...
 
bool writeDecomposition ()
 Write decomposition. More...
 
- Public Member Functions inherited from faMesh
 TypeName ("faMesh")
 Runtime type information. More...
 
 faMesh (const polyMesh &pMesh, const bool doInit=true)
 Read construct from polyMesh, using its IOobject properties. More...
 
 faMesh (const polyMesh &pMesh, const Foam::zero)
 Construct zero-sized from polyMesh. More...
 
 faMesh (const faMesh &baseMesh, const Foam::zero)
 Construct as copy (for dictionaries) and zero-sized without boundary. More...
 
 faMesh (const faMesh &baseMesh, labelList &&faceLabels)
 Construct as copy (for dictionaries) and faceLabels without boundary, using read properties from baseMesh. 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 polyMesh &pMesh, labelList &&faceLabels)
 Construct from components (face labels) without boundary, using IOobject properties from polyMesh. More...
 
 faMesh (const polyMesh &pMesh, labelList &&faceLabels, IOobjectOption ioOpt)
 Construct from components (face labels) without boundary, using specified read properties. More...
 
 faMesh (const polyPatch &pp, const bool doInit=true)
 Construct from single polyPatch. 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
 Return true if thisDb() is a valid DB. More...
 
virtual const objectRegistrythisDb () const
 Return reference to the mesh database. 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 MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
 MeshObject (const polyMesh &mesh)
 Construct with Type::typeName on Mesh. More...
 
 MeshObject (const word &objName, const polyMesh &mesh)
 Construct with given object name on Mesh. More...
 
virtual ~MeshObject ()=default
 Destructor. More...
 
const polyMeshmesh () const noexcept
 Reference to the mesh. More...
 
virtual bool writeData (Ostream &os) const
 Dummy write. More...
 
- Public Member Functions inherited from UpdateableMeshObject< polyMesh >
 UpdateableMeshObject (const word &objName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from MoveableMeshObject< polyMesh >
 MoveableMeshObject (const word &objName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from GeometricMeshObject< polyMesh >
 GeometricMeshObject (const word &objName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from TopologicalMeshObject< polyMesh >
 TopologicalMeshObject (const word &objName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from meshObject
 ClassName ("meshObject")
 Runtime declaration and debug switch. More...
 
 meshObject (const word &objName, const objectRegistry &obr)
 Construct with given object name on a registry. More...
 
- Public Member Functions inherited from regIOobject
void operator= (const regIOobject &)=delete
 No copy assignment. More...
 
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 Copy construct, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 Register object with its registry and transfer ownership to the registry. More...
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. 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...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
 Write using stream options. 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 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
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. 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 a sub-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 a sub-dictionary) otherwise return nullptr. More...
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find a sub-dictionary. 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...
 
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 edgeInterpolation
 ClassName ("edgeInterpolation")
 
 edgeInterpolation (const faMesh &)
 Construct given an faMesh. More...
 
 ~edgeInterpolation ()
 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...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from faMesh
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 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
 
- Static Public Member Functions inherited from faMesh
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 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 Public Member Functions inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
static const faMeshNew (const polyMesh &mesh, Args &&... args)
 Get existing or create a new MeshObject. Registered with typeName. More...
 
static const faMeshNew (const word &objName, const polyMesh &mesh, Args &&... args)
 Get existing or create a new MeshObject using supplied registration name. More...
 
static bool Delete (const word &objName, const polyMesh &mesh)
 Static destructor using supplied registration name. More...
 
static bool Delete (const polyMesh &mesh)
 Static destructor using Type::typeName. More...
 
- Static Public Member Functions inherited from meshObject
template<class Mesh >
static void movePoints (objectRegistry &obr)
 
template<class Mesh >
static void updateMesh (objectRegistry &obr, const mapPolyMesh &mpm)
 
template<class Mesh , template< class > class MeshObjectType>
static void clear (objectRegistry &obr)
 
template<class Mesh , template< class > class FromType, template< class > class ToType>
static void clearUpto (objectRegistry &obr)
 Clear all meshObject derived from FromType up to (but not including) ToType. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static word scopedName (const std::string &scope, const word &name1, const word &name2)
 Create scope:name1:name2 or scope_name1_name2 string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from IOobjectOption
static bool isAnyRead (readOption opt) noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
static bool isReadOptional (readOption opt) noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
static readOption lazierRead (readOption opt) noexcept
 Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
 
- Static Public Member Functions inherited from IOdictionary
static dictionary readContents (const IOobject &io)
 Read and return contents. 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...
 
- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from faMesh
static int geometryOrder_
 Geometry treatment. More...
 
static const word prefix
 The prefix to local: finite-area. More...
 
static word meshSubDir = "faMesh"
 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 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...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from edgeInterpolation
void clearOut ()
 Clear all geometry and addressing. 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...
 
- Protected Attributes inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
const polyMeshmesh_
 Reference to the mesh. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Automatic faMesh decomposition class.

Author Zeljko Tukovic, FSB Zagreb Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 53 of file faMeshDecomposition.H.

Constructor & Destructor Documentation

◆ faMeshDecomposition()

faMeshDecomposition ( const polyMesh mesh,
const label  nProcessors,
const dictionary params = dictionary::null 
)

Construct from components. Values will come from the volume decomposition.

Parameters
meshthe fvMesh
nProcessorsthe number of processors
paramsadditional parameters, sent to updateParameters

Definition at line 130 of file faMeshDecomposition.C.

◆ ~faMeshDecomposition()

~faMeshDecomposition ( )
default

Destructor.

Member Function Documentation

◆ nProcs()

label nProcs ( ) const
inlinenoexcept

Number of processor in decomposition.

Definition at line 202 of file faMeshDecomposition.H.

◆ distributed() [1/2]

bool distributed ( ) const
inlinenoexcept

Is decomposition data to be distributed for each processor.

Definition at line 210 of file faMeshDecomposition.H.

◆ distributed() [2/2]

bool distributed ( const bool  on)
inlinenoexcept

Change distributed flag.

Definition at line 218 of file faMeshDecomposition.H.

◆ useGlobalFaceZones() [1/2]

bool useGlobalFaceZones ( ) const
inlinenoexcept

Are global face zones used.

Definition at line 228 of file faMeshDecomposition.H.

◆ useGlobalFaceZones() [2/2]

bool useGlobalFaceZones ( const bool  on)
inlinenoexcept

Change global face zones flag.

Definition at line 236 of file faMeshDecomposition.H.

◆ updateParameters()

void updateParameters ( const dictionary params)

Update flags based on the decomposition model settings.

Sets "distributed", detects presence of "globalFaceZones"

Definition at line 165 of file faMeshDecomposition.C.

References dictionary::found(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ faceToProc()

const labelList& faceToProc ( ) const
inlinenoexcept

Face-processor decomposition labels.

Definition at line 256 of file faMeshDecomposition.H.

◆ decomposeMesh()

◆ writeDecomposition()


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