dynamicOversetFvMesh Class Reference

dynamicFvMesh with support for overset meshes. More...

Inheritance diagram for dynamicOversetFvMesh:
[legend]
Collaboration diagram for dynamicOversetFvMesh:
[legend]

Public Member Functions

 TypeName ("dynamicOversetFvMesh")
 Runtime type information. More...
 
 dynamicOversetFvMesh (const IOobject &io, const bool doInit=true)
 Construct from IOobject. More...
 
virtual ~dynamicOversetFvMesh ()
 Destructor. More...
 
const fvMeshPrimitiveLduAddressingprimitiveLduAddr () const
 Return extended ldu addressing. More...
 
virtual const lduAddressinglduAddr () const
 Return ldu addressing. If active: is (extended) More...
 
virtual lduInterfacePtrsList interfaces () const
 Return a list of pointers for each patch. More...
 
const labelListreverseFaceMap () const
 Return old to new face addressing. More...
 
bool active () const
 Return true if using extended addressing. More...
 
void active (const bool f) const
 Enable/disable extended addressing. More...
 
virtual void interpolate (scalarField &psi) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (vectorField &psi) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (sphericalTensorField &psi) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (symmTensorField &psi) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (tensorField &psi) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (volScalarField &psi) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volVectorField &psi) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volSphericalTensorField &psi) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volSymmTensorField &psi) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volTensorField &psi) const
 Interpolate interpolationCells only. More...
 
virtual SolverPerformance< scalar > solve (fvMatrix< scalar > &m, const dictionary &dict) const
 Solve returning the solution statistics given convergence. More...
 
virtual SolverPerformance< vectorsolve (fvMatrix< vector > &m, const dictionary &dict) const
 Solve returning the solution statistics given convergence. More...
 
virtual SolverPerformance< symmTensorsolve (fvMatrix< symmTensor > &m, const dictionary &dict) const
 Solve returning the solution statistics given convergence. More...
 
virtual SolverPerformance< tensorsolve (fvMatrix< tensor > &m, const dictionary &dict) const
 Solve returning the solution statistics given convergence. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
virtual bool update ()
 Update the mesh for both mesh motion and topology change. More...
 
virtual bool interpolateFields ()
 Update fields when mesh is updated. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
template<class Type >
Foam::tmp< Foam::scalarFieldnormalisation (const fvMatrix< Type > &m) const
 
template<class Type >
Foam::SolverPerformance< Type > solve (fvMatrix< Type > &m, const dictionary &dict) const
 
- Public Member Functions inherited from dynamicMotionSolverListFvMesh
 TypeName ("dynamicMotionSolverListFvMesh")
 Runtime type information. More...
 
 dynamicMotionSolverListFvMesh (const IOobject &io, const bool doInit=true)
 Construct from IOobject. More...
 
 ~dynamicMotionSolverListFvMesh ()
 Destructor. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
virtual bool init (const bool doInit, const bool mandatory)
 Initialise all non-demand-driven data. Used for initialising. More...
 
virtual bool update ()
 Update the mesh for both mesh motion and topology change. More...
 
virtual void mapFields (const mapPolyMesh &mpm)
 Map all fields in time using given map. Triggered by topo change. More...
 
- Public Member Functions inherited from dynamicFvMesh
 TypeName ("dynamicFvMesh")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, dynamicFvMesh, IOobject,(const IOobject &io),(io))
 
 declareRunTimeSelectionTable (autoPtr, dynamicFvMesh, doInit,(const IOobject &io, const bool doInit),(io, doInit))
 
 dynamicFvMesh (const IOobject &io, const bool doInit=true)
 Construct from IOobject. More...
 
 dynamicFvMesh (const IOobject &io, const Foam::zero, bool syncPar=true)
 Construct from IOobject or as zero-sized mesh. More...
 
 dynamicFvMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&allOwner, labelList &&allNeighbour, const bool syncPar=true)
 Construct from components without boundary. More...
 
 dynamicFvMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true)
 Construct without boundary from cells rather than owner/neighbour. More...
 
virtual ~dynamicFvMesh ()=default
 Destructor. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
virtual bool dynamic () const
 Is mesh dynamic. More...
 
virtual bool controlledUpdate ()
 Update the mesh if controller permits. More...
 
virtual bool update ()=0
 Update the mesh for both mesh motion and topology change. More...
 
- Public Member Functions inherited from fvMesh
 ClassName ("fvMesh")
 
 fvMesh (const IOobject &io, const bool doInit=true)
 Construct from IOobject. More...
 
 fvMesh (const IOobject &io, const Foam::zero, bool syncPar=true)
 Construct from IOobject or as zero-sized mesh. More...
 
 fvMesh (const IOobject &io, const fvMesh &baseMesh, const Foam::zero, const bool syncPar=true)
 Construct as copy (for dictionaries) and zero-sized components. More...
 
 fvMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&allOwner, labelList &&allNeighbour, const bool syncPar=true)
 Construct from components without boundary. More...
 
 fvMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true)
 Construct without boundary from cells rather than owner/neighbour. More...
 
 fvMesh (const IOobject &io, const fvMesh &baseMesh, pointField &&points, faceList &&faces, labelList &&allOwner, labelList &&allNeighbour, const bool syncPar=true)
 Copy construct (for dictionaries) with components, without boundary. More...
 
 fvMesh (const IOobject &io, const fvMesh &baseMesh, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true)
 Copy construct (for dictionaries) with cells, without boundary. More...
 
virtual ~fvMesh ()
 Destructor. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
void addFvPatches (polyPatchList &plist, const bool validBoundary=true)
 Add boundary patches. Constructor helper. More...
 
void addFvPatches (const List< polyPatch * > &p, const bool validBoundary=true)
 Add boundary patches. Constructor helper. More...
 
virtual readUpdateState readUpdate ()
 Update the mesh based on the mesh files saved in time. More...
 
const Timetime () const
 Return the top-level database. More...
 
virtual bool hasDb () const
 Return true if thisDb() is a valid DB. More...
 
virtual const objectRegistrythisDb () const
 Return the object registry - resolve conflict polyMesh/lduMesh. More...
 
const wordname () const
 Return reference to name. More...
 
const fvBoundaryMeshboundary () const
 Return reference to boundary mesh. More...
 
virtual const lduAddressinglduAddr () const
 Return ldu addressing. More...
 
virtual lduInterfacePtrsList interfaces () const
 Return a list of pointers for each patch. More...
 
virtual label comm () const
 Return communicator used for parallel communication. More...
 
virtual void interpolate (volScalarField &) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volVectorField &) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volSphericalTensorField &) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volSymmTensorField &) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (volTensorField &) const
 Interpolate interpolationCells only. More...
 
