Finite area mesh. Used for 2-D non-Euclidian finite area method. More...
Public Types | |
| typedef faMesh | Mesh |
| typedef faBoundaryMesh | BoundaryMesh |
 Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Public Types inherited from dictionary | |
| typedef Searcher< true > | const_searcher |
| Searcher with const access. More... | |
| typedef Searcher< false > | searcher |
| Searcher with non-const access. More... | |
Public Member Functions | |
| TypeName ("faMesh") | |
| Runtime type information. More... | |
| faMesh (const polyMesh &pMesh, const Foam::zero) | |
| Construct zero-sized from polyMesh. More... | |
| faMesh (const polyMesh &pMesh) | |
| Construct from polyMesh. More... | |
| faMesh (const polyMesh &pMesh, const UList< label > &faceLabels) | |
| Construct for specified face labels without boundary. More... | |
| faMesh (const polyPatch &pp) | |
| Construct from single polyPatch. More... | |
| faMesh (const polyMesh &pMesh, const dictionary &faMeshDefinition) | |
| Construct from definition. More... | |
| virtual | ~faMesh () |
| Destructor. More... | |
| void | addFaPatches (PtrList< faPatch > &plist, const bool validBoundary=true) |
| Add boundary patches. Constructor helper. More... | |
| void | addFaPatches (const List< faPatch * > &p, const bool validBoundary=true) |
| Add boundary patches. Constructor helper. More... | |
| const polyMesh & | mesh () const |
| Return access to polyMesh. More... | |
| const polyMesh & | operator() () const |
| Interface to referenced polyMesh (similar to GeoMesh) More... | |
| fileName | meshDir () const |
| Return the local mesh directory (dbDir()/meshSubDir) More... | |
| const Time & | time () const |
| Return reference to time. More... | |
| const fileName & | pointsInstance () const |
| Return the current instance directory for points. More... | |
| const fileName & | facesInstance () const |
| Return the current instance directory for faces. More... | |
| label | comm () const noexcept |
| Return communicator used for parallel communication. More... | |
| label & | comm () noexcept |
| Return communicator used for parallel communication. More... | |
| label | nPoints () const noexcept |
| Number of local mesh points. More... | |
| label | nEdges () const noexcept |
| Number of local mesh edges. More... | |
| label | nInternalEdges () const noexcept |
| Number of internal faces. More... | |
| label | nBoundaryEdges () const noexcept |
| Number of boundary edges (== nEdges - nInternalEdges) More... | |
| label | nFaces () const noexcept |
| Number of patch faces. More... | |
| const pointField & | points () const |
| Return local patch points. More... | |
| const edgeList & | edges () const noexcept |
| Return local patch edges with reordered boundary. More... | |
| const faceList & | faces () const |
| Return local patch faces. More... | |
| const labelList & | edgeOwner () const noexcept |
| Edge owner addressing. More... | |
| const labelList & | edgeNeighbour () const noexcept |
| Edge neighbour addressing. More... | |
| virtual bool | hasDb () const |
| Return true if thisDb() is a valid DB. More... | |
| virtual const objectRegistry & | thisDb () const |
| Return reference to the mesh database. More... | |
| const word & | name () const |
| Name function is needed to disambiguate those inherited. More... | |
| const faBoundaryMesh & | boundary () const noexcept |
| Return constant reference to boundary mesh. More... | |
| const labelList & | faceLabels () const noexcept |
| Return the underlying polyMesh face labels. More... | |
| const faGlobalMeshData & | globalData () const |
| Return parallel info. More... | |
| virtual const lduAddressing & | lduAddr () const |
| Return ldu addressing. More... | |
| virtual lduInterfacePtrsList | interfaces () const |
| Return a list of pointers for each patch. More... | |
| const labelUList & | owner () const |
| Internal face owner. More... | |
| const labelUList & | neighbour () const |
| Internal face neighbour. More... | |
| bool | isInternalEdge (const label edgeIndex) const |
| True if given edge label is internal to the mesh. More... | |
| const List< labelPair > & | boundaryConnections () const |
| labelList | boundaryProcs () const |
| List< labelPair > | boundaryProcSizes () const |
| const faMeshBoundaryHalo & | boundaryHaloMap () const |
| Mapping/swapping for boundary halo neighbours. More... | |
| const pointField & | haloFaceCentres () const |
| Face centres of boundary halo neighbours. More... | |
| const vectorField & | haloFaceNormals () const |
| Face normals of boundary halo neighbours. More... | |
| tmp< pointField > | haloFaceCentres (const label patchi) const |
| Face centres of boundary halo neighbours for specified patch. More... | |
| tmp< vectorField > | haloFaceNormals (const label patchi) const |
| Face normals of boundary halo neighbours for specified patch. More... | |
| bool | moving () const |
| Is mesh moving. More... | |
| virtual bool | movePoints () |
| Update after mesh motion. More... | |
| virtual void | updateMesh (const mapPolyMesh &) |
| Update after topo change. More... | |
| virtual void | mapFields (const faMeshMapper &mapper) const |
| Map all fields in time using given map. More... | |
| virtual void | mapOldAreas (const faMeshMapper &mapper) const |
| Map face areas in time using given map. More... | |
| const uindirectPrimitivePatch & | patch () const |
| Return constant reference to primitive patch. More... | |
| uindirectPrimitivePatch & | patch () |
| Return reference to primitive patch. More... | |
| const labelList & | patchStarts () const |
| Return patch starts. More... | |
| const edgeVectorField & | Le () const |
| Return edge length vectors. More... | |
| const edgeScalarField & | magLe () const |
| Return edge length magnitudes. More... | |
| const areaVectorField & | areaCentres () const |
| Return face centres as areaVectorField. More... | |
| const edgeVectorField & | edgeCentres () const |
| Return edge centres as edgeVectorField. More... | |
| const DimensionedField< scalar, areaMesh > & | S () const |
| Return face areas. More... | |
| const DimensionedField< scalar, areaMesh > & | S0 () const |
| Return old-time face areas. More... | |
| const DimensionedField< scalar, areaMesh > & | S00 () const |
| Return old-old-time face areas. More... | |
| const areaVectorField & | faceAreaNormals () const |
| Return face area normals. More... | |
| const edgeVectorField & | edgeAreaNormals () const |
| Return edge area normals. More... | |
| const vectorField & | pointAreaNormals () const |
| Return point area normals. More... | |
| const areaScalarField & | faceCurvatures () const |
| Return face curvatures. More... | |
| const FieldField< Field, tensor > & | edgeTransformTensors () const |
| Return edge transformation tensors. More... | |
| labelList | internalPoints () const |
| Return internal point labels. More... | |
| labelList | boundaryPoints () const |
| Return boundary point labels. More... | |
| tmp< edgeScalarField > | edgeLengthCorrection () const |
| Return edge length correction. More... | |
| bool | correctPatchPointNormals (const label patchID) const |
| Whether point normals should be corrected for a patch. More... | |
| boolList & | correctPatchPointNormals () const |
| Set whether point normals should be corrected for a patch. More... | |
| virtual bool | write (const bool valid=true) const |
| Write mesh. More... | |
| bool | operator!= (const faMesh &m) const |
| bool | operator== (const faMesh &m) const |
| Public Member Functions inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh > | |
| MeshObject (const polyMesh &mesh) | |
| Construct on Mesh type. More... | |
| virtual | ~MeshObject ()=default |
| Destructor. More... | |
| const polyMesh & | mesh () const |
| virtual bool | writeData (Ostream &os) const |
| Public Member Functions inherited from UpdateableMeshObject< polyMesh > | |
| UpdateableMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from MoveableMeshObject< polyMesh > | |
| MoveableMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from GeometricMeshObject< polyMesh > | |
| GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from TopologicalMeshObject< polyMesh > | |
| TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from meshObject | |
| ClassName ("meshObject") | |
| meshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More... | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. More... | |
| void | removeMetaData () |
| Remove meta-data. More... | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return name. More... | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More... | |
| word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const noexcept |
| Return the optional note. More... | |
| string & | note () noexcept |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More... | |
| bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More... | |
| bool | globalObject () const noexcept |
| Is object same for all processors? More... | |
| bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More... | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More... | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const noexcept |
| The read option. More... | |
| readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More... | |
| writeOption | writeOpt () const noexcept |
| The write option. More... | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | objectRelPath () const |
| The object path relative to the root. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| bool | readHeader (Istream &is) |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type() More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More... | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| bool | good () const noexcept |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| readOption & | readOpt () noexcept |
| Access to the read option. More... | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. More... | |
| bool & | registerObject () noexcept |
| Access to the register object option. More... | |
| bool & | globalObject () noexcept |
| Access to the global object option. More... | |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| Public Member Functions inherited from lduMesh | |
| TypeName ("lduMesh") | |
| Runtime type information. More... | |
| virtual | ~lduMesh ()=default |
| Destructor. More... | |
| template<class T , class BinaryOp > | |
| void | reduce (T &Value, const BinaryOp &bop) const |
| Helper: reduce with current communicator. More... | |
| InfoProxy< lduMesh > | info () const |
| Return info proxy. More... | |
| Public Member Functions inherited from edgeInterpolation | |
| ClassName ("edgeInterpolation") | |
| edgeInterpolation (const faMesh &) | |
| Construct given an faMesh. More... | |
| ~edgeInterpolation () | |
| Destructor. More... | |
| const faMesh & | mesh () const |
| Return mesh reference. More... | |
| const edgeScalarField & | lPN () const |
| Return reference to PN geodesic distance. More... | |
| const edgeScalarField & | weights () const |
| Return reference to weighting factors array. More... | |
| const edgeScalarField & | deltaCoeffs () const |
| Return reference to difference factors array. More... | |
| bool | orthogonal () const |
| Return whether mesh is orthogonal or not. More... | |
| const edgeVectorField & | correctionVectors () const |
| Return reference to non-orthogonality correction vectors array. More... | |
| bool | skew () const |
| Return whether mesh is skew or not. More... | |
| const edgeVectorField & | skewCorrectionVectors () const |
| Return reference to skew vectors array. More... | |
| bool | movePoints () const |
| Do what is necessary if the mesh has moved. More... | |
| Public Member Functions inherited from faSchemes | |
| faSchemes (const faSchemes &)=delete | |
| No copy construct. More... | |
| void | operator= (const faSchemes &)=delete |
| No copy assignment. More... | |
| faSchemes (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
| faSchemes (const objectRegistry &obr, const dictionary *fallback=nullptr) | |
| faSchemes (const objectRegistry &obr, const dictionary &dict) | |
| Public Member Functions inherited from schemesLookup | |
| schemesLookup (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
| const dictionary & | schemesDict () const |
| The current schemes dictionary, respects the "select" keyword. More... | |
| bool | steady () const noexcept |
| True if default ddtScheme is steady-state. More... | |
| bool | transient () const noexcept |
| True if default ddtScheme is not steady-state. More... | |
| ITstream & | ddtScheme (const word &name) const |
| Get ddt scheme for given name, or default. More... | |
| ITstream & | d2dt2Scheme (const word &name) const |
| Get d2dt2 scheme for given name, or default. More... | |
| ITstream & | interpolationScheme (const word &name) const |
| Get interpolation scheme for given name, or default. More... | |
| ITstream & | divScheme (const word &name) const |
| Get div scheme for given name, or default. More... | |
| ITstream & | gradScheme (const word &name) const |
| Get grad scheme for given name, or default. More... | |
| ITstream & | lnGradScheme (const word &name) const |
| Get (finiteArea) lnGrad scheme for given name, or default. More... | |
| ITstream & | snGradScheme (const word &name) const |
| Get (finiteVolume) snGrad scheme for given name, or default. More... | |
| ITstream & | laplacianScheme (const word &name) const |
| Get laplacian scheme for given name, or default. More... | |
| void | setFluxRequired (const word &name) const |
| Get flux-required for given name, or default. More... | |
| bool | fluxRequired (const word &name) const |
| Set flux-required for given name (mutable) More... | |
| const dictionary & | ddtSchemes () const noexcept |
| Access ddt schemes dictionary. More... | |
| const dictionary & | d2dt2Schemes () const noexcept |
| Access d2dt2 schemes dictionary. More... | |
| const dictionary & | interpolationSchemes () const noexcept |
| Access interpolation schemes dictionary. More... | |
| const dictionary & | divSchemes () const noexcept |
| Access div schemes dictionary. More... | |
| const dictionary & | gradSchemes () const noexcept |
| Access grad schemes dictionary. More... | |
| const dictionary & | lnGradSchemes () const noexcept |
| Access lnGrad schemes dictionary (finiteArea) More... | |
| const dictionary & | snGradSchemes () const noexcept |
| Access snGrad schemes dictionary (finiteVolume) More... | |
| const dictionary & | laplacianSchemes () const noexcept |
| Access laplacian schemes dictionary. More... | |
| const dictionary & | fluxRequired () const noexcept |
| Access to flux required dictionary. More... | |
| dictionary & | ddtSchemes () noexcept |
| Access ddt schemes dictionary. More... | |
| dictionary & | d2dt2Schemes () noexcept |
| Access d2dt2 schemes dictionary. More... | |
| dictionary & | interpolationSchemes () noexcept |
| Access interpolation schemes dictionary. More... | |
| dictionary & | divSchemes () noexcept |
| Access div schemes dictionary. More... | |
| dictionary & | gradSchemes () noexcept |
| Access grad schemes dictionary. More... | |
| dictionary & | lnGradSchemes () noexcept |
| Access lnGrad schemes dictionary (finiteArea) More... | |
| dictionary & | snGradSchemes () noexcept |
| Access snGrad schemes dictionary (finiteVolume) More... | |
| dictionary & | laplacianSchemes () noexcept |
| Access laplacian schemes dictionary. More... | |
| dictionary & | fluxRequired () noexcept |
| Access to flux required dictionary. More... | |
| bool | read () |
| Read schemes from IOdictionary, respects the "select" keyword. More... | |
| void | writeDicts (Ostream &os) const |
| Write dictionary (possibly modified) settings. More... | |
| Public Member Functions inherited from IOdictionary | |
| IOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
| IOdictionary (const IOobject &io, const dictionary &dict) | |
| IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr) | |
| IOdictionary (const IOobject &io, Istream &is) | |
| Construct given an IOobject and Istream. More... | |
| virtual | ~IOdictionary ()=default |
| Destructor. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| Public Member Functions inherited from baseIOdictionary | |
| TypeName ("dictionary") | |
| Declare type-name, virtual type (with debug switch) More... | |
| baseIOdictionary (const baseIOdictionary &)=default | |
| Copy construct. More... | |
| baseIOdictionary (baseIOdictionary &&)=default | |
| Move construct. More... | |
| virtual | ~baseIOdictionary ()=default |
| Destructor. More... | |
| baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
| baseIOdictionary (const IOobject &io, const dictionary &dict) | |
| baseIOdictionary (const IOobject &io, Istream &is) | |
| Construct given an IOobject and Istream (ununsed) More... | |
| const word & | name () const |
| virtual bool | readData (Istream &) |
| The readData function required by regIOobject read operation. More... | |
| virtual bool | writeData (Ostream &) const |
| The writeData function required by regIOobject write operation. More... | |
| void | operator= (const baseIOdictionary &rhs) |
| Copy assignment of dictionary entries (leave regIOobject untouched) More... | |
| void | operator= (const dictionary &rhs) |
| Copy assignment of dictionary entries. More... | |
| Public Member Functions inherited from dictionary | |
| ClassName ("dictionary") | |
| dictionary () | |
| Default construct, a top-level empty dictionary. More... | |
| dictionary (const fileName &name) | |
| Construct top-level empty dictionary with given name. More... | |
| dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false) | |
| dictionary (Istream &is) | |
| dictionary (Istream &is, bool keepHeader) | |
| dictionary (const dictionary &parentDict, const dictionary &dict) | |
| Copy construct given the parent dictionary. More... | |
| dictionary (const dictionary &dict) | |
| Copy construct top-level dictionary. More... | |
| dictionary (const dictionary *dict) | |
| Construct top-level dictionary as copy from pointer to dictionary. More... | |
| dictionary (const dictionary &parentDict, dictionary &&dict) | |
| Move construct for given parent dictionary. More... | |
| dictionary (dictionary &&dict) | |
| Move construct top-level dictionary. More... | |
| autoPtr< dictionary > | clone () const |
| Construct and return clone. More... | |
| virtual | ~dictionary () |
| Destructor. More... | |
| const fileName & | name () const noexcept |
| The dictionary name. More... | |
| fileName & | name () noexcept |
| The dictionary name for modification (use with caution). More... | |
| word | dictName () const |
| The local dictionary name (final part of scoped name) More... | |
| fileName | relativeName (const bool caseTag=false) const |
| The dictionary name relative to the case. More... | |
| bool | isNullDict () const noexcept |
| The dictionary is actually dictionary::null (root dictionary) More... | |
| const dictionary & | parent () const noexcept |
| Return the parent dictionary. More... | |
| const dictionary & | topDict () const |
| Return the top of the tree. More... | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. More... | |
| tokenList | tokens () const |
| Return the dictionary as a list of tokens. More... | |
| bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for an entry (const access) with the given keyword. More... | |
| entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find for an entry (non-const access) with the given keyword. More... | |
| const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find an entry (const access) with the given keyword. More... | |
| const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for a scoped entry (const access) with the given keyword. More... | |
| dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary pointer if present. More... | |
| const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary pointer if present. More... | |
| const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| Search for an entry (const access) with the given keyword. More... | |
| ITstream & | lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T > | |
| bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
| template<class T > | |
| bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T , class Predicate > | |
| bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
| template<class T , class Predicate > | |
| bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Check if entry is found and is a sub-dictionary. More... | |
| const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary. More... | |
| dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. More... | |
| dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. More... | |
| dictionary | subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const |
| const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary, otherwise return this dictionary. More... | |
| wordList | toc () const |
| Return the table of contents. More... | |
| wordList | sortedToc () const |
| Return the sorted table of contents. More... | |
| template<class Compare > | |
| wordList | sortedToc (const Compare &comp) const |
| Return table of contents sorted using the specified comparator. More... | |
| List< keyType > | keys (bool patterns=false) const |
| Return the list of available keys or patterns. More... | |
| bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given keyword (which is prefixed by '$') More... | |
| bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given scoped keyword (which is prefixed by '$') More... | |
| entry * | add (entry *entryPtr, bool mergeEntry=false) |
| Add a new entry. More... | |
| entry * | add (const entry &e, bool mergeEntry=false) |
| Add an entry. More... | |
| entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| Add a word entry. More... | |
| entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| Add a string entry. More... | |
| entry * | add (const keyType &k, const label v, bool overwrite=false) |
| Add a label entry. More... | |
| entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| Add a scalar entry. More... | |
| entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| Add a dictionary entry. More... | |
| template<class T > | |
| entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| Add a T entry. More... | |
| entry * | set (entry *entryPtr) |
| Assign a new entry, overwriting any existing entry. More... | |
| entry * | set (const entry &e) |
| Assign a new entry, overwriting any existing entry. More... | |
| entry * | set (const keyType &k, const dictionary &v) |
| Assign a dictionary entry, overwriting any existing entry. More... | |
| template<class T > | |
| entry * | set (const keyType &k, const T &v) |
| Assign a T entry, overwriting any existing entry. More... | |
| bool | remove (const word &keyword) |
| Remove an entry specified by keyword. More... | |
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
| Change the keyword for an entry,. More... | |
| bool | merge (const dictionary &dict) |
| Merge entries from the given dictionary. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (dictionary &dict) |
| Transfer the contents of the argument and annul the argument. More... | |
| void | checkITstream (const ITstream &is, const word &keyword) const |
| bool | read (Istream &is) |
| Read dictionary from Istream. Discards the header. More... | |
| bool | read (Istream &is, bool keepHeader) |
| Read dictionary from Istream, optionally keeping the header. More... | |
| void | writeEntry (Ostream &os) const |
| Write sub-dictionary with its dictName as its header. More... | |
| void | writeEntry (const keyType &keyword, Ostream &os) const |
| Write sub-dictionary with the keyword as its header. More... | |
| void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
| Write dictionary entries. More... | |
| void | write (Ostream &os, const bool subDict=true) const |
| Write dictionary, normally with sub-dictionary formatting. More... | |
| const_searcher | csearch (const word &keyword, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword. More... | |
| const_searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword. More... | |
| searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) |
| Search dictionary for given keyword. More... | |
| const_searcher | csearchScoped (const word &keyword, enum keyType::option) const |
| Search using scoping. More... | |
| const_searcher | searchScoped (const word &keyword, enum keyType::option) const |
| Search using dot or slash scoping. More... | |
| searcher | searchScoped (const word &keyword, enum keyType::option) |
| Search using dot or slash scoping. More... | |
| const dictionary * | cfindScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More... | |
| const dictionary * | findScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More... | |
| dictionary * | findScopedDict (const fileName &dictPath) |
| Locate a sub-dictionary using slash-scoping. More... | |
| dictionary * | makeScopedDict (const fileName &dictPath) |
| Locate existing or create sub-dictionary using slash-scoping. More... | |
| const_searcher | csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword and any compatibility names. More... | |
| bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword and any compatibility names. More... | |
| const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const |
| const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const |
| ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const |
| template<class T > | |
| bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const |
| void | operator= (const dictionary &rhs) |
| Copy assignment. More... | |
| void | operator+= (const dictionary &rhs) |
| Include entries from the given dictionary. More... | |
| void | operator|= (const dictionary &rhs) |
| Conditionally include entries from the given dictionary. More... | |
| void | operator<<= (const dictionary &rhs) |
| Unconditionally include entries from the given dictionary. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T > | |
| T | lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| ITstream & | operator[] (const word &keyword) const |
| Deprecated(2018-07) find and return an entry data stream. More... | |
| bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More... | |
| entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| Deprecated(2018-10) More... | |
| const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| const dictionary * | subDictPtr (const word &keyword) const |
| Deprecated(2018-10) More... | |
| dictionary * | subDictPtr (const word &keyword) |
| const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More... | |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More... | |
| template<class T > | |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
| Deprecated(2018-10) More... | |
| template<class T > | |
| bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More... | |
| template<class T > | |
| T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
| Deprecated(2018-10) find and return a T. More... | |
| bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< bool >(const word&, keyType::option) More... | |
| label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< label >(const word&, keyType::option) More... | |
| scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< scalar >(const word&, keyType::option) More... | |
| string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< string >(const word&, keyType::option) More... | |
| word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< word >(const word&, keyType::option) More... | |
| fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< fileName >(const word&, keyType::option) More... | |
| template<class Compare > | |
| Foam::wordList | sortedToc (const Compare &comp) const |
| template<class T > | |
| Foam::entry * | add (const keyType &k, const T &v, bool overwrite) |
| template<class T > | |
| Foam::entry * | set (const keyType &k, const T &v) |
| Public Member Functions inherited from ILList< LListBase, T > | |
| ILList ()=default | |
| Default construct. More... | |
| ILList (T *item) | |
| Construct and insert the initial T item pointer. More... | |
| ILList (Istream &is) | |
| Construct from Istream. More... | |
| ILList (const ILList< LListBase, T > &lst) | |
| Copy construct using the 'clone()' method for each element. More... | |
| ILList (ILList< LListBase, T > &&lst) | |
| Move construct. More... | |
| template<class CloneArg > | |
| ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone 'clone()'. More... | |
| template<class INew > | |
| ILList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| ~ILList () | |
| Destructor. More... | |
| bool | eraseHead () |
| Remove the head element specified from the list and delete it. More... | |
| bool | erase (T *item) |
| Remove the specified element from the list and delete it. More... | |
| void | clear () |
| Clear the contents of the list. More... | |
| void | transfer (ILList< LListBase, T > &lst) |
| void | operator= (const ILList< LListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. More... | |
| void | operator= (ILList< LListBase, T > &&lst) |
| Move assignment. More... | |
| Public Member Functions inherited from faSolution | |
| faSolution (const faSolution &)=delete | |
| No copy construct. More... | |
| void | operator= (const faSolution &)=delete |
| No copy assignment. More... | |
| faSolution (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
| faSolution (const objectRegistry &obr, const dictionary *fallback=nullptr) | |
| Public Member Functions inherited from solution | |
| solution (const objectRegistry &obr, const fileName &dictName, const dictionary *fallback=nullptr) | |
| solution (const objectRegistry &obr, const fileName &dictName, const dictionary &dict) | |
| virtual | ~solution () |
| Destructor. More... | |
| bool | cache (const word &name) const |
| Return true if the given field should be cached. More... | |
| bool | relaxField (const word &name) const |
| Return true if the relaxation factor is given for the field. More... | |
| bool | relaxEquation (const word &name) const |
| Return true if the relaxation factor is given for the equation. More... | |
| scalar | fieldRelaxationFactor (const word &name) const |
| Return the relaxation factor for the given field. More... | |
| scalar | equationRelaxationFactor (const word &name) const |
| Return the relaxation factor for the given equation. More... | |
| const dictionary & | solutionDict () const |
| Return the selected sub-dictionary of solvers if the "select". More... | |
| const dictionary & | solverDict (const word &name) const |
| Return the solver controls dictionary for the given field. More... | |
| const dictionary & | solver (const word &name) const |
| Return the solver controls dictionary for the given field. More... | |
| bool | read () |
| Read the solution dictionary. More... | |
| Public Member Functions inherited from data | |
| data (const objectRegistry &obr) | |
| Construct for objectRegistry. More... | |
| data (const objectRegistry &obr, const dictionary &dict) | |
| Construct for objectRegistry and initial contents. More... | |
| const dictionary & | solverPerformanceDict () const |
| template<class Type > | |
| void | setSolverPerformance (const word &name, const SolverPerformance< Type > &sp) const |
| Add/set the solverPerformance entry for the named field. More... | |
| template<class Type > | |
| void | setSolverPerformance (const SolverPerformance< Type > &sp) const |
| Add/set the solverPerformance entry, using its fieldName. More... | |
Static Public Attributes | |
| static const word | prefix |
| The prefix to local: finite-area. More... | |
| static word | meshSubDir = "faMesh" |
| The mesh sub-directory name (usually "faMesh") More... | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More... | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More... | |
| Static Public Attributes inherited from schemesLookup | |
| static int | debug |
| Debug switch. More... | |
| Static Public Attributes inherited from dictionary | |
| static int | writeOptionalEntries |
| Report optional keywords and values if not present in dictionary. More... | |
| static const dictionary | null |
| An empty dictionary, which is also the parent for all dictionaries. More... | |
| static refPtr< OSstream > | reportingOutput |
| Output location when reporting default values. More... | |
| Static Public Attributes inherited from solution | |
| static int | debug |
| Debug switch. More... | |
| Static Public Attributes inherited from data | |
| static int | debug |
| Debug switch. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh > | |
| static const faMesh & | New (const polyMesh &mesh, Args &&... args) |
| Get existing or create a new MeshObject. More... | |
| static bool | Delete (const polyMesh &mesh) |
| Static destructor. More... | |
| Static Public Member Functions inherited from meshObject | |
| template<class Mesh > | |
| static void | movePoints (objectRegistry &obr) |
| template<class Mesh > | |
| static void | updateMesh (objectRegistry &obr, const mapPolyMesh &mpm) |
| template<class Mesh , template< class > class MeshObjectType> | |
| static void | clear (objectRegistry &obr) |
| template<class Mesh , template< class > class FromType, template< class > class ToType> | |
| static void | clearUpto (objectRegistry &obr) |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. More... | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable an output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from dictionary | |
| static int | reportOptional () noexcept |
| Return the state of reporting optional (default) entries. More... | |
| static int | reportOptional (const int level) noexcept |
| Change the state of reporting optional (default) entries. More... | |
| static autoPtr< dictionary > | New (Istream &is) |
| Construct top-level dictionary on freestore from Istream. More... | |
| Static Public Member Functions inherited from solution | |
| static label | upgradeSolverDict (dictionary &dict, const bool verbose=true) |
| Update from older solver controls syntax. More... | |
| template<class FieldType > | |
| static void | cachePrintMessage (const char *message, const word &name, const FieldType &vf) |
| Helper for printing cache message. More... | |
| Public Attributes inherited from dictionary | |
| friend | const_searcher |
| Declare friendship with the searcher classes. More... | |
| friend | searcher |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from edgeInterpolation | |
| void | clearOut () |
| Clear all geometry and addressing. More... | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Protected Attributes inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh > | |
| const polyMesh & | mesh_ |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Finite area mesh. Used for 2-D non-Euclidian finite area method.
| typedef faBoundaryMesh BoundaryMesh |
| faMesh | ( | const polyMesh & | pMesh, |
| const Foam::zero | zero | ||
| ) |
Construct zero-sized from polyMesh.
Boundary is added using addFaPatches() member function
Construct from polyMesh.
Definition at line 273 of file faMesh.C.
References IOobject::AUTO_WRITE, faBoundaryMesh::calcGeometry(), DebugInFunction, Foam::endl(), Foam::fileHandler(), faMesh::globalData(), Foam::isFile(), faMesh::mesh(), faMesh::meshSubDir, IOobject::MUST_READ, UPstream::parRun(), objectRegistry::time(), faMesh::time(), timeName, Time::timePath(), and faBoundaryMesh::updateMesh().
Construct for specified face labels without boundary.
Boundary is added using addFaPatches() member function
Construct from single polyPatch.
Definition at line 430 of file faMesh.C.
References faMesh::addFaPatches(), faBoundaryMesh::calcGeometry(), DebugInFunction, Foam::endl(), faMesh::globalData(), patchIdentifier::name(), UPstream::parRun(), and faBoundaryMesh::updateMesh().
| faMesh | ( | const polyMesh & | pMesh, |
| const dictionary & | faMeshDefinition | ||
| ) |
Construct from definition.
Definition at line 465 of file faMesh.C.
References IOobject::AUTO_WRITE, DebugInFunction, Foam::endl(), Foam::fileHandler(), dictionary::findDict(), dictionary::getOrDefault(), Foam::isFile(), mesh, faMesh::meshSubDir, IOobject::MUST_READ, word::null, UPstream::parRun(), dictionary::subDict(), objectRegistry::time(), timeName, and Time::timePath().
| TypeName | ( | "faMesh" | ) |
Runtime type information.
Add boundary patches. Constructor helper.
Definition at line 38 of file faMeshPatches.C.
References Foam::abort(), boundary, Foam::FatalError, and FatalErrorInFunction.
Referenced by faMesh::faMesh(), and faMeshDecomposition::writeDecomposition().
Add boundary patches. Constructor helper.
Definition at line 64 of file faMeshPatches.C.
References p.
|
inline |
Return access to polyMesh.
Definition at line 31 of file faMeshI.H.
References MeshObject< Mesh, MeshObjectType, Type >::mesh().
Referenced by faMesh::faMesh(), faMesh::moving(), and faMesh::operator()().
|
inline |
Interface to referenced polyMesh (similar to GeoMesh)
Definition at line 531 of file faMesh.H.
References faMesh::mesh().
| Foam::fileName meshDir | ( | ) | const |
Return the local mesh directory (dbDir()/meshSubDir)
Definition at line 540 of file faMesh.C.
References polyMesh::dbDir(), mesh, and faMesh::meshSubDir.
| const Foam::Time & time | ( | ) | const |
Return reference to time.
Definition at line 546 of file faMesh.C.
References mesh, and fvMesh::time().
Referenced by faMesh::faMesh().
| const Foam::fileName & pointsInstance | ( | ) | const |
Return the current instance directory for points.
Used in the construction of geometric mesh data dependent on points
Definition at line 552 of file faMesh.C.
References mesh, and polyMesh::pointsInstance().
| const Foam::fileName & facesInstance | ( | ) | const |
Return the current instance directory for faces.
Definition at line 558 of file faMesh.C.
References polyMesh::facesInstance(), and mesh.
|
inlinevirtualnoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Number of internal faces.
Definition at line 68 of file faMeshI.H.
Referenced by faEdgeMapper::size(), and faMesh::updateMesh().
|
inlinenoexcept |
Number of boundary edges (== nEdges - nInternalEdges)
Definition at line 74 of file faMeshI.H.
Referenced by faMesh::updateMesh().
|
inlinenoexcept |
Number of patch faces.
Definition at line 80 of file faMeshI.H.
Referenced by faMeshDecomposition::writeDecomposition().
|
inline |
Return local patch points.
Definition at line 86 of file faMeshI.H.
References Foam::foamVersion::patch.
|
inlinenoexcept |
|
inline |
Return local patch faces.
Definition at line 98 of file faMeshI.H.
References Foam::foamVersion::patch.
|
inlinenoexcept |
|
inlinenoexcept |
|
virtual |
|
virtual |
Return reference to the mesh database.
Reimplemented from lduMesh.
Definition at line 570 of file faMesh.C.
References mesh, and fvMesh::thisDb().
|
inline |
|
inlinenoexcept |
Return constant reference to boundary mesh.
Definition at line 38 of file faMeshI.H.
Referenced by interfaceTrackingFvMesh::correctUsBoundaryConditions(), faFieldDecomposer::reset(), interfaceTrackingFvMesh::update(), faMeshDecomposition::writeDecomposition(), and faMeshReconstructor::writeMesh().
|
inlinenoexcept |
| const Foam::faGlobalMeshData & globalData | ( | ) | const |
Return parallel info.
Definition at line 752 of file faMesh.C.
Referenced by faMesh::faMesh(), and faMesh::updateMesh().
|
virtual |
Return ldu addressing.
Implements lduMesh.
Definition at line 763 of file faMesh.C.
Referenced by faMesh::neighbour(), and faMesh::owner().
|
inlinevirtual |
|
inline |
Internal face owner.
Definition at line 630 of file faMesh.H.
References faMesh::lduAddr(), and lduAddressing::lowerAddr().
Referenced by contactAngleForce::correct().
|
inline |
Internal face neighbour.
Definition at line 636 of file faMesh.H.
References faMesh::lduAddr(), and lduAddressing::upperAddr().
Referenced by contactAngleForce::correct().
|
inline |
|
inline |
| Foam::labelList boundaryProcs | ( | ) | const |
Boundary edge neighbour processors (does not include own proc)
Definition at line 759 of file faMeshTopology.C.
References HashSet< Key, Hash >::insert(), UPstream::myProcNo(), and UPstream::nProcs().
| Foam::List< Foam::labelPair > boundaryProcSizes | ( | ) | const |
List of proc/size for the boundary edge neighbour processors (does not include own proc)
Definition at line 777 of file faMeshTopology.C.
References Foam::BitOps::count(), UPstream::myProcNo(), UPstream::nProcs(), and Foam::output().
| const Foam::faMeshBoundaryHalo & boundaryHaloMap | ( | ) | const |
Mapping/swapping for boundary halo neighbours.
Definition at line 804 of file faMeshTopology.C.
References faMeshBoundaryHalo::reset().
| const Foam::pointField & haloFaceCentres | ( | ) | const |
Face centres of boundary halo neighbours.
Definition at line 858 of file faMeshTopology.C.
| const Foam::vectorField & haloFaceNormals | ( | ) | const |
Face normals of boundary halo neighbours.
Definition at line 869 of file faMeshTopology.C.
| Foam::tmp< Foam::pointField > haloFaceCentres | ( | const label | patchi | ) | const |
Face centres of boundary halo neighbours for specified patch.
Definition at line 881 of file faMeshTopology.C.
References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, tmp< T >::New(), and Foam::nl.
| Foam::tmp< Foam::vectorField > haloFaceNormals | ( | const label | patchi | ) | const |
Face normals of boundary halo neighbours for specified patch.
Definition at line 906 of file faMeshTopology.C.
References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, tmp< T >::New(), and Foam::nl.
|
inline |
Is mesh moving.
Definition at line 678 of file faMesh.H.
References faMesh::mesh(), and polyMesh::moving().
|
virtual |
Update after mesh motion.
Implements MoveableMeshObject< polyMesh >.
Definition at line 774 of file faMesh.C.
References DebugInfo, Foam::endl(), mesh, edgeInterpolation::movePoints(), IOobject::NO_READ, IOobject::NO_WRITE, polyMesh::points(), timeIndex, and timeName.
|
virtual |
Update after topo change.
Implements UpdateableMeshObject< polyMesh >.
Definition at line 38 of file faMeshUpdate.C.
References faMeshMapper::areaMap(), faBoundaryMesh::calcGeometry(), DebugInFunction, PrimitivePatch< FaceList, PointField >::edgeFaces(), Foam::endl(), forAll, faMesh::globalData(), faMesh::mapFields(), faMesh::mapOldAreas(), edgeInterpolation::movePoints(), PrimitivePatch< FaceList, PointField >::nBoundaryEdges(), faMesh::nBoundaryEdges(), PrimitivePatch< FaceList, PointField >::nEdges(), faAreaMapper::newFaceLabels(), faAreaMapper::newFaceLabelsMap(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), faMesh::nInternalEdges(), faMeshMapper::oldPatchEdgeFaces(), UPstream::parRun(), faMesh::patch(), List< T >::resize(), List< T >::setSize(), and faBoundaryMesh::updateMesh().
|
virtual |
Map all fields in time using given map.
Definition at line 157 of file faMeshUpdate.C.
Referenced by faMesh::updateMesh().
|
virtual |
Map face areas in time using given map.
Definition at line 179 of file faMeshUpdate.C.
References faMeshMapper::areaMap(), DebugInFunction, Foam::endl(), Foam::faceMap(), forAll, and faAreaMapper::newFaceLabelsMap().
Referenced by faMesh::updateMesh().
|
inline |
Return constant reference to primitive patch.
Definition at line 122 of file faMeshI.H.
Referenced by faMeshDecomposition::decomposeMesh(), and faMesh::updateMesh().
|
inline |
| const Foam::labelList & patchStarts | ( | ) | const |
| const Foam::edgeVectorField & Le | ( | ) | const |
Return edge length vectors.
Definition at line 587 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion().
| const Foam::edgeScalarField & magLe | ( | ) | const |
Return edge length magnitudes.
Definition at line 598 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion().
| const Foam::areaVectorField & areaCentres | ( | ) | const |
Return face centres as areaVectorField.
Definition at line 609 of file faMesh.C.
Referenced by areaMesh::C().
| const Foam::edgeVectorField & edgeCentres | ( | ) | const |
Return edge centres as edgeVectorField.
Definition at line 620 of file faMesh.C.
Referenced by edgeMesh::C().
| const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S | ( | ) | const |
Return face areas.
Definition at line 632 of file faMesh.C.
Referenced by contactAngleForce::correct(), liquidFilmModel::info(), liquidFilmModel::postEvolveRegion(), and interfaceTrackingFvMesh::update().
| const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S0 | ( | ) | const |
Return old-time face areas.
Definition at line 644 of file faMesh.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
| const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S00 | ( | ) | const |
Return old-old-time face areas.
Definition at line 658 of file faMesh.C.
References IOobject::AUTO_WRITE, mesh, IOobject::NO_READ, IOobject::NO_WRITE, and timeName.
| const Foam::areaVectorField & faceAreaNormals | ( | ) | const |
Return face area normals.
Definition at line 682 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), interfaceTrackingFvMesh::surfaceTensionGrad(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), and liquidFilmBase::Uw().
| const Foam::edgeVectorField & edgeAreaNormals | ( | ) | const |
| const Foam::vectorField & pointAreaNormals | ( | ) | const |
Return point area normals.
Definition at line 704 of file faMesh.C.
References nPoints.
Referenced by faBoundaryMesh::calcGeometry().
| const Foam::areaScalarField & faceCurvatures | ( | ) | const |
Return face curvatures.
Definition at line 729 of file faMesh.C.
Referenced by interfaceTrackingFvMesh::freeSurfacePressureJump(), and interfaceTrackingFvMesh::update().
| const Foam::FieldField< Foam::Field, Foam::tensor > & edgeTransformTensors | ( | ) | const |
| Foam::labelList internalPoints | ( | ) | const |
Return internal point labels.
Definition at line 857 of file faMeshDemandDrivenData.C.
References DebugInFunction, Foam::endl(), bitSet::flip(), Foam::markupBoundaryPoints(), Foam::foamVersion::patch, and bitSet::sortedToc().
| Foam::labelList boundaryPoints | ( | ) | const |
Return boundary point labels.
Definition at line 869 of file faMeshDemandDrivenData.C.
References DebugInFunction, Foam::endl(), Foam::markupBoundaryPoints(), Foam::foamVersion::patch, and bitSet::sortedToc().
| Foam::tmp< Foam::edgeScalarField > edgeLengthCorrection | ( | ) | const |
Return edge length correction.
Definition at line 2053 of file faMeshDemandDrivenData.C.
References Foam::constant::atomic::alpha, Foam::asin(), boundary, Foam::correction(), Foam::cos(), DebugInFunction, Foam::dimless, stdFoam::end(), Foam::endl(), forAll, Foam::mag(), mesh, and tmp< T >::ref().
| bool correctPatchPointNormals | ( | const label | patchID | ) | const |
Whether point normals should be corrected for a patch.
Definition at line 836 of file faMesh.C.
References Foam::abort(), boundary, Foam::FatalError, FatalErrorInFunction, and patchID.
| Foam::boolList & correctPatchPointNormals | ( | ) | const |
Write mesh.
Reimplemented from regIOobject.
Definition at line 865 of file faMesh.C.
Referenced by faMeshDecomposition::writeDecomposition().
|
static |
|
static |
The mesh sub-directory name (usually "faMesh")
Definition at line 471 of file faMesh.H.
Referenced by faMesh::faMesh(), faMesh::meshDir(), sensitivitySurface::smoothSensitivities(), faMeshReconstructor::writeAddressing(), and faMeshDecomposition::writeDecomposition().
1.8.17 