|
| | mirrorFvMesh (const IOobject &io) |
| | Construct from IOobject, using system mirrorMeshDict.
|
| | mirrorFvMesh (const IOobject &io, const IOdictionary &mirrorDict) |
| | Construct from IOobject and specified mirrorMeshDict.
|
| | ~mirrorFvMesh ()=default |
| | Destructor.
|
| const fvMesh & | mirrorMesh () const |
| | Return reference to mirror mesh.
|
| const labelList & | cellMap () const |
| | Mirrorred to original cell.
|
| const labelList & | pointMap () const |
| | Mirrorred to original point.
|
| | ClassName ("fvMesh") |
| | fvMesh (const IOobject &io, const bool doInit=true) |
| | Construct from IOobject.
|
| | fvMesh (const IOobject &io, const Foam::zero, bool syncPar=true) |
| | Construct from IOobject or as zero-sized mesh.
|
| | fvMesh (const IOobject &io, const fvMesh &baseMesh, const Foam::zero, const bool syncPar=true) |
| | Construct as copy (for dictionaries) and zero-sized components.
|
| | fvMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&allOwner, labelList &&allNeighbour, const bool syncPar=true) |
| | Construct from components without boundary.
|
| | fvMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true) |
| | Construct without boundary from cells rather than owner/neighbour.
|
| | 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.
|
| | 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.
|
| virtual | ~fvMesh () |
| | Destructor.
|
| virtual bool | init (const bool doInit) |
| | Initialise all non-demand-driven data.
|
| void | addFvPatches (polyPatchList &plist, const bool validBoundary=true) |
| | Add boundary patches. Constructor helper.
|
| void | addFvPatches (const List< polyPatch * > &p, const bool validBoundary=true) |
| | Add boundary patches. Constructor helper.
|
| virtual readUpdateState | readUpdate () |
| | Update the mesh based on the mesh files saved in time.
|
| const Time & | time () const |
| | Return the top-level database.
|
| virtual bool | hasDb () const |
| | Return true if thisDb() is a valid DB.
|
| virtual const objectRegistry & | thisDb () const |
| | Return the object registry - resolve conflict polyMesh/lduMesh.
|
| const word & | name () const |
| | Return reference to name.
|
| const fvBoundaryMesh & | boundary () const noexcept |
| | Return reference to boundary mesh.
|
| virtual const lduAddressing & | lduAddr () const |
| | Return ldu addressing.
|
| virtual lduInterfacePtrsList | interfaces () const |
| | Return a list of pointers for each patch.
|
| virtual label | comm () const |
| | Return communicator used for parallel communication.
|
| const fvSchemes * | hasSchemes () const |
| | Non-null if fvSchemes exists (can test as bool).
|
| const fvSolution * | hasSolution () const |
| | Non-null if fvSolution exists (can test as bool).
|
| const fvSchemes & | schemes () const |
| | Read-access to the fvSchemes controls.
|
| fvSchemes & | schemes () |
| | Read/write-access to the fvSchemes controls.
|
| const fvSolution & | solution () const |
| | Read-access to the fvSolution controls.
|
| fvSolution & | solution () |
| | Read/write-access to the fvSolution controls.
|
| virtual void | interpolate (volScalarField &) const |
| | Interpolate interpolationCells only.
|
| virtual void | interpolate (volVectorField &) const |
| | Interpolate interpolationCells only.
|
| virtual void | interpolate (volSphericalTensorField &) const |
| | Interpolate interpolationCells only.
|
| virtual void | interpolate (volSymmTensorField &) const |
| | Interpolate interpolationCells only.
|
| virtual void | interpolate (volTensorField &) const |
| | Interpolate interpolationCells only.
|
| virtual void | interpolate (scalarField &) const |
| | Interpolate interpolationCells only. No bcs.
|
| virtual void | interpolate (vectorField &) const |
| | Interpolate interpolationCells only. No bcs.
|
| virtual void | interpolate (sphericalTensorField &) const |
| | Interpolate interpolationCells only. No bcs.
|
| virtual void | interpolate (symmTensorField &) const |
| | Interpolate interpolationCells only. No bcs.
|
| virtual void | interpolate (tensorField &) const |
| | Interpolate interpolationCells only. No bcs.
|
| virtual SolverPerformance< scalar > | solve (fvMatrix< scalar > &, const dictionary &) const |
| | Solve returning the solution statistics given convergence tolerance. Use the given solver controls.
|
| virtual SolverPerformance< vector > | solve (fvMatrix< vector > &, const dictionary &) const |
| | Solve returning the solution statistics given convergence tolerance. Use the given solver controls.
|
| virtual SolverPerformance< sphericalTensor > | solve (fvMatrix< sphericalTensor > &, const dictionary &) const |
| | Solve returning the solution statistics given convergence tolerance. Use the given solver controls.
|
| virtual SolverPerformance< symmTensor > | solve (fvMatrix< symmTensor > &, const dictionary &) const |
| | Solve returning the solution statistics given convergence tolerance. Use the given solver controls.
|
| virtual SolverPerformance< tensor > | solve (fvMatrix< tensor > &, const dictionary &) const |
| | Solve returning the solution statistics given convergence tolerance. Use the given solver controls.
|
| const labelUList & | owner () const |
| | Internal face owner. Note bypassing virtual mechanism so.
|
| const labelUList & | neighbour () const |
| | Internal face neighbour.
|
| const DimensionedField< scalar, volMesh > & | V () const |
| | Return cell volumes.
|
| const DimensionedField< scalar, volMesh > & | V0 () const |
| | Return old-time cell volumes.
|
| const DimensionedField< scalar, volMesh > & | V00 () const |
| | Return old-old-time cell volumes.
|
| tmp< DimensionedField< scalar, volMesh > > | Vsc () const |
| | Return sub-cycle cell volumes.
|
| tmp< DimensionedField< scalar, volMesh > > | Vsc0 () const |
| | Return sub-cycle old-time cell volumes.
|
| const surfaceVectorField & | Sf () const |
| | Return cell face area vectors.
|
| const surfaceScalarField & | magSf () const |
| | Return cell face area magnitudes.
|
| tmp< surfaceVectorField > | unitSf () const |
| | Return cell face unit normals.
|
| const surfaceScalarField & | phi () const |
| | Return cell face motion fluxes.
|
| const volVectorField & | C () const |
| | Return cell centres as volVectorField.
|
| const surfaceVectorField & | Cf () const |
| | Return face centres as surfaceVectorField.
|
| tmp< surfaceVectorField > | delta () const |
| | Return face deltas as surfaceVectorField.
|
| template<class Type> |
| pTraits< Type >::labelType | validComponents () const |
| | Return a labelType of valid component indicators.
|
| void | clearOut (const bool isMeshUpdate=false) |
| | Clear all geometry and addressing.
|
| virtual void | updateMesh (const mapPolyMesh &mpm) |
| | Update mesh corresponding to the given map.
|
| virtual void | movePoints (const pointField &) |
| | Move points, returns volumes swept by faces in motion.
|
| virtual void | updateGeom () |
| | Update all geometric data. This gets redirected up from primitiveMesh level.
|
| virtual void | mapFields (const mapPolyMesh &mpm) |
| | Map all fields in time using given map.
|
| void | removeFvBoundary () |
| | Remove boundary patches. Warning: fvPatchFields hold ref to these fvPatches.
|
| void | clearMeshPhi () |
| | Clear cell face motion fluxes.
|
| refPtr< surfaceScalarField > | setPhi () |
| | Return cell face motion fluxes, if any (can be nullptr).
|
| DimensionedField< scalar, volMesh > & | setV0 () |
| | Return old-time cell volumes.
|
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| | Write the underlying polyMesh and other data.
|
| virtual bool | write (const bool writeOnProc=true) const |
| | Write mesh using IO settings from time.
|
| bool | operator!= (const fvMesh &rhs) const |
| | Compares addresses.
|
| bool | operator== (const fvMesh &rhs) const |
| | Compares addresses.
|
| template<> |
| pTraits< sphericalTensor >::labelType | validComponents () const |
| template<class Type> |
| Foam::pTraits< Type >::labelType | validComponents () const |
| virtual bool | movePoints () |
| | Avoid masking surfaceInterpolation method.
|
| | TypeName ("polyMesh") |
| | Runtime type information.
|
| | polyMesh (const IOobject &io, const bool doInit=true) |
| | Read construct from IOobject.
|
| | polyMesh (const IOobject &io, const Foam::zero, const bool syncPar=true) |
| | Construct from IOobject or as zero-sized mesh.
|
| | polyMesh (const IOobject &io, pointField &&points, faceList &&faces, labelList &&owner, labelList &&neighbour, const bool syncPar=true) |
| | Construct from IOobject and components.
|
| | polyMesh (const IOobject &io, pointField &&points, faceList &&faces, cellList &&cells, const bool syncPar=true) |
| | Construct without boundary with cells rather than owner/neighbour.
|
| | 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.
|
| | polyMesh (const IOobject &io, pointField &&points, const cellShapeList &shapes, const faceListList &boundaryFaces, const wordList &boundaryPatchNames, const PtrList< dictionary > &boundaryDicts, const word &defaultBoundaryPatchName, const word &defaultBoundaryPatchType, const bool syncPar=true) |
| | Construct from cell shapes, with patch information in dictionary format.
|
| virtual | ~polyMesh () |
| | Destructor.
|
| virtual const fileName & | dbDir () const |
| | Override the objectRegistry dbDir for a single-region case.
|
| fileName | meshDir () const |
| | Return the local mesh directory (dbDir()/meshSubDir).
|
| const fileName & | pointsInstance () const |
| | Return the current instance directory for points.
|
| const fileName & | facesInstance () const |
| | Return the current instance directory for faces.
|
| void | setInstance (const fileName &instance, const IOobjectOption::writeOption wOpt=IOobject::AUTO_WRITE) |
| | Set the instance for mesh files.
|
| const word & | regionName () const |
| | The mesh region name or word::null if polyMesh::defaultRegion.
|
| virtual const meshState & | data () const noexcept |
| | Const reference to the mesh and solver state data.
|
| virtual meshState & | data () noexcept |
| | Reference to the mesh and solver state data.
|
| virtual const pointField & | points () const |
| | Return raw points.
|
| virtual bool | upToDatePoints (const regIOobject &io) const |
| | Return true if io is up-to-date with points.
|
| virtual void | setUpToDatePoints (regIOobject &io) const |
| | Set io to be up-to-date with points.
|
| virtual const faceList & | faces () const |
| | Return raw faces.
|
| virtual const labelList & | faceOwner () const |
| | Return face owner.
|
| virtual const labelList & | faceNeighbour () const |
| | Return face neighbour.
|
| virtual const pointField & | oldPoints () const |
| | Return old points (mesh motion).
|
| virtual const pointField & | oldCellCentres () const |
| | Return old cellCentres (mesh motion).
|
| const polyBoundaryMesh & | boundaryMesh () const noexcept |
| | Return boundary mesh.
|
| const boundBox & | bounds () const noexcept |
| | Return mesh bounding box.
|
| const Vector< label > & | geometricD () const |
| | Return the vector of geometric directions in mesh.
|
| label | nGeometricD () const |
| | Return the number of valid geometric dimensions in the mesh.
|
| const Vector< label > & | solutionD () const |
| | Return the vector of solved-for directions in mesh.
|
| label | nSolutionD () const |
| | Return the number of valid solved-for dimensions in the mesh.
|
| const labelIOList & | tetBasePtIs () const |
| | Return the tetBasePtIs.
|
| const indexedOctree< treeDataCell > & | cellTree () const |
| | Return the cell search tree.
|
| const pointZoneMesh & | pointZones () const noexcept |
| | Return point zone mesh.
|
| const faceZoneMesh & | faceZones () const noexcept |
| | Return face zone mesh.
|
| const cellZoneMesh & | cellZones () const noexcept |
| | Return cell zone mesh.
|
| const objectRegistry & | thisDb () const noexcept |
| | Return the object registry.
|
| label | comm () const noexcept |
| | The communicator used for parallel communication.
|
| label & | comm () noexcept |
| | The communicator used for parallel communication.
|
| bool | hasGlobalData () const noexcept |
| | Is demand-driven parallel info available?
|
| const globalMeshData & | globalData () const |
| | Return parallel info (demand-driven).
|
| virtual bool | dynamic () const |
| | Is mesh dynamic.
|
| bool | moving () const noexcept |
| | Is mesh moving.
|
| bool | moving (const bool on) noexcept |
| | Set the mesh to be moving.
|
| bool | topoChanging () const noexcept |
| | Is mesh topology changing.
|
| bool | topoChanging (const bool on) noexcept |
| | Set the mesh topology to be changing.
|
| bool | changing () const noexcept |
| | Is mesh changing (topology changing and/or moving).
|
| void | resetMotion () const |
| | Reset motion.
|
| pointZoneMesh & | pointZones () noexcept |
| | Return non-const access to the pointZones.
|
| faceZoneMesh & | faceZones () noexcept |
| | Return non-const access to the faceZones.
|
| cellZoneMesh & | cellZones () noexcept |
| | Return non-const access to the cellZones.
|
| void | addPatches (polyPatchList &plist, const bool validBoundary=true) |
| | Add boundary patches.
|
| void | addPatches (const List< polyPatch * > &p, const bool validBoundary=true) |
| | Add boundary patches.
|
| void | addZones (PtrList< pointZone > &&pz, PtrList< faceZone > &&fz, PtrList< cellZone > &&cz) |
| | Add mesh zones.
|
| void | addZones (const List< pointZone * > &pz, const List< faceZone * > &fz, const List< cellZone * > &cz) |
| | Add mesh zones.
|
| void | removeBoundary () |
| | Remove boundary patches.
|
| 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.
|
| void | clearGeom () |
| | Clear geometry.
|
| void | updateGeomPoints (pointIOField &&newPoints, autoPtr< labelIOList > &newTetBasePtIsPtr) |
| | Update geometry points; keep topology. Optionally with new face decomposition.
|
| void | clearAddressing (const bool isMeshUpdate=false) |
| | Clear addressing.
|
| void | clearOut (const bool isMeshUpdate=false) |
| | Clear all geometry and addressing.
|
| void | clearPrimitives () |
| | Clear primitive data (points, faces and cells).
|
| void | clearTetBasePtIs () |
| | Clear tet base points.
|
| void | clearCellTree () |
| | Clear cell tree data.
|
| void | removeFiles (const fileName &instanceDir) const |
| | Remove all files from mesh instance.
|
| void | removeFiles () const |
| | Remove all files from mesh instance().
|
| bool | hasTetBasePtIs () const |
| virtual bool | checkFaceOrthogonality (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check non-orthogonality.
|
| virtual bool | checkFaceSkewness (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check face skewness.
|
| virtual bool | checkEdgeAlignment (const bool report, const Vector< label > &directions, labelHashSet *setPtr) const |
| | Check edge alignment for 1D/2D cases.
|
| 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.
|
| virtual bool | checkFaceWeight (const bool report, const scalar minWeight=0.05, labelHashSet *setPtr=nullptr) const |
| | Check for face weights.
|
| virtual bool | checkVolRatio (const bool report, const scalar minRatio=0.01, labelHashSet *setPtr=nullptr) const |
| | Check for neighbouring cell volumes.
|
| void | findCellFacePt (const point &p, label &celli, label &tetFacei, label &tetPti) const |
| | Find the cell, tetFacei and tetPti for point p.
|
| void | findTetFacePt (const label celli, const point &p, label &tetFacei, label &tetPti) const |
| | Find the tetFacei and tetPti for point p in celli.
|
| bool | pointInCell (const point &p, label celli, const cellDecomposition=CELL_TETS) const |
| | Test if point p is in the celli.
|
| label | findCell (const point &p, const cellDecomposition=CELL_TETS) const |
| | Find cell enclosing this location and return index.
|
| | TypeName ("objectRegistry") |
| | Declare type name for this IOobject.
|
| | objectRegistry (const Time &db, const label initialCapacity=128) |
| | Construct the time objectRegistry, with estimated table capacity (default: 128).
|
| | objectRegistry (const IOobject &io, const label initialCapacity=128) |
| | Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128).
|
| virtual | ~objectRegistry () |
| | Destructor, with checkOut() for all objects that are ownedByRegistry.
|
| const objectRegistry & | thisDb () const noexcept |
| | Return the object registry.
|
| const objectRegistry & | parent () const noexcept |
| | Return the parent objectRegistry.
|
| const Time & | time () const noexcept |
| | Return time registry.
|
| bool | isTimeDb () const noexcept |
| | True if the registry is Time.
|
| IOobject | newIOobject (const word &name, IOobjectOption ioOpt) const |
| | Create an IOobject at the current time instance (timeName) with the specified options.
|
| IOobject | newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const |
| | Create an IOobject at the current time instance (timeName).
|
| HashTable< wordHashSet > | classes () const |
| | A summary hash of classes used and their associated object names.
|
| template<class MatchPredicate> |
| HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
| | A summary hash of classes used and their associated object names, restricted to objects that have a matching object name.
|
| template<class Type, bool Strict = false> |
| UPtrList< const Type > | cobjects () const |
| | Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| template<class Type, bool Strict = false> |
| UPtrList< Type > | objects () |
| | Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| template<class Type, class MatchPredicate> |
| UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
| | Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name.
|
| template<class Type, class MatchPredicate> |
| UPtrList< Type > | objects (const MatchPredicate &matchName) |
| | Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.
|
| template<class Type, bool Strict = false> |
| UPtrList< const Type > | csorted () const |
| | Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| template<class Type, bool Strict = false> |
| UPtrList< Type > | sorted () |
| | Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| UPtrList< const regIOobject > | csorted () const |
| | Return sorted list of objects.
|
| UPtrList< regIOobject > | sorted () |
| | Return sorted list of objects.
|
| template<class Type, class MatchPredicate> |
| UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
| | Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.
|
| template<class Type, class MatchPredicate> |
| UPtrList< Type > | sorted (const MatchPredicate &matchName) |
| | Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.
|
| label | count (const char *clsName) const |
| | The number of objects of the given class name.
|
| template<class MatchPredicate> |
| label | count (const MatchPredicate &matchClass) const |
| | The number of objects of the given class name.
|
| template<class MatchPredicate1, class MatchPredicate2> |
| label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| | The number of objects of the given class name.
|
| template<class Type> |
| label | count (const bool strict=false) const |
| | The names of objects with a class satisfying isA<Type>.
|
| template<class Type, class MatchPredicate> |
| label | count (const MatchPredicate &matchName) const |
| | The names of objects with a class satisfying isA<Type> that also have a matching object name.
|
| wordList | names () const |
| | The unsorted names of all objects.
|
| wordList | names (const char *clsName) const |
| | The unsorted names of objects with the given class name.
|
| template<class MatchPredicate> |
| wordList | names (const MatchPredicate &matchClass) const |
| | The unsorted names of objects with a matching class name.
|
| template<class MatchPredicate1, class MatchPredicate2> |
| wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| | The unsorted names of objects with a matching class name that also have a matching object name.
|
| template<class Type> |
| wordList | names () const |
| | The unsorted names of objects with a class satisfying isA<Type>.
|
| template<class Type, class MatchPredicate> |
| wordList | names (const MatchPredicate &matchName) const |
| | The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name.
|
| wordList | sortedNames () const |
| | The sorted names of all objects.
|
| wordList | sortedNames (const char *clsName) const |
| | The sorted names of objects with the given class name.
|
| template<class MatchPredicate> |
| wordList | sortedNames (const MatchPredicate &matchClass) const |
| | The sorted names objects with a matching class name.
|
| template<class MatchPredicate1, class MatchPredicate2> |
| wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| | The sorted names of objects with a matching class name that also have a matching object name.
|
| template<class Type> |
| wordList | sortedNames () const |
| | The sorted names of objects with a class satisfying isA<Type>.
|
| template<class Type, class MatchPredicate> |
| wordList | sortedNames (const MatchPredicate &matchName) const |
| | The sorted names of objects with a class satisfying isA<Type> that also have a matching object name.
|
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
| | Lookup and return a const sub-objectRegistry.
|
| template<class Type, bool Strict = false> |
| HashTable< const Type * > | lookupClass () const |
| | Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| template<class Type, bool Strict = false> |
| HashTable< Type * > | lookupClass () |
| | Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict).
|
| template<class Type> |
| HashTable< const Type * > | lookupClass (const bool strict) const |
| | Return all objects with a class satisfying isA<Type>.
|
| template<class Type> |
| HashTable< Type * > | lookupClass (const bool strict) |
| | Return all objects with a class satisfying isA<Type>.
|
| const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
| | Return const pointer to the regIOobject.
|
| bool | contains (const word &name, const bool recursive=false) const |
| | Does the registry contain the regIOobject object (by name).
|
| template<class Type> |
| bool | foundObject (const word &name, const bool recursive=false) const |
| | Contains the named Type?
|
| template<class Type> |
| const Type * | cfindObject (const word &name, const bool recursive=false) const |
| | Return const pointer to the object of the given Type.
|
| template<class Type> |
| const Type * | findObject (const word &name, const bool recursive=false) const |
| | Return const pointer to the object of the given Type.
|
| template<class Type> |
| Type * | findObject (const word &name, const bool recursive=false) |
| | Return non-const pointer to the object of the given Type.
|
| template<class Type> |
| Type * | getObjectPtr (const word &name, const bool recursive=false) const |
| | Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
|
| template<class Type> |
| const Type & | lookupObject (const word &name, const bool recursive=false) const |
| | Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type.
|
| template<class Type> |
| Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
| | Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type.
|
| label | getEvent () const |
| | Return new event number.
|
| bool | checkIn (regIOobject *io) const |
| | Add a regIOobject to registry. A nullptr is ignored.
|
| bool | checkIn (regIOobject &io) const |
| | Add a regIOobject to registry.
|
| bool | checkOut (regIOobject *io) const |
| | Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored.
|
| bool | checkOut (regIOobject &io) const |
| | Remove a regIOobject from registry and free memory if the object is ownedByRegistry.
|
| bool | checkOut (const word &key) const |
| | Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry.
|
| void | clear () |
| | Clear all entries from the registry.
|
| void | clearStorage () |
| | Clear all entries from the registry and the table itself.
|
| bool | erase (const iterator &iter) |
| | Erase an entry specified by the given iterator.
|
| bool | erase (const word &key) |
| | Erase an entry specified by the given key.
|
| label | erase (std::initializer_list< word > keys) |
| | Remove entries given by the listed keys.
|
| label | erase (const UList< word > &keys) |
| | Remove entries given by the listed keys.
|
| virtual void | rename (const word &newName) |
| | Rename.
|
| bool | is_cacheTemporaryObject (const word &name) const |
| | True if given name is in the cacheTemporaryObjects set.
|
| bool | is_cacheTemporaryObject (const regIOobject *io) const |
| | True if name of object is in the cacheTemporaryObjects set.
|
| bool | is_cacheTemporaryObject (const regIOobject &io) const |
| | True if name of object is in the cacheTemporaryObjects set.
|
| template<class Type> |
| bool | cacheTemporaryObject (Type &obj) const |
| | Cache the given object. Moves content and stores.
|
| void | resetCacheTemporaryObject (const regIOobject *io) const |
| | Reset the cache state of the given object (nullptr is ignored).
|
| void | resetCacheTemporaryObject (const regIOobject &io) const |
| | Reset the cache state of the given object in the cacheTemporaryObjects set.
|
| bool | checkCacheTemporaryObjects () const |
| | Check that all objects specified in the cacheTemporaryObjects were also cached.
|
| virtual bool | modified () const |
| | Return true if any of the object's files have been modified.
|
| void | readModifiedObjects () |
| | Read the objects that have been modified.
|
| virtual bool | readIfModified () |
| | Read object if modified.
|
| virtual bool | writeData (Ostream &) const |
| | The writeData function is required by regIOobject but not used.
|
| bool | found (const word &name, bool recursive=false) const |
| | Same as contains().
|
| template<class Type> |
| const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
| | Deprecated(2018-10) find object.
|
| template<class Type> |
| Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
| | Deprecated(2018-10) get object pointer, ignoring constness.
|
| template<class Type> |
| UPtrList< const Type > | sorted () const |
| | Deprecated(2023-07) use csorted() method.
|
| UPtrList< const regIOobject > | sorted () const |
| | Deprecated(2023-07) use csorted() method.
|
| template<class Type, class MatchPredicate> |
| UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
| | Deprecated(2023-07) use csorted() method.
|
| template<class MatchPredicate> |
| Foam::HashTable< Foam::wordHashSet > | classesImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1, class MatchPredicate2> |
| Foam::label | countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) |
| template<class Type, class MatchPredicate> |
| Foam::label | countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1, class MatchPredicate2> |
| Foam::wordList | namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort) |
| template<class Type, class MatchPredicate> |
| Foam::wordList | namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class Type, class MatchPredicate> |
| Foam::UPtrList< Type > | objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class Type> |
| Foam::HashTable< Type * > | lookupClassTypeImpl (const bool strict, const objectRegistry &list) |
| template<class MatchPredicate> |
| Foam::HashTable< Foam::wordHashSet > | classes (const MatchPredicate &matchName) const |
| template<class MatchPredicate> |
| Foam::label | count (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> |
| Foam::label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type, class MatchPredicate> |
| Foam::label | count (const MatchPredicate &matchName) const |
| template<class Type> |
| Foam::label | count (const bool strict) const |
| template<class Type, bool Strict> |
| Foam::UPtrList< const Type > | cobjects () const |
| template<class Type, bool Strict> |
| Foam::UPtrList< Type > | objects () |
| template<class Type, bool Strict> |
| Foam::UPtrList< const Type > | csorted () const |
| template<class Type, bool Strict> |
| Foam::UPtrList< Type > | sorted () |
| template<class Type, class MatchPredicate> |
| Foam::UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> |
| Foam::UPtrList< Type > | objects (const MatchPredicate &matchName) |
| template<class Type, class MatchPredicate> |
| Foam::UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> |
| Foam::UPtrList< Type > | sorted (const MatchPredicate &matchName) |
| template<class MatchPredicate> |
| Foam::wordList | names (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> |
| Foam::wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type> |
| Foam::wordList | names () const |
| template<class Type, class MatchPredicate> |
| Foam::wordList | names (const MatchPredicate &matchName) const |
| template<class MatchPredicate> |
| Foam::wordList | sortedNames (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> |
| Foam::wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type> |
| Foam::wordList | sortedNames () const |
| template<class Type, class MatchPredicate> |
| Foam::wordList | sortedNames (const MatchPredicate &matchName) const |
| template<class Type, bool Strict> |
| Foam::HashTable< const Type * > | lookupClass () const |
| template<class Type, bool Strict> |
| Foam::HashTable< Type * > | lookupClass () |
| template<class Type> |
| Foam::HashTable< const Type * > | lookupClass (const bool strict) const |
| template<class Type> |
| Foam::HashTable< Type * > | lookupClass (const bool strict) |
| void | operator= (const regIOobject &)=delete |
| | No copy assignment.
|
| | TypeName ("regIOobject") |
| | Runtime type information.
|
| | regIOobject (const IOobject &io, const bool isTimeObject=false) |
| | Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
|
| | regIOobject (const regIOobject &rio) |
| | Copy construct.
|
| | regIOobject (const regIOobject &rio, bool registerCopy) |
| | Copy construct, transferring registry registration to the copy if registerCopy is true.
|
| | regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| | Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
|
| | regIOobject (const IOobject &io, const regIOobject &rio) |
| | Copy construct with new IO parameters.
|
| virtual | ~regIOobject () |
| | Destructor.
|
| bool | checkIn () |
| | Add object to registry, if not already registered.
|
| bool | checkOut () |
| | Remove object from registry, and remove all file watches.
|
| virtual void | addWatch () |
| | Add file watch on object (if registered and READ_IF_MODIFIED).
|
| bool | registered () const noexcept |
| | Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
|
| bool | ownedByRegistry () const noexcept |
| | Is this object owned by the registry?
|
| bool | store () |
| | Register object with its registry and transfer ownership to the registry.
|
| void | release (const bool unregister=false) noexcept |
| | Set object as not ownedByRegistry.
|
| label | eventNo () const noexcept |
| | Event number at last update.
|
| label & | eventNo () noexcept |
| | Event number at last update.
|
| bool | upToDate (const regIOobject &) const |
| | Return true if up-to-date with respect to given object.
|
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| void | setUpToDate () |
| | Set as up-to-date.
|
| const dictionary * | findMetaData () const noexcept |
| | Return pointer to meta-data or nullptr.
|
| dictionary & | getMetaData () noexcept |
| | Get or create meta-data.
|
| void | removeMetaData () |
| | Remove meta-data.
|
| virtual void | updateMetaData () |
| | Update internal meta-data (eg, prior to writing).
|
| bool | headerOk () |
| | Read and check header info. Does not check the headerClassName.
|
| Istream & | readStream (const word &, const bool readOnProc=true) |
| | Return Istream and check object type against that given.
|
| void | close () |
| | Close Istream.
|
| virtual label | addWatch (const fileName &) |
| | Add file watch for fileName on object if not yet watched.
|
| const labelList & | watchIndices () const noexcept |
| | Read access to file-monitoring handles.
|
| labelList & | watchIndices () noexcept |
| | Write access to file-monitoring handles.
|
| void | operator= (const IOobject &io) |
| | Copy assignment.
|
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| | Write using given format, version and compression.
|
| | TypeName ("IOobject") |
| | Declare type-name, virtual type (with debug switch).
|
| | IOobject (const IOobject &)=default |
| | Copy construct.
|
| virtual | ~IOobject ()=default |
| | Destructor.
|
| | IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from name, instance, registry, io options.
|
| | IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from name, instance, local, registry, io options.
|
| | IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from path, registry, io options.
|
| | IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| | Construct from name, instance, registry, io options.
|
| | IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| | Construct from name, instance, local, registry, io options.
|
| | IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| | Construct from path, registry, io options.
|
| | IOobject (const IOobject &io, const objectRegistry ®istry) |
| | Copy construct, resetting registry.
|
| | IOobject (const IOobject &io, const word &name) |
| | Copy construct, resetting name.
|
| | IOobject (const IOobject &io, const word &name, const fileName &local) |
| | Copy construct, resetting name and local component.
|
| | IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) |
| | Copy construct, resetting read/write options.
|
| | IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) |
| | Copy construct, resetting register option.
|
| autoPtr< IOobject > | clone () const |
| | Clone.
|
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| | Clone resetting registry.
|
| const objectRegistry & | db () const noexcept |
| | Return the local objectRegistry.
|
| const Time & | time () const noexcept |
| | Return Time associated with the objectRegistry.
|
| const word & | name () const noexcept |
| | Return the object name.
|
| const word & | headerClassName () const noexcept |
| | Return name of the class name read from header.
|
| word & | headerClassName () noexcept |
| | Modifiable access to the class name read from header.
|
| const string & | note () const noexcept |
| | Return the optional note.
|
| string & | note () noexcept |
| | Modifiable access to the optional note.
|
| unsigned | labelByteSize () const noexcept |
| | The sizeof (label) in bytes, possibly read from the header.
|
| unsigned | scalarByteSize () const noexcept |
| | The sizeof (scalar) in bytes, possibly read from the header.
|
| void | resetHeader (const word &newName=word::null) |
| | Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
|
| bool | hasHeaderClass () const noexcept |
| | True if headerClassName() is non-empty (after reading).
|
| bool | isHeaderClass (const word &expectedType) const |
| | Check if headerClassName() equals the expected type. Always true if the expected type is empty.
|
| template<class Type> |
| bool | isHeaderClass () const |
| | Check if headerClassName() equals Type::typeName Always true for a void type.
|
| word | group () const |
| | Return group (extension part of name).
|
| word | member () const |
| | Return member (name without the extension).
|
| const fileName & | rootPath () const noexcept |
| | Return the Time::rootPath().
|
| const fileName & | caseName () const noexcept |
| | Return the Time::caseName().
|
| const fileName & | globalCaseName () const noexcept |
| | Return the Time::globalCaseName().
|
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| | Return the Time::caseName() - normal or global.
|
| const fileName & | instance () const noexcept |
| | Read access to instance path component.
|
| fileName & | instance () noexcept |
| | Modifiable access to instance path component.
|
| scalar | instanceValue () const |
| | Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
|
| const fileName & | local () const noexcept |
| | Read access to local path component.
|
| fileName & | local () noexcept |
| | Modifiable access to the local path component.
|
| fileName | path () const |
| | The complete path for the object (with instance, local,...).
|
| fileName | globalPath () const |
| | The complete global path for the object (with instance, local,...).
|
| fileName | path (IOobjectOption::Layout) const |
| | The complete path (normal or global) for the object.
|
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| | The complete path with alternative instance and local.
|
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| | The complete global path with alternative instance and local.
|
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| | The complete path (normal or global) with alternative instance and local.
|
| fileName | objectPath () const |
| | The complete path + object name.
|
| fileName | globalObjectPath () const |
| | The complete global path + object name.
|
| fileName | objectPath (IOobjectOption::Layout) const |
| | The complete path (normal or global) + object name.
|
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| | The complete path (normal or global) + object name with alternative instance.
|
| fileName | objectPath (const word &instance) const |
| | The complete path + object name with alternative instance.
|
| fileName | globalObjectPath (const word &instance) const |
| | The complete global path + object name with alternative instance.
|
| fileName | objectRelPath () const |
| | The object path relative to the case.
|
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| | Redirect to fileHandler filePath, searching locally.
|
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| | Redirect to fileHandler filePath, searching up if in parallel.
|
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| | Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
|
| bool | readHeader (Istream &is) |
| | Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
|
| bool | readHeader (dictionary &headerDict, Istream &is) |
| | Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
|
| template<class Type> |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| | Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks.
|
| template<class Type, bool Searching> |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
| | Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.
|
| template<class Type> |
| fileName | typeFilePath (const bool search=true) const |
| | Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
|
| template<class Type> |
| void | warnNoRereading () const |
| | Helper: warn that type does not support re-reading.
|
| bool | writeHeader (Ostream &os) const |
| | Write header with current type().
|
| bool | writeHeader (Ostream &os, const word &objectType) const |
| | Write header with override of type.
|
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| | Write header into a dictionary with current type() and given output format.
|
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| | Write header into a dictionary with override of type and given output format.
|
| bool | good () const noexcept |
| | Did last readHeader() succeed?
|
| bool | bad () const noexcept |
| | Did last readHeader() fail?
|
| InfoProxy< IOobject > | info () const noexcept |
| | Return info proxy, for printing information to a stream.
|
| void | operator= (const IOobject &io) |
| | Copy assignment, copies all values (except the registry).
|
| template<class Type> |
| bool | isHeaderClassName () const |
| | Same as isHeaderClass().
|
| template<class StringType> |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> |
| Foam::fileName | typeFilePath (const bool search) const |
| constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| | Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
|
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| | Construct NO_WRITE with specified read/register options.
|
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| | Construct NO_READ with specified write/register options.
|
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| | Construct (NO_READ, NO_WRITE) with specified register option.
|
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| | Construct from components with specified register option as bool.
|
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| | Construct (NO_READ, NO_WRITE) with specified register option as bool.
|
| readOption | readOpt () const noexcept |
| | Get the read option.
|
| readOption | readOpt (readOption opt) noexcept |
| | Set the read option.
|
| writeOption | writeOpt () const noexcept |
| | Get the write option.
|
| writeOption | writeOpt (writeOption opt) noexcept |
| | Set the write option.
|
| bool | registerObject () const noexcept |
| | Should objects created with this IOobject be registered?
|
| bool | registerObject (bool on) noexcept |
| | Change registration preference.
|
| bool | globalObject () const noexcept |
| | True if object is treated the same for all processors.
|
| bool | globalObject (bool on) noexcept |
| | Change global-object status.
|
| bool | isAnyRead () const noexcept |
| | True if any reading may be required (ie, != NO_READ).
|
| bool | isReadRequired () const noexcept |
| | True if (MUST_READ | READ_MODIFIED) bits are set.
|
| bool | isReadOptional () const noexcept |
| | True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
|
| readOption & | readOpt () noexcept |
| | Access to the read option.
|
| writeOption & | writeOpt () noexcept |
| | Access to the write option.
|
| bool & | registerObject () noexcept |
| | Access to the register object option.
|
| bool & | globalObject () noexcept |
| | Access to the global object option.
|
| Foam::List< word > | sortedToc (const Compare &comp) const |
| Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< word, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| constexpr | HashTable () noexcept |
| | Default construct: empty without allocation (capacity=0).
|
| | ~HashTable () |
| | Destructor.
|
| bool | empty () const noexcept |
| | True if the hash table is empty.
|
| label | size () const noexcept |
| | The number of elements in table.
|
| label | capacity () const noexcept |
| | The size of the underlying table (the number of buckets).
|
| regIOobject *& | at (const word &key) |
| | Find and return a hashed entry. FatalError if it does not exist.
|
| bool | contains (const word &key) const |
| | True if hashed key is contained (found) in table.
|
| iterator | find (const word &key) |
| | Find and return an iterator set at the hashed entry.
|
| const_iterator | cfind (const word &key) const |
| | Find and return an const_iterator set at the hashed entry.
|
| const regIOobject *& | lookup (const word &key, const regIOobject *&deflt) const |
| | Return hashed entry if it exists, or return the given default.
|
| List< word > | toc () const |
| | The table of contents (the keys) in unsorted order.
|
| UPtrList< const node_type > | csorted () const |
| | Const access to the hash-table contents in sorted order (sorted by keys).
|
| UPtrList< node_type > | sorted () |
| | Non-const access to the hash-table contents in sorted order (sorted by keys).
|
| bool | emplace (const word &key, Args &&... args) |
| | Emplace insert a new entry, not overwriting existing entries.
|
| bool | emplace_set (const word &key, Args &&... args) |
| | Emplace set an entry, overwriting any existing entries.
|
| bool | insert (const word &key, const regIOobject *&obj) |
| | Copy insert a new entry, not overwriting existing entries.
|
| bool | set (const word &key, const regIOobject *&obj) |
| | Copy assign a new entry, overwriting existing entries.
|
| void | clear () |
| | Remove all entries from table.
|
| void | clearStorage () |
| | Remove all entries from table and the table itself.
|
| void | setCapacity (label newCapacity) |
| | Change the hash table capacity (number of buckets).
|
| void | resize (label newCapacity) |
| | Rehash the hash table with new number of buckets. Currently identical to setCapacity().
|
| void | reserve (label numEntries) |
| | Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.
|
| void | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept |
| | Swap contents into this table.
|
| void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
| | Transfer contents into this table.
|
| void | merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source) |
| | Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged.
|
| regIOobject *& | operator[] (const word &key) |
| | Find and return a hashed entry. FatalError if it does not exist.
|
| regIOobject *& | operator() (const word &key) |
| | Return existing entry or create a new entry.
|
| void | operator= (const this_type &rhs) |
| | Copy assign.
|
| bool | operator== (const this_type &rhs) const |
| | Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size.
|
| bool | operator!= (const this_type &rhs) const |
| | The opposite of the equality operation.
|
| this_type & | operator+= (const this_type &rhs) |
| | Add entries into this HashTable.
|
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| | A const iterator begin/end pair for iterating over keys.
|
| iterator | begin () |
| | iterator set to the beginning of the HashTable
|
| const_iterator | cbegin () const |
| | const_iterator set to the beginning of the HashTable
|
| iterator | end () noexcept |
| | iterator to signal the end (for any HashTable)
|
| constexpr const_iterator | cend () const noexcept |
| | const_iterator to signal the end (for any HashTable)
|
| Ostream & | printInfo (Ostream &os) const |
| | Print information.
|
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| | Write unordered keys (list), with line-breaks when length exceeds shortLen.
|
| bool | found (const word &key) const |
| | Same as contains().
|
| | ClassName ("HashTable") |
| | Declare type-name (with debug switch).
|
| constexpr | HashTableCore () noexcept=default |
| | Default construct.
|
| | ClassName ("primitiveMesh") |
| | primitiveMesh (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells) |
| | Construct from components.
|
| virtual | ~primitiveMesh () |
| | Destructor.
|
| void | reset (const label nPoints, const label nInternalFaces, const label nFaces, const label nCells) |
| | Reset this primitiveMesh given the primitive array sizes.
|
| 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.
|
| void | resetGeometry (pointField &&faceCentres, pointField &&faceAreas, pointField &&cellCentres, scalarField &&cellVolumes) |
| | Reset the local geometry.
|
| label | nPoints () const noexcept |
| | Number of mesh points.
|
| label | nEdges () const |
| | Number of mesh edges.
|
| label | nFaces () const noexcept |
| | Number of mesh faces.
|
| label | nCells () const noexcept |
| | Number of mesh cells.
|
| label | nInternalFaces () const noexcept |
| | Number of internal faces.
|
| label | nBoundaryFaces () const noexcept |
| | Number of boundary faces (== nFaces - nInternalFaces).
|
| label | nInternalPoints () const noexcept |
| | Points not on boundary.
|
| label | nInternal0Edges () const |
| | Internal edges (i.e. not on boundary face) using no boundary point.
|
| label | nInternal1Edges () const |
| | Internal edges using 0 or 1 boundary point.
|
| label | nInternalEdges () const |
| | Internal edges using 0,1 or 2 boundary points.
|
| const cellShapeList & | cellShapes () const |
| | Return cell shapes.
|
| const edgeList & | edges () const |
| | Return mesh edges. Uses calcEdges.
|
| const labelListList & | cellCells () const |
| const labelListList & | edgeCells () const |
| const labelListList & | pointCells () const |
| const cellList & | cells () const |
| const labelListList & | edgeFaces () const |
| const labelListList & | pointFaces () const |
| const labelListList & | cellEdges () const |
| const labelListList & | faceEdges () const |
| const labelListList & | pointEdges () const |
| const labelListList & | pointPoints () const |
| const labelListList & | cellPoints () const |
| const vectorField & | cellCentres () const |
| const vectorField & | faceCentres () const |
| const scalarField & | cellVolumes () const |
| const vectorField & | faceAreas () const |
| void | movePoints (const pointField &p, const pointField &oldP) |
| | Move points.
|
| bool | isInternalFace (const label faceIndex) const noexcept |
| | Return true if given face label is internal to the mesh.
|
| virtual bool | checkUpperTriangular (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check face ordering.
|
| virtual bool | checkCellsZipUp (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check cell zip-up.
|
| virtual bool | checkFaceVertices (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check uniqueness of face vertices.
|
| virtual bool | checkPoints (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check for unused points.
|
| virtual bool | checkFaceFaces (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check face-face connectivity.
|
| virtual bool | checkClosedBoundary (const bool report=false) const |
| | Check boundary for closedness.
|
| 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.
|
| virtual bool | checkFaceAreas (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check for negative face areas.
|
| virtual bool | checkCellVolumes (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check for negative cell volumes.
|
| virtual bool | checkFacePyramids (const bool report=false, const scalar minPyrVol=-SMALL, labelHashSet *setPtr=nullptr) const |
| | Check face pyramid volume.
|
| virtual bool | checkFaceAngles (const bool report=false, const scalar maxSin=10, labelHashSet *setPtr=nullptr) const |
| | Check face angles.
|
| virtual bool | checkFaceFlatness (const bool report, const scalar warnFlatness, labelHashSet *setPtr) const |
| | Check face warpage: decompose face and check ratio between.
|
| virtual bool | checkPointNearness (const bool report, const scalar reportDistSqr, labelHashSet *setPtr=nullptr) const |
| | Check for point-point-nearness,.
|
| virtual bool | checkEdgeLength (const bool report, const scalar minLenSqr, labelHashSet *setPtr=nullptr) const |
| | Check edge length.
|
| virtual bool | checkConcaveCells (const bool report=false, labelHashSet *setPtr=nullptr) const |
| | Check for concave cells by the planes of faces.
|
| virtual bool | checkTopology (const bool report=false) const |
| | Check mesh topology for correctness.
|
| virtual bool | checkGeometry (const bool report=false) const |
| | Check mesh geometry (& implicitly topology) for correctness.
|
| virtual bool | checkMesh (const bool report=false) const |
| | Check mesh for correctness. Returns false for no error.
|
| boundBox | cellBb (const label celli) const |
| | The bounding box for given cell index.
|
| bool | pointInCellBB (const point &p, label celli, scalar inflationFraction=0) const |
| | Return true if the point in the cell bounding box.
|
| bool | pointInCell (const point &p, label celli) const |
| | Return true if the point is in the cell.
|
| label | findNearestCell (const point &location) const |
| | Find the cell with the nearest cell centre to location.
|
| label | findCell (const point &location) const |
| | Find cell enclosing this location (-1 if not in mesh).
|
| void | printAllocated () const |
| | Print a list of all the currently allocated mesh data.
|
| 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 labelList & | cellCells (const label celli, DynamicList< label > &) const |
| | cellCells using cells.
|
| const labelList & | cellCells (const label celli) const |
| const labelList & | cellPoints (const label celli, labelHashSet &, DynamicList< label > &) const |
| | cellPoints using cells
|
| const labelList & | cellPoints (const label celli) const |
| const labelList & | pointCells (const label pointi, DynamicList< label > &) const |
| | pointCells using pointFaces
|
| const labelList & | pointCells (const label pointi) const |
| const labelList & | pointPoints (const label pointi, DynamicList< label > &) const |
| | pointPoints using edges, pointEdges
|
| const labelList & | pointPoints (const label pointi) const |
| const labelList & | faceEdges (const label facei, DynamicList< label > &) const |
| | faceEdges using pointFaces, edges, pointEdges
|
| const labelList & | faceEdges (const label facei) const |
| const labelList & | edgeFaces (const label edgeI, DynamicList< label > &) const |
| | edgeFaces using pointFaces, edges, pointEdges
|
| const labelList & | edgeFaces (const label edgeI) const |
| const labelList & | edgeCells (const label edgeI, DynamicList< label > &) const |
| | edgeCells using pointFaces, edges, pointEdges
|
| const labelList & | edgeCells (const label edgeI) const |
| const labelList & | cellEdges (const label celli, labelHashSet &, DynamicList< label > &) const |
| | cellEdges using cells, pointFaces, edges, pointEdges
|
| const labelList & | cellEdges (const label celli) const |
| void | clearGeom () |
| | Clear geometry.
|
| void | clearCellGeom () |
| | Clear cell-based geometry only.
|
| void | clearAddressing () |
| | Clear topological data.
|
| void | clearOut () |
| | Clear all geometry and addressing unnecessary for CFD.
|
| | TypeName ("lduMesh") |
| | Runtime type information.
|
| virtual | ~lduMesh ()=default |
| | Destructor.
|
| template<class T, class BinaryOp> |
| void | reduce (T &val, BinaryOp bop) const |
| | Helper: reduce with current communicator.
|
| InfoProxy< lduMesh > | info () const noexcept |
| | Return info proxy, used to print mesh information to a stream.
|
| | fvSchemes (const fvSchemes &)=delete |
| | No copy construct.
|
| void | operator= (const fvSchemes &)=delete |
| | No copy assignment.
|
| | fvSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption, (system) dictionary name.
|
| | fvSchemes (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, (system) dictionary name using the readOption from the registry.
|
| | fvSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption with the default dictionary name ("fvSchemes").
|
| | fvSchemes (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary &dict) |
| | Construct for objectRegistry, readOption with the default dictionary name ("fvSchemes") and fallback dictionary content.
|
| | fvSchemes (const objectRegistry &obr, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry with the default dictionary name ("fvSchemes").
|
| | fvSchemes (const objectRegistry &obr, const dictionary &dict) |
| | Construct for objectRegistry with the default dictionary name ("fvSchemes") and fallback dictionary content.
|
| | schemesLookup (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption, (system) dictionary name.
|
| | schemesLookup (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, (system) dictionary name using the readOption from the registry.
|
| bool | steady () const noexcept |
| | True if default ddt scheme is steady-state.
|
| bool | transient () const noexcept |
| | True if default ddt scheme is not steady-state.
|
| const dictionary & | schemesDict () const |
| | The entire dictionary or the optional "select" sub-dictionary.
|
| ITstream & | ddtScheme (const word &name) const |
| | Get ddt scheme for given name, or default.
|
| ITstream & | d2dt2Scheme (const word &name) const |
| | Get d2dt2 scheme for given name, or default.
|
| ITstream & | interpolationScheme (const word &name) const |
| | Get interpolation scheme for given name, or default.
|
| ITstream & | divScheme (const word &name) const |
| | Get div scheme for given name, or default.
|
| ITstream & | gradScheme (const word &name) const |
| | Get grad scheme for given name, or default.
|
| ITstream & | lnGradScheme (const word &name) const |
| | Get (finiteArea) lnGrad scheme for given name, or default.
|
| ITstream & | snGradScheme (const word &name) const |
| | Get (finiteVolume) snGrad scheme for given name, or default.
|
| ITstream & | laplacianScheme (const word &name) const |
| | Get laplacian scheme for given name, or default.
|
| void | setFluxRequired (const word &name) const |
| | Set flux-required for given name (mutable).
|
| bool | fluxRequired (const word &name) const |
| | Get flux-required for given name, or default.
|
| const dictionary & | ddtSchemes () const noexcept |
| | Access ddt schemes dictionary.
|
| const dictionary & | d2dt2Schemes () const noexcept |
| | Access d2dt2 schemes dictionary.
|
| const dictionary & | interpolationSchemes () const noexcept |
| | Access interpolation schemes dictionary.
|
| const dictionary & | divSchemes () const noexcept |
| | Access div schemes dictionary.
|
| const dictionary & | gradSchemes () const noexcept |
| | Access grad schemes dictionary.
|
| const dictionary & | lnGradSchemes () const noexcept |
| | Access lnGrad schemes dictionary (finiteArea).
|
| const dictionary & | snGradSchemes () const noexcept |
| | Access snGrad schemes dictionary (finiteVolume).
|
| const dictionary & | laplacianSchemes () const noexcept |
| | Access laplacian schemes dictionary.
|
| const dictionary & | fluxRequired () const noexcept |
| | Access flux-required dictionary.
|
| dictionary & | ddtSchemes () noexcept |
| | Access ddt schemes dictionary.
|
| dictionary & | d2dt2Schemes () noexcept |
| | Access d2dt2 schemes dictionary.
|
| dictionary & | interpolationSchemes () noexcept |
| | Access interpolation schemes dictionary.
|
| dictionary & | divSchemes () noexcept |
| | Access div schemes dictionary.
|
| dictionary & | gradSchemes () noexcept |
| | Access grad schemes dictionary.
|
| dictionary & | lnGradSchemes () noexcept |
| | Access lnGrad schemes dictionary (finiteArea).
|
| dictionary & | snGradSchemes () noexcept |
| | Access snGrad schemes dictionary (finiteVolume).
|
| dictionary & | laplacianSchemes () noexcept |
| | Access laplacian schemes dictionary.
|
| dictionary & | fluxRequired () noexcept |
| | Access flux-required dictionary.
|
| bool | read () |
| | Read schemes from IOdictionary, respects the "select" keyword.
|
| void | writeDicts (Ostream &os) const |
| | Write dictionary (possibly modified) settings.
|
| | IOdictionary (const IOobject &io, const dictionary *fallback=nullptr) |
| | Construct given an IOobject and optional fallback dictionary content.
|
| | IOdictionary (const IOobject &io, const dictionary &dict) |
| | Construct given an IOobject and fallback dictionary content.
|
| | IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr) |
| | Construct given an IOobject, wanted typeName and optional fallback dictionary content.
|
| | IOdictionary (const IOobject &io, Istream &is) |
| | Construct given an IOobject and Istream.
|
| virtual | ~IOdictionary ()=default |
| | Destructor.
|
| virtual bool | global () const |
| | The object is global.
|
| virtual fileName | filePath () const |
| | Return complete path + object name if the file exists either in the case/processor or case otherwise null.
|
| | TypeName ("dictionary") |
| | Declare type-name, virtual type (with debug switch).
|
| | baseIOdictionary (const baseIOdictionary &)=default |
| | Copy construct.
|
| | baseIOdictionary (baseIOdictionary &&)=default |
| | Move construct.
|
| virtual | ~baseIOdictionary ()=default |
| | Destructor.
|
| | baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) |
| | Construct given an IOobject and optional fallback dictionary content (ununsed).
|
| | baseIOdictionary (const IOobject &io, const dictionary &dict) |
| | Construct given an IOobject and fallback dictionary content (ununsed).
|
| | baseIOdictionary (const IOobject &io, Istream &is) |
| | Construct given an IOobject and Istream (ununsed).
|
| const word & | name () const |
| | Name function is needed to disambiguate those inherited from regIOobject and dictionary.
|
| virtual bool | readData (Istream &) |
| | The readData function required by regIOobject read operation.
|
| virtual bool | writeData (Ostream &) const |
| | The writeData function required by regIOobject write operation.
|
| void | operator= (const baseIOdictionary &rhs) |
| | Copy assignment of dictionary entries.
|
| void | operator= (baseIOdictionary &&rhs) |
| | Move assignment of dictionary entries.
|
| void | operator= (const dictionary &rhs) |
| | Copy assignment of dictionary entries.
|
| | ClassName ("dictionary") |
| | dictionary () |
| | Default construct, a top-level empty dictionary.
|
| | dictionary (const fileName &name) |
| | Construct top-level empty dictionary with given name.
|
| | dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false) |
| | Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header.
|
| | dictionary (Istream &is) |
| | Construct top-level dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| | dictionary (Istream &is, bool keepHeader) |
| | Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header.
|
| | dictionary (const dictionary &parentDict, const dictionary &dict) |
| | Copy construct given the parent dictionary.
|
| | dictionary (const dictionary &dict) |
| | Copy construct top-level dictionary.
|
| | dictionary (const dictionary *dict) |
| | Construct top-level dictionary as copy from pointer to dictionary.
|
| | dictionary (const dictionary &parentDict, dictionary &&dict) |
| | Move construct for given parent dictionary.
|
| | dictionary (dictionary &&dict) |
| | Move construct top-level dictionary.
|
| autoPtr< dictionary > | clone () const |
| | Construct and return clone.
|
| virtual | ~dictionary () |
| | Destructor.
|
| const fileName & | name () const noexcept |
| | The dictionary name.
|
| fileName & | name () noexcept |
| | The dictionary name for modification (use with caution).
|
| word | dictName () const |
| | The local dictionary name (final part of scoped name).
|
| fileName | relativeName (const bool caseTag=false) const |
| | The dictionary name relative to the case.
|
| bool | isNullDict () const noexcept |
| | The dictionary is actually dictionary::null (root dictionary).
|
| const dictionary & | parent () const noexcept |
| | Return the parent dictionary.
|
| const dictionary & | topDict () const |
| | Return the top of the tree.
|
| label | startLineNumber () const |
| | Return line number of first token in dictionary.
|
| label | endLineNumber () const |
| | Return line number of last token in dictionary.
|
| SHA1Digest | digest () const |
| | Return the SHA1 digest of the dictionary contents.
|
| tokenList | tokens () const |
| | Return the dictionary as a list of tokens.
|
| const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry (const access) with the given keyword.
|
| entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find an entry (non-const access) with the given keyword.
|
| bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry (const access) with the given keyword.
|
| const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search for a scoped entry (const access) with the given keyword.
|
| const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
|
| dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
|
| ITstream * | findStream (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry stream if present (and it is a stream) otherwise return nullptr.
|
| const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| | Search for an entry (const access) with the given keyword.
|
| ITstream & | lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry data stream. FatalIOError if not found, or not a stream.
|
| template<class T> |
| T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
|
| template<class T> |
| T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T> |
| T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T> |
| bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.
|
| template<class T> |
| bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.
|
| template<class T, class Predicate> |
| bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.
|
| const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary.
|
| dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary for manipulation.
|
| dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary for manipulation.
|
| dictionary | subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const |
| | Find and return a sub-dictionary as a copy, otherwise return an empty dictionary.
|
| const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary, otherwise return this dictionary.
|
| wordList | toc () const |
| | Return the table of contents.
|
| wordList | sortedToc () const |
| | Return the sorted table of contents.
|
| template<class Compare> |
| wordList | sortedToc (const Compare &comp) const |
| | Return table of contents sorted using the specified comparator.
|
| List< keyType > | keys (bool patterns=false) const |
| | Return the list of available keys or patterns.
|
| bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
| | Substitute the given keyword (which is prefixed by '$').
|
| bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
| | Substitute the given scoped keyword (which is prefixed by '$').
|
| entry * | add (entry *entryPtr, bool mergeEntry=false) |
| | Add a new entry.
|
| entry * | add (const entry &e, bool mergeEntry=false) |
| | Add an entry.
|
| entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| | Add a word entry.
|
| entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| | Add a string entry.
|
| entry * | add (const keyType &k, const label v, bool overwrite=false) |
| | Add a label entry.
|
| entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| | Add a scalar entry.
|
| entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| | Add a dictionary entry.
|
| template<class T> |
| entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| | Add a T entry.
|
| entry * | set (entry *entryPtr) |
| | Assign a new entry, overwriting any existing entry.
|
| entry * | set (const entry &e) |
| | Assign a new entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, const dictionary &v) |
| | Assign a dictionary entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, std::nullptr_t) |
| | Assign an empty primitive entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, const UList< token > &tokens) |
| | Assign a primitive entry from a list of tokens, overwriting any existing entry.
|
| entry * | set (const keyType &k, List< token > &&tokens) |
| | Assign a primitive entry from a list of tokens, overwriting any existing entry.
|
| template<class T> |
| entry * | set (const keyType &k, const T &v) |
| | Assign a T entry, overwriting any existing entry.
|
| bool | remove (const word &keyword) |
| | Remove an entry specified by keyword.
|
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
| | Change the keyword for an entry,.
|
| bool | merge (const dictionary &dict) |
| | Merge entries from the given dictionary.
|
| void | clear () |
| | Clear the dictionary.
|
| void | transfer (dictionary &dict) |
| | Transfer the contents of the argument and annul the argument.
|
| void | checkITstream (const ITstream &is, const word &keyword) const |
| | Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place.
|
| bool | read (Istream &is) |
| | Read dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| bool | read (Istream &is, bool keepHeader) |
| | Read dictionary from Istream (optionally keeping the header) Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| void | writeEntry (Ostream &os) const |
| | Write sub-dictionary with its dictName as its header.
|
| void | writeEntry (const keyType &keyword, Ostream &os) const |
| | Write sub-dictionary with the keyword as its header.
|
| void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
| | Write dictionary entries.
|
| void | write (Ostream &os, const bool subDict=true) const |
| | Write dictionary, normally with sub-dictionary formatting.
|
| const_searcher | csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword.
|
| const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword.
|
| searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Search dictionary for given keyword.
|
| const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
| | Search using scoping.
|
| const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
| | Search using dot or slash scoping.
|
| searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
| | Search using dot or slash scoping.
|
| const dictionary * | cfindScopedDict (const fileName &dictPath) const |
| | Locate a sub-dictionary using slash-scoping.
|
| const dictionary * | findScopedDict (const fileName &dictPath) const |
| | Locate a sub-dictionary using slash-scoping.
|
| dictionary * | findScopedDict (const fileName &dictPath) |
| | Locate a sub-dictionary using slash-scoping.
|
| dictionary * | makeScopedDict (const fileName &dictPath) |
| | Locate existing or create sub-dictionary using slash-scoping.
|
| 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.
|
| const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
| | Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed.
|
| 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.
|
| const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
| | Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed.
|
| ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry data stream, using any compatibility names if needed.
|
| template<class T> |
| T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens.
|
| template<class T> |
| T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value using any compatibility names if needed.
|
| template<class T> |
| bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens.
|
| template<class T> |
| bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens.
|
| void | operator= (const dictionary &rhs) |
| | Copy assignment.
|
| void | operator+= (const dictionary &rhs) |
| | Include entries from the given dictionary.
|
| void | operator|= (const dictionary &rhs) |
| | Conditionally include entries from the given dictionary.
|
| void | operator<<= (const dictionary &rhs) |
| | Unconditionally include entries from the given dictionary.
|
| bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<bool>(const word&, keyType::option).
|
| label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<label>(const word&, keyType::option).
|
| scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<scalar>(const word&, keyType::option).
|
| string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<string>(const word&, keyType::option).
|
| word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<word>(const word&, keyType::option).
|
| fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<fileName>(const word&, keyType::option).
|
| bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Check for existence of a sub-dictionary. Generally prefer findDict() for more flexibility.
|
| template<class T> |
| T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as getOrDefault().
|
| template<class T> |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| | Same as getOrAdd().
|
| ITstream & | operator[] (const word &keyword) const |
| | Deprecated(2018-07) - use lookup() method.
|
| bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| | Deprecated(2018-10).
|
| const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| const dictionary * | subDictPtr (const word &keyword) const |
| | Deprecated(2018-10).
|
| dictionary * | subDictPtr (const word &keyword) |
| | Deprecated(2018-10) Find and return a sub-dictionary pointer if present.
|
| const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
| | Deprecated(2018-10).
|
| template<class T> |
| bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
| | Deprecated(2018-10) find and return a T.
|
| template<class Compare> |
| Foam::wordList | sortedToc (const Compare &comp) const |
| template<class T> |
| Foam::entry * | add (const keyType &k, const T &v, bool overwrite) |
| template<class T> |
| Foam::entry * | set (const keyType &k, const T &v) |
| | ILList ()=default |
| | Default construct.
|
| | ILList (T *item) |
| | Construct and add initial item pointer.
|
| | ILList (Istream &is) |
| | Construct from Istream.
|
| | ILList (const ILList< DLListBase, T > &lst) |
| | Copy construct using the 'clone()' method for each element.
|
| | ILList (ILList< DLListBase, T > &&lst) |
| | Move construct.
|
| | ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg) |
| | Copy constructor with additional argument for clone 'clone()'.
|
| | ILList (Istream &is, const INew &inew) |
| | Construct from Istream using given Istream constructor class.
|
| | ~ILList () |
| | Destructor. Calls clear().
|
| void | clear () |
| | Clear the contents of the list.
|
| void | pop_front (label n=1) |
| | Remove first element(s) from the list (deletes pointers).
|
| bool | erase (T *item) |
| | Remove the specified element from the list and delete it.
|
| void | transfer (ILList< DLListBase, T > &lst) |
| | Transfer the contents of the argument into this List and annul the argument list.
|
| void | operator= (const ILList< DLListBase, T > &lst) |
| | Copy assignment using the 'clone()' method for each element.
|
| void | operator= (ILList< DLListBase, T > &&lst) |
| | Move assignment.
|
| | UILList ()=default |
| | Default construct.
|
| | UILList (T *item) |
| | Construct and add initial item pointer.
|
| | UILList (const UILList< DLListBase, T > &list) |
| | Construct as copy.
|
| T * | front () |
| | The first entry in the list.
|
| const T * | front () const |
| | The first entry in the list (const access).
|
| T * | back () |
| | The last entry in the list.
|
| const T * | back () const |
| | The last entry in the list (const access).
|
| T * | removeHead () |
| | Remove and return head.
|
| T * | remove (T *item) |
| | Remove and return element.
|
| T * | remove (iterator &iter) |
| | Remove and return item specified by iterator.
|
| void | operator= (const UILList< DLListBase, T > &lst) |
| | Copy assignment.
|
| bool | operator== (const UILList< DLListBase, T > &lst) const |
| | Equality. True both lists are element-wise equal.
|
| bool | operator!= (const UILList< DLListBase, T > &lst) const |
| | The opposite of the equality operation. Takes linear time.
|
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| | Write UILList with line-breaks when length exceeds shortLen.
|
| iterator | begin () |
| | Iterator to first item in list with non-const access.
|
| const_iterator | cbegin () const |
| | Iterator to first item in list with const access.
|
| reverse_iterator | rbegin () |
| | Iterator to last item in list with non-const access.
|
| const_reverse_iterator | crbegin () const |
| | Iterator to last item in list with const access.
|
| const_iterator | begin () const |
| | Iterator to first item in list with const access.
|
| const_reverse_iterator | rbegin () const |
| | Iterator to last item in list with const access.
|
| const iterator & | end () |
| | End of list for forward iterators.
|
| const const_iterator & | cend () const |
| | End of list for forward iterators.
|
| const reverse_iterator & | rend () |
| | End of list for reverse iterators.
|
| const const_reverse_iterator & | crend () const |
| | End of list for reverse iterators.
|
| const const_iterator & | end () const |
| | End of list for forward iterators.
|
| const const_reverse_iterator & | rend () const |
| | End of list for reverse iterators.
|
| T * | first () |
| | The first entry in the list.
|
| const T * | first () const |
| | The first entry in the list (const access).
|
| T * | last () |
| | The last entry in the list.
|
| const T * | last () const |
| | The last entry in the list (const access).
|
| | DLListBase ()=default |
| | Default construct.
|
| | DLListBase (const DLListBase &)=delete |
| | No copy construct.
|
| void | operator= (const DLListBase &)=delete |
| | No copy assignment.
|
| | ~DLListBase ()=default |
| | Destructor.
|
| bool | empty () const noexcept |
| | True if the list is empty.
|
| label | size () const noexcept |
| | The number of elements in list.
|
| link * | front () |
| | Return first entry.
|
| const link * | front () const |
| | Return const access to first entry.
|
| link * | back () |
| | Return last entry.
|
| const link * | back () const |
| | Return const access to last entry.
|
| void | push_front (link *item) |
| | Add at front of list.
|
| void | push_back (link *item) |
| | Add at back of list.
|
| bool | swapUp (link *item) |
| | Swap this element with the one above unless it is at the top.
|
| bool | swapDown (link *item) |
| | Swap this element with the one below unless it is at the bottom.
|
| link * | removeHead () |
| | Remove and return first entry.
|
| link * | remove (link *item) |
| | Remove and return element.
|
| link * | remove (iterator &iter) |
| | Remove and return element specified by iterator.
|
| link * | replace (link *oldLink, link *newLink) |
| | Replace oldLink with newLink and return element.
|
| link * | replace (iterator &oldIter, link *newitem) |
| | Replace oldIter with newItem and return element.
|
| void | clear () |
| | Clear the list.
|
| void | swap (DLListBase &lst) |
| | Swap the contents of the list.
|
| void | transfer (DLListBase &lst) |
| | Transfer the contents of the argument into this list and annul the argument list.
|
| iterator | begin () |
| | Iterator to first item in list with non-const access.
|
| const_iterator | cbegin () const |
| | Iterator to first item in list with const access.
|
| const_iterator | crbegin () const |
| | Iterator to last item in list with const access.
|
| const iterator & | end () |
| | End of list for iterators.
|
| const const_iterator & | cend () const |
| | End of list for iterators.
|
| const const_iterator & | crend () const |
| | End of list for reverse iterators.
|
| link * | first () |
| | Return first entry.
|
| const link * | first () const |
| | Return const access to first entry.
|
| link * | last () |
| | Return last entry.
|
| const link * | last () const |
| | Return const access to last entry.
|
| void | prepend (link *item) |
| | Add at front of list.
|
| void | append (link *item) |
| | Add at back of list.
|
| | ClassName ("surfaceInterpolation") |
| | surfaceInterpolation (const fvMesh &) |
| | Construct given an fvMesh.
|
| virtual | ~surfaceInterpolation () |
| | Destructor.
|
| virtual const fvGeometryScheme & | geometry () const |
| | Return reference to geometry calculation scheme.
|
| void | geometry (tmp< fvGeometryScheme > &) |
| | Set geometry calculation scheme.
|
| virtual const surfaceScalarField & | weights () const |
| | Return reference to linear difference weighting factors.
|
| virtual const surfaceScalarField & | deltaCoeffs () const |
| | Return reference to cell-centre difference coefficients.
|
| virtual const surfaceScalarField & | nonOrthDeltaCoeffs () const |
| | Return reference to non-orthogonal cell-centre difference.
|
| virtual const surfaceVectorField & | nonOrthCorrectionVectors () const |
| | Return reference to non-orthogonality correction vectors.
|
| bool | hasWeights () const noexcept |
| | Has weights.
|
| | fvSolution (const fvSolution &)=delete |
| | No copy construct.
|
| void | operator= (const fvSolution &)=delete |
| | No copy assignment.
|
| | fvSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption, (system) dictionary name.
|
| | fvSolution (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, dictionary name and optional fallback dictionary content (for a NO_READ or missing file).
|
| | fvSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption with the default dictionary name ("fvSolution").
|
| | fvSolution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const dictionary &dict) |
| | Construct for objectRegistry, readOption with the default dictionary name ("fvSolution") and fallback dictionary content.
|
| | fvSolution (const objectRegistry &obr, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry with the default dictionary name ("fvSolution").
|
| | fvSolution (const objectRegistry &obr, const dictionary &dict) |
| | Construct for objectRegistry with the default dictionary name ("fvSolution") and optional contents.
|
| | solution (const objectRegistry &obr, IOobjectOption::readOption rOpt, const fileName &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, readOption, (system) dictionary name.
|
| | solution (const objectRegistry &obr, const fileName &dictName, const dictionary *fallback=nullptr) |
| | Construct for objectRegistry, (system) dictionary name using the readOption from the registry.
|
| virtual | ~solution () |
| | Destructor. Non-default in header (incomplete types).
|
| bool | cache (const word &name) const |
| | True if the given field should be cached.
|
| bool | relaxField (const word &name) const |
| | True if the relaxation factor is given for the field.
|
| bool | relaxField (const word &name, scalar &factor) const |
| | Get the relaxation factor specified for the field or the specified "default" entry, if present. Does not change factor if neither direct nor "default" can be used,.
|
| bool | relaxEquation (const word &name) const |
| | True if the relaxation factor is given for the equation.
|
| bool | relaxEquation (const word &name, scalar &factor) const |
| | Get the relaxation factor specified for the equation or the specified "default" entry, if present. Does not change factor if neither direct nor "default" can be used,.
|
| scalar | fieldRelaxationFactor (const word &name) const |
| | Get the relaxation factor for the given field. Fatal if not found.
|
| scalar | equationRelaxationFactor (const word &name) const |
| | Get the relaxation factor for the given equation. Fatal if not found.
|
| const dictionary & | solutionDict () const |
| | The entire dictionary or the optional "select" sub-dictionary.
|
| const dictionary & | solutionDict (const word &name) const |
| | Return name sub-dictionary within the solutionDict().
|
| const dictionary & | solversDict () const |
| | The solver controls dictionary (all fields).
|
| const dictionary & | solverDict (const word &name) const |
| | The solver controls dictionary for the given field. Same as solversDict().subDict(...).
|
| const dictionary & | solver (const word &name) const |
| | The solver controls dictionary for the given field. Same as solverDict(...).
|
| bool | read () |
| | Read the solution dictionary.
|
1.16.1 