virtual void interpolate (scalarField &) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (vectorField &) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (sphericalTensorField &) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (symmTensorField &) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual void interpolate (tensorField &) const
 Interpolate interpolationCells only. No bcs. More...
 
virtual SolverPerformance< scalar > solve (fvMatrix< scalar > &, const dictionary &) const
 
virtual SolverPerformance< vectorsolve (fvMatrix< vector > &, const dictionary &) const
 
virtual SolverPerformance< sphericalTensorsolve (fvMatrix< sphericalTensor > &, const dictionary &) const
 
virtual SolverPerformance< symmTensorsolve (fvMatrix< symmTensor > &, const dictionary &) const
 
virtual SolverPerformance< tensorsolve (fvMatrix< tensor > &, const dictionary &) const
 
const labelUListowner () const
 Internal face owner. Note bypassing virtual mechanism so. More...
 
const labelUListneighbour () const
 Internal face neighbour. More...
 
const DimensionedField< scalar, volMesh > & V () const
 Return cell volumes. More...
 
const DimensionedField< scalar, volMesh > & V0 () const
 Return old-time cell volumes. More...
 
const DimensionedField< scalar, volMesh > & V00 () const
 Return old-old-time cell volumes. More...
 
tmp< DimensionedField< scalar, volMesh > > Vsc () const
 Return sub-cycle cell volumes. More...
 
tmp< DimensionedField< scalar, volMesh > > Vsc0 () const
 Return sub-cycle old-time cell volumes. More...
 
const surfaceVectorFieldSf () const
 Return cell face area vectors. More...
 
const surfaceScalarFieldmagSf () const
 Return cell face area magnitudes. More...
 
const surfaceScalarFieldphi () const
 Return cell face motion fluxes. More...
 
const volVectorFieldC () const
 Return cell centres as volVectorField. More...
 
const surfaceVectorFieldCf () const
 Return face centres as surfaceVectorField. More...
 
tmp< surfaceVectorFielddelta () const
 Return face deltas as surfaceVectorField. More...
 
template<class Type >
pTraits< Type >::labelType validComponents () const
 Return a labelType of valid component indicators. More...
 
void clearOut ()
 Clear all geometry and addressing. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update mesh corresponding to the given map. More...
 
virtual void movePoints (const pointField &)
 Move points, returns volumes swept by faces in motion. More...
 
virtual void updateGeom ()
 
virtual void mapFields (const mapPolyMesh &mpm)
 Map all fields in time using given map. More...
 
void removeFvBoundary ()
 
refPtr< surfaceScalarFieldsetPhi ()
 Return cell face motion fluxes (or null) More...
 
DimensionedField< scalar, volMesh > & setV0 ()
 Return old-time cell volumes. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write the underlying polyMesh and other data. More...
 
virtual bool write (const bool valid=true) const
 Write mesh using IO settings from time. More...
 
bool operator!= (const fvMesh &rhs) const
 Compares addresses. More...
 
bool operator== (const fvMesh &rhs) const
 Compares addresses. More...
 
template<>
pTraits< sphericalTensor >::labelType validComponents () const
 
virtual bool movePoints ()
 Avoid masking surfaceInterpolation method. More...
 
- Public Member Functions inherited from polyMesh
 TypeName ("polyMesh")
 Runtime type information. More...
 
 polyMesh (const IOobject &io, const bool doInit=true)
 Read construct from IOobject. More...
 
 polyMesh (const IOobject &io, const zero, const bool syncPar=true)
 Construct from IOobject or as zero-sized mesh. More...
 
 polyMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&owner, labelList &&neighbour, const bool syncPar=true)
 Construct from IOobject and components. More...
 
 polyMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true)
 Construct without boundary with cells rather than owner/neighbour. More...
 
 polyMesh (const IOobject &io, pointField &&points, const cellShapeList &shapes, const faceListList &boundaryFaces, const wordList &boundaryPatchNames, const wordList &boundaryPatchTypes, const word &defaultBoundaryPatchName, const word &defaultBoundaryPatchType, const wordList &boundaryPatchPhysicalTypes, const bool syncPar=true)
 Construct from cell shapes. More...
 
 polyMesh (const IOobject &io, pointField &&points, const cellShapeList &shapes, const faceListList &boundaryFaces, const wordList &boundaryPatchNames, const PtrList< dictionary > &boundaryDicts, const word &defaultBoundaryPatchName, const word &defaultBoundaryPatchType, const bool syncPar=true)
 
virtual ~polyMesh ()
 Destructor. More...
 
virtual const fileNamedbDir () const
 Override the objectRegistry dbDir for a single-region case. More...
 
fileName meshDir () const
 Return the local mesh directory (dbDir()/meshSubDir) More...
 
const fileNamepointsInstance () const
 Return the current instance directory for points. More...
 
const fileNamefacesInstance () const
 Return the current instance directory for faces. More...
 
void setInstance (const fileName &instance, const IOobject::writeOption wOpt=IOobject::AUTO_WRITE)
 Set the instance for mesh files. More...
 
const wordregionName () const
 The mesh region name or word::null if polyMesh::defaultRegion. More...
 
virtual const pointFieldpoints () const
 Return raw points. More...
 
virtual bool upToDatePoints (const regIOobject &io) const
 Return true if io is up-to-date with points. More...
 
virtual void setUpToDatePoints (regIOobject &io) const
 Set io to be up-to-date with points. More...
 
virtual const faceListfaces () const
 Return raw faces. More...
 
virtual const labelListfaceOwner () const
 Return face owner. More...
 
virtual const labelListfaceNeighbour () const
 Return face neighbour. More...
 
virtual const pointFieldoldPoints () const
 Return old points (mesh motion) More...
 
virtual const pointFieldoldCellCentres () const
 Return old cellCentres (mesh motion) More...
 
const polyBoundaryMeshboundaryMesh () const
 Return boundary mesh. More...
 
const boundBoxbounds () const
 Return mesh bounding box. More...
 
const Vector< label > & geometricD () const
 Return the vector of geometric directions in mesh. More...
 
label nGeometricD () const
 Return the number of valid geometric dimensions in the mesh. More...
 
const Vector< label > & solutionD () const
 Return the vector of solved-for directions in mesh. More...
 
label nSolutionD () const
 Return the number of valid solved-for dimensions in the mesh. More...
 
const labelIOListtetBasePtIs () const
 Return the tetBasePtIs. More...
 
const indexedOctree< treeDataCell > & cellTree () const
 Return the cell search tree. More...
 
const pointZoneMeshpointZones () const noexcept
 Return point zone mesh. More...
 
const faceZoneMeshfaceZones () const noexcept
 Return face zone mesh. More...
 
const cellZoneMeshcellZones () const noexcept
 Return cell zone mesh. More...
 
const globalMeshDataglobalData () const
 Return parallel info. More...
 
label comm () const noexcept
 Return communicator used for parallel communication. More...
 
label & comm () noexcept
 Return communicator used for parallel communication. More...
 
const objectRegistrythisDb () const noexcept
 Return the object registry. More...
 
virtual bool dynamic () const
 Is mesh dynamic. More...
 
bool moving () const noexcept
 Is mesh moving. More...
 
bool moving (const bool on) noexcept
 Set the mesh to be moving. More...
 
bool topoChanging () const noexcept
 Is mesh topology changing. More...
 
bool topoChanging (const bool on) noexcept
 Set the mesh topology to be changing. More...
 
bool changing () const noexcept
 Is mesh changing (topology changing and/or moving) More...
 
virtual void movePoints (const pointField &)
 Move points. More...
 
void resetMotion () const
 Reset motion. More...
 
pointZoneMeshpointZones () noexcept
 Return non-const access to the pointZones. More...
 
faceZoneMeshfaceZones () noexcept
 Return non-const access to the faceZones. More...
 
cellZoneMeshcellZones () noexcept
 Return non-const access to the cellZones. More...
 
void addPatches (polyPatchList &plist, const bool validBoundary=true)
 Add boundary patches. More...
 
void addPatches (const List< polyPatch * > &p, const bool validBoundary=true)
 Add boundary patches. More...
 
void addZones (const List< pointZone * > &pz, const List< faceZone * > &fz, const List< cellZone * > &cz)
 Add mesh zones. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
virtual readUpdateState readUpdate ()
 Update the mesh based on the mesh files saved in. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update the mesh corresponding to given map. More...
 
void removeBoundary ()
 Remove boundary patches. More...
 
void resetPrimitives (autoPtr< pointField > &&points, autoPtr< faceList > &&faces, autoPtr< labelList > &&owner, autoPtr< labelList > &&neighbour, const labelUList &patchSizes, const labelUList &patchStarts, const bool validBoundary=true)
 Reset mesh primitive data. Assumes all patch info correct. More...
 
void clearGeom ()
 Clear geometry. More...
 
void updateGeomPoints (pointIOField &&newPoints, autoPtr< labelIOList > &newTetBasePtIsPtr)
 
void clearAddressing (const bool isMeshUpdate=false)
 Clear addressing. More...
 
void clearOut ()
 Clear all geometry and addressing unnecessary for CFD. More...
 
void clearPrimitives ()
 Clear primitive data (points, faces and cells) More...
 
void clearTetBasePtIs ()
 Clear tet base points. More...
 
void clearCellTree ()
 Clear cell tree data. More...
 
void removeFiles (const fileName &instanceDir) const
 Remove all files from mesh instance. More...
 
void removeFiles () const
 Remove all files from mesh instance() More...
 
bool hasTetBasePtIs () const
 
virtual bool checkFaceOrthogonality (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check non-orthogonality. More...
 
virtual bool checkFaceSkewness (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face skewness. More...
 
virtual bool checkEdgeAlignment (const bool report, const Vector< label > &directions, labelHashSet *setPtr) const
 Check edge alignment for 1D/2D cases. More...
 
virtual bool checkCellDeterminant (const bool report, labelHashSet *setPtr) const
 
virtual bool checkMeshMotion (const pointField &newPoints, const bool report=false, const bool detailedReport=false) const
 Check mesh motion for correctness given motion points. More...
 
virtual bool checkFaceWeight (const bool report, const scalar minWeight=0.05, labelHashSet *setPtr=nullptr) const
 Check for face weights. More...
 
virtual bool checkVolRatio (const bool report, const scalar minRatio=0.01, labelHashSet *setPtr=nullptr) const
 Check for neighbouring cell volumes. More...
 
void findCellFacePt (const point &p, label &celli, label &tetFacei, label &tetPti) const
 Find the cell, tetFacei and tetPti for point p. More...
 
void findTetFacePt (const label celli, const point &p, label &tetFacei, label &tetPti) const
 Find the tetFacei and tetPti for point p in celli. More...
 
bool pointInCell (const point &p, label celli, const cellDecomposition=CELL_TETS) const
 Test if point p is in the celli. More...
 
label findCell (const point &p, const cellDecomposition=CELL_TETS) const
 Find cell enclosing this location and return index. More...
 
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label nObjects=128)
 
 objectRegistry (const IOobject &io, const label nObjects=128)
 
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...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
HashTable< wordHashSetclasses () const
 A summary hash of classes used and their associated object names. More...
 
template<class MatchPredicate >
HashTable< wordHashSetclasses (const MatchPredicate &matchName) const
 
UPtrList< const regIOobjectcsorted () const
 Return sorted list of objects. More...
 
UPtrList< const regIOobjectsorted () const
 Return sorted list of objects. More...
 
UPtrList< regIOobjectsorted ()
 Return sorted list of objects. More...
 
template<class Type >
UPtrList< const Type > csorted () const
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type >
UPtrList< const Type > sorted () const
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type >
UPtrList< Type > sorted ()
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
UPtrList< const Type > sorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
UPtrList< Type > sorted (const MatchPredicate &matchName)
 
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
 
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
 
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
 
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
 
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
 
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 >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Return all objects with a class satisfying isA<Type> More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 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 found (const word &name, const bool recursive=false) const
 Can the regIOobject object be found (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
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 
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
 
bool checkOut (regIOobject &io) const
 
bool checkOut (const word &key) const
 
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...
 
virtual bool modified () const
 Return true if any of the object's files have been modified. More...
 
void readModifiedObjects ()
 Read the objects that have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified. More...
 
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write the objects using stream options. 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 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 objectRegistry &list, const MatchPredicate &matchName)
 
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 >
Foam::UPtrList< const Type > csorted () const
 
template<class Type >
Foam::UPtrList< const Type > sorted () const
 
template<class Type >
Foam::UPtrList< Type > sorted ()
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > sorted (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 >
Foam::HashTable< const Type * > lookupClass (const bool strict) const
 
template<class Type >
Foam::HashTable< Type * > lookupClass (const bool strict)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 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
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 
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...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writeData function. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) 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, readOption rOpt=NO_READ, writeOption wOpt=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, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=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, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. 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
 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...
 
virtual void rename (const word &newName)
 Rename the object. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. 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...
 
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...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() 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. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete 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
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. 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
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. 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)
 
- Public Member Functions inherited from HashTable< regIOobject * >
 HashTable ()
 Default construct with default (128) table capacity. More...
 
 HashTable (const label size)
 Construct given initial table capacity. More...
 
 HashTable (Istream &is, const label size=128)
 Construct from Istream with default table capacity. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs)
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< word, regIOobject * > > list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. 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 found (const word &key) const
 Return true if hashed entry is 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
 
Foam::List< wordsortedToc (const Compare &comp) const
 
List< wordtocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocValues (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 
UPtrList< const node_typesorted () const
 
UPtrList< node_typesorted ()
 
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 resize (const label sz)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Swap contents into this table. More...
 
void transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Transfer contents into this table. 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
 
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
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore ()=default
 Default construct. More...
 
- Public Member Functions inherited from primitiveMesh
 ClassName ("primitiveMesh")
 
 primitiveMesh (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells)
 Construct from components. More...
 
virtual ~primitiveMesh ()
 Destructor. More...
 
void reset (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells)
 Reset this primitiveMesh given the primitive array sizes. More...
 
void reset (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells, cellList &cells)
 Reset this primitiveMesh given the primitive array sizes and cells. More...
 
void resetGeometry (pointField &&faceCentres, pointField &&faceAreas, pointField &&cellCentres, scalarField &&cellVolumes)
 Reset the local geometry. More...
 
virtual bool init (const bool doInit)
 Initialise all non-demand-driven data. More...
 
label nPoints () const noexcept
 Number of mesh points. More...
 
label nEdges () const
 Number of mesh edges. More...
 
label nFaces () const noexcept
 Number of mesh faces. More...
 
label nCells () const noexcept
 Number of mesh cells. More...
 
label nInternalFaces () const noexcept
 Number of internal faces. More...
 
label nBoundaryFaces () const noexcept
 Number of boundary faces (== nFaces - nInternalFaces) More...
 
label nInternalPoints () const noexcept
 Points not on boundary. More...
 
label nInternal0Edges () const
 
label nInternal1Edges () const
 Internal edges using 0 or 1 boundary point. More...
 
label nInternalEdges () const
 Internal edges using 0,1 or 2 boundary points. More...
 
virtual const pointFieldpoints () const =0
 Return mesh points. More...
 
virtual const faceListfaces () const =0
 Return faces. More...
 
virtual const labelListfaceOwner () const =0
 Face face-owner addressing. More...
 
virtual const labelListfaceNeighbour () const =0
 Face face-neighbour addressing. More...
 
virtual const pointFieldoldPoints () const =0
 Return old points for mesh motion. More...
 
const cellShapeListcellShapes () const
 Return cell shapes. More...
 
const edgeListedges () const
 Return mesh edges. Uses calcEdges. More...
 
const labelListListcellCells () const
 
const labelListListedgeCells () const
 
const labelListListpointCells () const
 
const cellListcells () const
 
const labelListListedgeFaces () const
 
const labelListListpointFaces () const
 
const labelListListcellEdges () const
 
const labelListListfaceEdges () const
 
const labelListListpointEdges () const
 
const labelListListpointPoints () const
 
const labelListListcellPoints () const
 
const vectorFieldcellCentres () const
 
const vectorFieldfaceCentres () const
 
const scalarFieldcellVolumes () const
 
const vectorFieldfaceAreas () const
 
void movePoints (const pointField &p, const pointField &oldP)
 Move points. More...
 
bool isInternalFace (const label faceIndex) const noexcept
 Return true if given face label is internal to the mesh. More...
 
virtual bool checkUpperTriangular (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face ordering. More...
 
virtual bool checkCellsZipUp (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check cell zip-up. More...
 
virtual bool checkFaceVertices (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check uniqueness of face vertices. More...
 
virtual bool checkPoints (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for unused points. More...
 
virtual bool checkFaceFaces (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face-face connectivity. More...
 
virtual bool checkClosedBoundary (const bool report=false) const
 Check boundary for closedness. More...
 
virtual bool checkClosedCells (const bool report=false, labelHashSet *setPtr=nullptr, labelHashSet *highAspectSetPtr=nullptr, const Vector< label > &solutionD=Vector< label >::one) const
 Check cells for closedness. More...
 
virtual bool checkFaceAreas (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for negative face areas. More...
 
virtual bool checkCellVolumes (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for negative cell volumes. More...
 
virtual bool checkFaceOrthogonality (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for non-orthogonality. More...
 
virtual bool checkFacePyramids (const bool report=false, const scalar minPyrVol=-SMALL, labelHashSet *setPtr=nullptr) const
 Check face pyramid volume. More...
 
virtual bool checkFaceSkewness (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check face skewness. More...
 
virtual bool checkFaceAngles (const bool report=false, const scalar maxSin=10, labelHashSet *setPtr=nullptr) const
 Check face angles. More...
 
virtual bool checkFaceFlatness (const bool report, const scalar warnFlatness, labelHashSet *setPtr) const
 Check face warpage: decompose face and check ratio between. More...
 
virtual bool checkPointNearness (const bool report, const scalar reportDistSqr, labelHashSet *setPtr=nullptr) const
 Check for point-point-nearness,. More...
 
virtual bool checkEdgeLength (const bool report, const scalar minLenSqr, labelHashSet *setPtr=nullptr) const
 Check edge length. More...
 
virtual bool checkConcaveCells (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check for concave cells by the planes of faces. More...
 
virtual bool checkTopology (const bool report=false) const
 Check mesh topology for correctness. More...
 
virtual bool checkGeometry (const bool report=false) const
 Check mesh geometry (& implicitly topology) for correctness. More...
 
virtual bool checkMesh (const bool report=false) const
 Check mesh for correctness. Returns false for no error. More...
 
bool pointInCellBB (const point &p, label celli, scalar inflationFraction=0) const
 Return true if the point in the cell bounding box. More...
 
bool pointInCell (const point &p, label celli) const
 Return true if the point is in the cell. More...
 
label findNearestCell (const point &location) const
 Find the cell with the nearest cell centre to location. More...
 
label findCell (const point &location) const
 Find cell enclosing this location (-1 if not in mesh) More...
 
void printAllocated () const
 Print a list of all the currently allocated mesh data. More...
 
bool hasCellShapes () const noexcept
 
bool hasEdges () const noexcept
 
bool hasCellCells () const noexcept
 
bool hasEdgeCells () const noexcept
 
bool hasPointCells () const noexcept
 
bool hasCells () const noexcept
 
bool hasEdgeFaces () const noexcept
 
bool hasPointFaces () const noexcept
 
bool hasCellEdges () const noexcept
 
bool hasFaceEdges () const noexcept
 
bool hasPointEdges () const noexcept
 
bool hasPointPoints () const noexcept
 
bool hasCellPoints () const noexcept
 
bool hasCellCentres () const noexcept
 
bool hasCellVolumes () const noexcept
 
bool hasFaceCentres () const noexcept
 
bool hasFaceAreas () const noexcept
 
const labelListcellCells (const label celli, DynamicList< label > &) const
 cellCells using cells. More...
 
const labelListcellCells (const label celli) const
 
const labelListcellPoints (const label celli, labelHashSet &, DynamicList< label > &) const
 cellPoints using cells More...
 
const labelListcellPoints (const label celli) const
 
const labelListpointCells (const label pointi, DynamicList< label > &) const
 pointCells using pointFaces More...
 
const labelListpointCells (const label pointi) const
 
const labelListpointPoints (const label pointi, DynamicList< label > &) const
 pointPoints using edges, pointEdges More...
 
const labelListpointPoints (const label pointi) const
 
const labelListfaceEdges (const label facei, DynamicList< label > &) const
 faceEdges using pointFaces, edges, pointEdges More...
 
const labelListfaceEdges (const label facei) const
 
const labelListedgeFaces (const label edgeI, DynamicList< label > &) const
 edgeFaces using pointFaces, edges, pointEdges More...
 
const labelListedgeFaces (const label edgeI) const
 
const labelListedgeCells (const label edgeI, DynamicList< label > &) const
 edgeCells using pointFaces, edges, pointEdges More...
 
const labelListedgeCells (const label edgeI) const
 
const labelListcellEdges (const label celli, labelHashSet &, DynamicList< label > &) const
 cellEdges using cells, pointFaces, edges, pointEdges More...
 
const labelListcellEdges (const label celli) const
 
virtual void updateGeom ()
 Update all geometric data. More...
 
void clearGeom ()
 Clear geometry. More...
 
void clearCellGeom ()
 Clear cell-based geometry only. More...
 
void clearAddressing ()
 Clear topological data. More...
 
void clearOut ()
 Clear all geometry and addressing unnecessary for CFD. More...
 
- Public Member Functions inherited from lduMesh
 TypeName ("lduMesh")
 Runtime type information. More...
 
virtual ~lduMesh ()=default
 Destructor. More...
 
virtual bool hasDb () const =0
 Return true if thisDb() is a valid DB. More...
 
virtual const objectRegistrythisDb () const
 Return the object registry. More...
 
virtual const lduAddressinglduAddr () const =0
 Return ldu addressing. More...
 
virtual lduInterfacePtrsList interfaces () const =0
 
virtual label comm () const =0
 Return communicator used for parallel communication. More...
 
template<class T , class BinaryOp >
void reduce (T &Value, const BinaryOp &bop) const
 Helper: reduce with current communicator. More...
 
InfoProxy< lduMeshinfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from fvSchemes
 fvSchemes (const fvSchemes &)=delete
 No copy construct. More...
 
void operator= (const fvSchemes &)=delete
 No copy assignment. More...
 
 fvSchemes (const objectRegistry &obr, const IOobject::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 fvSchemes (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr)
 
 fvSchemes (const objectRegistry &obr, const IOobject::readOption rOpt, const dictionary *fallback=nullptr)
 
 fvSchemes (const objectRegistry &obr, const dictionary *fallback=nullptr)
 
 fvSchemes (const objectRegistry &obr, const dictionary &dict)
 
- Public Member Functions inherited from schemesLookup
 schemesLookup (const objectRegistry &obr, const IOobject::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)
 
const dictionaryschemesDict () const
 The current schemes dictionary, respects the "select" keyword. More...
 
bool steady () const noexcept
 True if default ddtScheme is steady-state. More...
 
bool transient () const noexcept
 True if default ddtScheme is not steady-state. 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
 Get flux-required for given name, or default. More...
 
bool fluxRequired (const word &name) const
 Set flux-required for given name (mutable) 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 to 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 to 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)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 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)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream (ununsed) More...
 
virtual fileName filePath () const =0
 
const wordname () const
 
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...
 
virtual bool global () const =0
 Is object global. 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)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 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...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find for an entry (non-const access) with the given keyword. More...
 
const entryfindEntry (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...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present. 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
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Check if entry is found and is a sub-dictionary. 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
 
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
 
bool read (Istream &is)
 Read dictionary from Istream. Discards the header. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. 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...
 
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 entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const
 
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
 
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, bool mandatory=true) const
 
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
 
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...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) find and return an entry data stream. 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)
 
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...
 
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 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. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &lst)
 
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 > &lst)
 Construct as copy. 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...
 
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...
 
- Public Member Functions inherited from surfaceInterpolation
 ClassName ("surfaceInterpolation")
 
 surfaceInterpolation (const fvMesh &)
 Construct given an fvMesh. More...
 
virtual ~surfaceInterpolation ()
 Destructor. More...
 
virtual const fvGeometrySchemegeometry () const
 Return reference to geometry calculation scheme. More...
 
void geometry (tmp< fvGeometryScheme > &)
 Set geometry calculation scheme. More...
 
virtual const surfaceScalarFieldweights () const
 Return reference to linear difference weighting factors. More...
 
virtual const surfaceScalarFielddeltaCoeffs () const
 Return reference to cell-centre difference coefficients. More...
 
virtual const surfaceScalarFieldnonOrthDeltaCoeffs () const
 Return reference to non-orthogonal cell-centre difference. More...
 
virtual const surfaceVectorFieldnonOrthCorrectionVectors () const
 Return reference to non-orthogonality correction vectors. More...
 
virtual bool movePoints ()
 Do what is necessary if the mesh has moved. More...
 
virtual void updateGeom ()
 Update all geometric data. More...
 
bool hasWeights () const noexcept
 Has weights. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update mesh for topology changes. More...
 
- Public Member Functions inherited from fvSolution
 fvSolution (const fvSolution &)=delete
 No copy construct. More...
 
void operator= (const fvSolution &)=delete
 No copy assignment. More...
 
 fvSolution (const objectRegistry &obr, const IOobject::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr)
 Construct for objectRegistry, readOption, (system) dictionary name. More...
 
 fvSolution (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr)
 
 fvSolution (const objectRegistry &obr, const IOobject::readOption rOpt, const dictionary *fallback=nullptr)
 
 fvSolution (const objectRegistry &obr, const dictionary *fallback=nullptr)
 
 fvSolution (const objectRegistry &obr, const dictionary &dict)
 
- Public Member Functions inherited from solution
 solution (const objectRegistry &obr, const IOobject::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)
 
virtual ~solution ()
 Destructor. More...
 
bool cache (const word &name) const
 Return true if the given field should be cached. More...
 
bool relaxField (const word &name) const
 Return true if the relaxation factor is given for the field. More...
 
bool relaxEquation (const word &name) const
 Return true if the relaxation factor is given for the equation. More...
 
scalar fieldRelaxationFactor (const word &name) const
 Return the relaxation factor for the given field. More...
 
scalar equationRelaxationFactor (const word &name) const
 Return the relaxation factor for the given equation. More...
 
const dictionarysolutionDict () const
 
const dictionarysolverDict (const word &name) const
 Return the solver controls dictionary for the given field. More...
 
const dictionarysolver (const word &name) const
 Return the solver controls dictionary for the given field. More...
 
bool read ()
 Read the solution dictionary. More...
 
- Public Member Functions inherited from data
 data (const objectRegistry &obr)
 Construct for objectRegistry. More...
 
 data (const objectRegistry &obr, const dictionary &dict)
 Construct for objectRegistry and initial contents. More...
 
const dictionarysolverPerformanceDict () const
 
template<class Type >
void setSolverPerformance (const word &name, const SolverPerformance< Type > &sp) const
 Add/set the solverPerformance entry for the named field. More...
 
template<class Type >
void setSolverPerformance (const SolverPerformance< Type > &sp) const
 Add/set the solverPerformance entry, using its fieldName. More...
 

Static Public Member Functions

template<class GeoField >
static void checkCoupledBC (const GeoField &fld)
 Debug: check halo swap is ok. More...
 
template<class GeoField , class PatchType >
static void correctBoundaryConditions (typename GeoField::Boundary &bfld, const bool typeOnly)
 Correct boundary conditions of certain type (typeOnly = true) More...
 
- Static Public Member Functions inherited from dynamicFvMesh
static autoPtr< dynamicFvMeshNew (const IOobject &io)
 Select, construct and return the dynamicFvMesh. More...
 
static autoPtr< dynamicFvMeshNew (const argList &args, const Time &runTime)
 Select, construct and return the dynamicFvMesh. More...
 
- Static Public Member Functions inherited from polyMesh
static const wordregionName (const word &region)
 The mesh region name or word::null if polyMesh::defaultRegion. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static 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 HashTableCore
static label canonicalSize (const label requested_size)
 Return a canonical (power-of-two) of the requested size. More...
 
- Static Public Member Functions inherited from primitiveMesh
static void calcCells (cellList &, const labelUList &own, const labelUList &nei, const label nCells=-1)
 Helper function to calculate cell-face addressing from. More...
 
static bool calcPointOrder (label &nInternalPoints, labelList &pointMap, const faceList &, const label nInternalFaces, const label nPoints)
 Helper function to calculate point ordering. Returns true. More...
 
static scalar setClosedThreshold (const scalar)
 Set the closedness ratio warning threshold. More...
 
static scalar setAspectThreshold (const scalar)
 Set the aspect ratio warning threshold. More...
 
static scalar setNonOrthThreshold (const scalar)
 Set the non-orthogonality warning threshold in degrees. More...
 
static scalar setSkewThreshold (const scalar)
 Set the skewness warning threshold as percentage. More...
 
- 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 &vf)
 Helper for printing cache message. More...
 

Protected Member Functions

virtual bool updateAddressing () const
 Calculate the extended lduAddressing. More...
 
template<class Type >
void write (Ostream &, const fvMatrix< Type > &, const lduAddressing &, const lduInterfacePtrsList &) const
 Debug: print matrix. More...
 
template<class T >
void interpolate (Field< T > &psi) const
 Explicit interpolation of acceptor cells from donor cells. More...
 
template<class GeoField >
void interpolate (GeoField &psi) const
 Explicit interpolation of acceptor cells from donor cells with. More...
 
template<class GeoField >
void interpolate (const wordHashSet &suppressed)
 Explicit interpolation of all registered fields. Excludes. More...
 
template<class Type >
tmp< scalarFieldnormalisation (const fvMatrix< Type > &m) const
 Freeze values at holes. More...
 
template<class Type >
void addInterpolation (fvMatrix< Type > &, const scalarField &norm) const
 Add interpolation to matrix (coefficients) More...
 
template<class Type >
SolverPerformance< Type > solve (fvMatrix< Type > &, const dictionary &) const
 Solve given dictionary with settings. More...
 
scalar cellAverage (const labelList &types, const labelList &nbrTypes, const scalarField &norm, const scalarField &nbrNorm, const label celli, bitSet &isFront) const
 Average norm of valid neighbours. More...
 
void writeAgglomeration (const GAMGAgglomeration &agglom) const
 Debug: dump agglomeration. More...
 
- Protected Member Functions inherited from fvMesh
void clearGeomNotOldVol ()
 Clear geometry but not the old-time cell volumes. More...
 
void updateGeomNotOldVol ()
 Clear geometry like clearGeomNotOldVol but recreate any. More...
 
void clearGeom ()
 Clear local geometry. More...
 
void clearAddressing (const bool isMeshUpdate=false)
 Clear local addressing. More...
 
void clearOutLocal ()
 Clear local-only storage (geometry, addressing etc) More...
 
void storeOldVol (const scalarField &)
 Preserve old volume(s) More...
 
void makeSf () const
 
void makeMagSf () const
 
void makeC () const
 
void makeCf () const
 
 fvMesh (const fvMesh &)=delete
 No copy construct. More...
 
void operator= (const fvMesh &)=delete
 No copy assignment. 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 HashTable< regIOobject * >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 
- Protected Member Functions inherited from primitiveMesh
void calcFaceCentresAndAreas () const
 Calculate face centres and areas. More...
 
void calcCellCentresAndVols () const
 Calculate cell centres and volumes. More...
 
void calcEdgeVectors () const
 Calculate edge vectors. More...
 
bool checkDuplicateFaces (const label, const Map< label > &, label &nBaffleFaces, labelHashSet *) const
 Check if all points on face are shared with another face. More...
 
bool checkCommonOrder (const label, const Map< label > &, labelHashSet *) const
 Check that shared points are in consecutive order. More...
 
bool checkClosedBoundary (const vectorField &areas, const bool report, const bitSet &internalOrCoupledFaces) const
 Check boundary for closedness. More...
 
bool checkClosedCells (const vectorField &faceAreas, const scalarField &cellVolumes, const bool report, labelHashSet *setPtr, labelHashSet *aspectSetPtr, const Vector< label > &meshD) const
 Check cells for closedness. More...
 
bool checkFaceAreas (const vectorField &faceAreas, const bool report, const bool detailedReport, labelHashSet *setPtr) const
 Check for negative face areas. More...
 
bool checkCellVolumes (const scalarField &vols, const bool report, const bool detailedReport, labelHashSet *setPtr) const
 Check for negative cell volumes. More...
 
bool checkFaceOrthogonality (const vectorField &fAreas, const vectorField &cellCtrs, const bool report, labelHashSet *setPtr) const
 Check for non-orthogonality. More...
 
bool checkFacePyramids (const pointField &points, const vectorField &ctrs, const bool report, const bool detailedReport, const scalar minPyrVol, labelHashSet *setPtr) const
 Check face pyramid volume. More...
 
bool checkFaceSkewness (const pointField &points, const vectorField &fCtrs, const vectorField &fAreas, const vectorField &cellCtrs, const bool report, labelHashSet *setPtr) const
 Check face skewness. More...
 
bool checkFaceAngles (const pointField &points, const vectorField &faceAreas, const bool report, const scalar maxDeg, labelHashSet *setPtr) const
 Check face angles. More...
 
bool checkFaceFlatness (const pointField &points, const vectorField &faceCentres, const vectorField &faceAreas, const bool report, const scalar warnFlatness, labelHashSet *setPtr) const
 Check face warpage. More...
 
bool checkConcaveCells (const vectorField &fAreas, const pointField &fCentres, const bool report, labelHashSet *setPtr) const
 Check for concave cells by the planes of faces. More...
 
 primitiveMesh ()
 Construct null. More...
 
- Protected Member Functions inherited from surfaceInterpolation
void clearOut ()
 Clear all geometry and addressing. More...
 

Static Protected Member Functions

static word baseName (const word &name)
 Helper: strip off trailing _0. More...
 
template<class GeoField >
static void correctCoupledBoundaryConditions (GeoField &fld)
 Debug: correct coupled bc. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 

Protected Attributes

bool active_
 Select base addressing (false) or locally stored extended. More...
 
autoPtr< fvMeshPrimitiveLduAddressinglduPtr_
 Extended addressing (extended with local interpolation stencils) More...
 
PtrList< const lduPrimitiveProcessorInterfaceremoteStencilInterfaces_
 Added (processor)lduInterfaces for remote bits of stencil. More...
 
lduInterfacePtrsList allInterfaces_
 Interfaces for above mesh. Contains both original and. More...
 
labelListList stencilFaces_
 Corresponding faces (in above lduPtr) to the stencil. More...
 
labelListList stencilPatches_
 Corresponding patches (in above lduPtr) to the stencil. More...
 
labelList reverseFaceMap_
 From old to new face labels. More...
 
- Protected Attributes inherited from fvMesh
fvBoundaryMesh boundary_
 Boundary mesh. More...
 
fvMeshLduAddressinglduPtr_
 
label curTimeIndex_
 Current time index for cell volumes. More...
 
SlicedDimensionedField< scalar, volMesh > * VPtr_
 Cell volumes. More...
 
DimensionedField< scalar, volMesh > * V0Ptr_
 Cell volumes old time level. More...
 
DimensionedField< scalar, volMesh > * V00Ptr_
 Cell volumes old-old time level. More...
 
slicedSurfaceVectorFieldSfPtr_
 Face area vectors. More...
 
surfaceScalarFieldmagSfPtr_
 Mag face area vectors. More...
 
slicedVolVectorFieldCPtr_
 Cell centres. More...
 
slicedSurfaceVectorFieldCfPtr_
 Face centres. More...
 
surfaceScalarFieldphiPtr_
 Face motion fluxes. More...
 

Additional Inherited Members

- Public Types inherited from fvMesh
typedef fvMesh Mesh
 The mesh type. More...
 
typedef fvBoundaryMesh BoundaryMesh
 The boundary type associated with the mesh. More...
 
- Public Types inherited from polyMesh
enum  readUpdateState { UNCHANGED , POINTS_MOVED , TOPO_CHANGE , TOPO_PATCH_CHANGE }
 Enumeration defining the state of the mesh after a read update. More...
 
enum  cellDecomposition { FACE_PLANES , FACE_CENTRE_TRIS , FACE_DIAG_TRIS , CELL_TETS }
 Enumeration defining the decomposition of the cell for. More...
 
typedef polyMesh Mesh
 The mesh type. More...
 
typedef polyBoundaryMesh BoundaryMesh
 The boundary type associated with the mesh. More...
 
- Public Types inherited from IOobject
enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
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 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< zero::null, typenamestd::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type node_type
 
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 Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from polyMesh
static word defaultRegion = "region0"
 Return the default region name. More...
 
static word meshSubDir = "polyMesh"
 Return the mesh sub-directory name (usually "polyMesh") More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable internal table size. Approximately labelMax/4. More...
 
- Static Public Attributes inherited from primitiveMesh
static const unsigned cellsPerEdge_ = 4
 Estimated number of cells per edge. More...
 
static const unsigned cellsPerPoint_ = 8
 Estimated number of cells per point. More...
 
static const unsigned facesPerCell_ = 6
 Estimated number of faces per cell. More...
 
static const unsigned facesPerEdge_ = 4
 Estimated number of faces per edge. More...
 
static const unsigned facesPerPoint_ = 12
 Estimated number of faces per point. More...
 
static const unsigned edgesPerCell_ = 12
 Estimated number of edges per cell. More...
 
static const unsigned edgesPerFace_ = 4
 Estimated number of edges per cell. More...
 
static const unsigned edgesPerPoint_ = 6
 Estimated number of edges per point. More...
 
static const unsigned pointsPerCell_ = 8
 Estimated number of points per cell. More...
 
static const unsigned pointsPerFace_ = 4
 Estimated number of points per face. More...
 
- 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. More...
 
- Static Public Attributes inherited from data
static int debug
 Debug switch. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 
- Static Protected Attributes inherited from primitiveMesh
static scalar closedThreshold_ = 1.0e-6
 Static data to control mesh checking. More...
 
static scalar aspectThreshold_ = 1000
 Aspect ratio warning threshold. More...
 
static scalar nonOrthThreshold_ = 70
 Non-orthogonality warning threshold in deg. More...
 
static scalar skewThreshold_ = 4
 Skewness warning threshold. More...
 
static scalar planarCosAngle_ = 1.0e-6
 Threshold where faces are considered coplanar. More...
 

Detailed Description

dynamicFvMesh with support for overset meshes.

Source files

Definition at line 58 of file dynamicOversetFvMesh.H.

Constructor & Destructor Documentation

◆ dynamicOversetFvMesh()

dynamicOversetFvMesh ( const IOobject io,
const bool  doInit = true 
)

Construct from IOobject.

Definition at line 530 of file dynamicOversetFvMesh.C.

References dynamicOversetFvMesh::init().

Here is the call graph for this function:

◆ ~dynamicOversetFvMesh()

~dynamicOversetFvMesh ( )
virtual

Destructor.

Definition at line 564 of file dynamicOversetFvMesh.C.

Member Function Documentation

◆ updateAddressing()

◆ write()

◆ interpolate() [1/13]

void interpolate ( Field< T > &  psi) const
protected

Explicit interpolation of acceptor cells from donor cells.

Definition at line 40 of file dynamicOversetFvMeshTemplates.C.

References cellIDs, cellCellStencilObject::cellInterpolationMap(), cellCellStencilObject::cellInterpolationWeight(), cellCellStencilObject::cellInterpolationWeights(), cellCellStencilObject::cellStencil(), f(), forAll, cellCellStencilObject::interpolationCells(), UPstream::msgType(), primitiveMesh::nCells(), Time::New(), overlap, psi, s(), UList< T >::size(), and T.

Here is the call graph for this function:

◆ interpolate() [2/13]

void interpolate ( GeoField &  psi) const
protected

Explicit interpolation of acceptor cells from donor cells with.

boundary condition handling

Definition at line 80 of file dynamicOversetFvMeshTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::interpolate(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and psi.

Here is the call graph for this function:

◆ baseName()

Foam::word baseName ( const word name)
staticprotected

Helper: strip off trailing _0.

Definition at line 635 of file dynamicOversetFvMesh.C.

References string::ends_with(), and Foam::name().

Here is the call graph for this function:

◆ interpolate() [3/13]

void interpolate ( const wordHashSet suppressed)
protected

Explicit interpolation of all registered fields. Excludes.

selected fields (and their old-time fields)

Definition at line 88 of file dynamicOversetFvMeshTemplates.C.

References Foam::endl(), HashTable< T, Key, Hash >::found(), Foam::interpolate(), Foam::name(), and Foam::Pout.

Here is the call graph for this function:

◆ normalisation() [1/2]

tmp< scalarField > normalisation ( const fvMatrix< Type > &  m) const
protected

Freeze values at holes.

template<class Type> void freezeHoles(fvMatrix<Type>&) const; Get scalar interfaces of certain type

template<class GeoField, class PatchType> lduInterfaceFieldPtrsList scalarInterfaces(const GeoField& psi) const; Determine normalisation for interpolation. This equals the

original diagonal except stabilised for zero diagonals (possible in hole cells)

◆ addInterpolation()

◆ solve() [1/6]

SolverPerformance< Type > solve ( fvMatrix< Type > &  ,
const dictionary  
) const
protected

Solve given dictionary with settings.

◆ correctCoupledBoundaryConditions()

void correctCoupledBoundaryConditions ( GeoField &  fld)
staticprotected

Debug: correct coupled bc.

Definition at line 902 of file dynamicOversetFvMeshTemplates.C.

References coupled(), UPstream::defaultCommsType, fld(), forAll, UPstream::nonBlocking, UPstream::nRequests(), UPstream::parRun(), and UPstream::waitRequests().

Here is the call graph for this function:

◆ cellAverage()

Foam::scalar cellAverage ( const labelList types,
const labelList nbrTypes,
const scalarField norm,
const scalarField nbrNorm,
const label  celli,
bitSet isFront 
) const
protected

Average norm of valid neighbours.

Definition at line 363 of file dynamicOversetFvMesh.C.

References cells, n, and bitSet::set().

Here is the call graph for this function:

◆ writeAgglomeration()

◆ TypeName()

TypeName ( "dynamicOversetFvMesh"  )

Runtime type information.

◆ primitiveLduAddr()

const Foam::fvMeshPrimitiveLduAddressing & primitiveLduAddr ( ) const

Return extended ldu addressing.

Definition at line 603 of file dynamicOversetFvMesh.C.

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

Referenced by dynamicOversetFvMesh::active().

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

◆ lduAddr()

const Foam::lduAddressing & lduAddr ( ) const
virtual

Return ldu addressing. If active: is (extended)

primitiveLduAddr

Reimplemented from fvMesh.

Definition at line 570 of file dynamicOversetFvMesh.C.

References faMesh::lduAddr().

Here is the call graph for this function:

◆ interfaces()

Foam::lduInterfacePtrsList interfaces ( ) const
virtual

Return a list of pointers for each patch.

with only those pointing to interfaces being set. If active: return additional remoteStencilInterfaces_

Reimplemented from fvMesh.

Definition at line 586 of file dynamicOversetFvMesh.C.

References faBoundaryMesh::interfaces().

Here is the call graph for this function:

◆ reverseFaceMap()

const labelList & reverseFaceMap ( ) const
inline

Return old to new face addressing.

Definition at line 213 of file dynamicOversetFvMesh.H.

References dynamicOversetFvMesh::reverseFaceMap_.

◆ active() [1/2]

bool active ( ) const
inline

Return true if using extended addressing.

Definition at line 219 of file dynamicOversetFvMesh.H.

References dynamicOversetFvMesh::active_.

◆ active() [2/2]

void active ( const bool  f) const
inline

Enable/disable extended addressing.

Definition at line 225 of file dynamicOversetFvMesh.H.

References dynamicOversetFvMesh::active_, DebugInfo, Foam::endl(), f(), fvMesh::lduAddr(), lduAddressing::lowerAddr(), fvMeshPrimitiveLduAddressing::lowerAddr(), dynamicOversetFvMesh::primitiveLduAddr(), and UList< T >::size().

Here is the call graph for this function:

◆ interpolate() [4/13]

virtual void interpolate ( scalarField ) const
inlinevirtual

Interpolate interpolationCells only. No bcs.

Reimplemented from fvMesh.

Definition at line 248 of file dynamicOversetFvMesh.H.

References psi.

◆ interpolate() [5/13]

virtual void interpolate ( vectorField ) const
inlinevirtual

Interpolate interpolationCells only. No bcs.

Reimplemented from fvMesh.

Definition at line 253 of file dynamicOversetFvMesh.H.

References psi.

◆ interpolate() [6/13]

virtual void interpolate ( sphericalTensorField ) const
inlinevirtual

Interpolate interpolationCells only. No bcs.

Reimplemented from fvMesh.

Definition at line 258 of file dynamicOversetFvMesh.H.

References psi.

◆ interpolate() [7/13]

virtual void interpolate ( symmTensorField ) const
inlinevirtual

Interp