Finite area mesh (used for 2-D non-Euclidian finite area method) defined using a patch of faces on a polyMesh (ie, uindirectPrimitivePatch). More...
Public Types | |
typedef faMesh | Mesh |
The mesh type. More... | |
typedef faBoundaryMesh | BoundaryMesh |
The boundary type associated with the mesh. More... | |
Public Types inherited from IOobject | |
enum | readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 } |
Enumeration defining the read options. More... | |
enum | writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
Enumeration defining the write options. More... | |
enum | objectState : char { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from dictionary | |
typedef Searcher< true > | const_searcher |
Searcher with const access. More... | |
typedef Searcher< false > | searcher |
Searcher with non-const access. More... | |
Public Types inherited from UILList< LListBase, T > | |
typedef T | value_type |
Type of values stored. More... | |
typedef T * | pointer |
Pointer for value_type. More... | |
typedef const T * | const_pointer |
Const pointer for value_type. More... | |
typedef T & | reference |
Reference for value_type. More... | |
typedef const T & | const_reference |
Const reference for value_type. More... | |
typedef label | size_type |
The type that can represent the container size. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
using | base_iterator = typename LListBase::iterator |
using | const_base_iterator = typename LListBase::const_iterator |
Public Member Functions | |
TypeName ("faMesh") | |
Runtime type information. More... | |
faMesh (const polyMesh &pMesh, const bool doInit=true) | |
Read construct from polyMesh, using its IOobject properties. More... | |
faMesh (const polyMesh &pMesh, const Foam::zero) | |
Construct zero-sized from polyMesh. More... | |
faMesh (const faMesh &baseMesh, const Foam::zero) | |
faMesh (const faMesh &baseMesh, labelList &&faceLabels) | |
faMesh (const polyMesh &pMesh, labelList &&faceLabels) | |
faMesh (const polyMesh &pMesh, labelList &&faceLabels, const IOobject &io) | |
faMesh (const polyPatch &pp, const bool doInit=true) | |
Construct from single polyPatch. More... | |
faMesh (const polyMesh &pMesh, const dictionary &faMeshDefinition, const bool doInit=true) | |
Construct from definition. More... | |
virtual | ~faMesh () |
Destructor. More... | |
void | addFaPatches (faPatchList &plist, const bool validBoundary=true) |
Add boundary patches. Constructor helper. More... | |
void | addFaPatches (const List< faPatch * > &p, const bool validBoundary=true) |
Add boundary patches. Constructor helper. More... | |
bool | init (const bool doInit) |
Initialise non-demand-driven data etc. More... | |
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 points. More... | |
const edgeList & | edges () const noexcept |
Return local edges with reordered boundary. More... | |
const edgeList::subList | internalEdges () const |
Sub-list of local internal edges. More... | |
const faceList & | faces () const |
Return local faces. More... | |
const labelList & | edgeOwner () const noexcept |
Edge owner addressing. More... | |
const labelList & | edgeNeighbour () const noexcept |
Edge neighbour addressing. More... | |
bool | hasInternalEdgeLabels () const noexcept |
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 |
const word & | regionName () const |
The mesh region name or word::null if polyMesh::defaultRegion. 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 noexcept |
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... | |
void | removeFiles (const fileName &instanceDir) const |
Remove all files from mesh instance. More... | |
void | removeFiles () const |
Remove all files from mesh instance() 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 lduMesh | |
TypeName ("lduMesh") | |
Runtime type information. More... | |
virtual | ~lduMesh ()=default |
Destructor. More... | |
virtual bool | hasDb () const =0 |
Return true if thisDb() is a valid DB. More... | |
virtual const objectRegistry & | thisDb () const |
Return the object registry. More... | |
virtual const lduAddressing & | lduAddr () const =0 |
Return ldu addressing. More... | |
virtual lduInterfacePtrsList | interfaces () const =0 |
virtual label | comm () const =0 |
Return communicator used for parallel communication. More... | |
template<class T , class BinaryOp > | |
void | reduce (T &Value, const BinaryOp &bop) const |
Helper: reduce with current communicator. More... | |
InfoProxy< lduMesh > | info () const |
Return info proxy. 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 IOobject::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) | |
Construct for objectRegistry, readOption, (system) dictionary name. More... | |
faSchemes (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
faSchemes (const objectRegistry &obr, const IOobject::readOption rOpt, 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 IOobject::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) | |
Construct for objectRegistry, readOption, (system) dictionary name. More... | |
schemesLookup (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
const 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... | |
virtual fileName | filePath () const =0 |
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... | |
virtual bool | global () const =0 |
Is object global. More... | |
void | operator= (const baseIOdictionary &rhs) |
Copy assignment of dictionary entries (leave regIOobject untouched) More... | |
void | operator= (const dictionary &rhs) |
Copy assignment of dictionary entries. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const 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... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool valid=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< 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 the object 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 |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
bool | registerObject () const noexcept |
Should object created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference, return previous value. More... | |
bool | globalObject () const noexcept |
Is object same for all processors? More... | |
bool | globalObject (bool on) noexcept |
Change global-object status, return previous value. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
readOption | readOpt () const noexcept |
The read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Change the read option, return previous value. More... | |
writeOption | writeOpt () const noexcept |
The write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Change the write option, return previous value. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
bool | readHeader (Istream &is) |
bool | readHeader (dictionary &headerDict, Istream &is) |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
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 | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
Public Member Functions inherited from 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 matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Search dictionary for given keyword. More... | |
const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using scoping. More... | |
const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using dot or slash scoping. More... | |
searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
Search using dot or slash scoping. More... | |
const 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 matchOpt=keyType::REGEX) const |
Search dictionary for given keyword and any compatibility names. More... | |
bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword and any compatibility names. More... | |
const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
template<class T > | |
bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
void | operator= (const dictionary &rhs) |
Copy assignment. More... | |
void | operator+= (const dictionary &rhs) |
Include entries from the given dictionary. More... | |
void | operator|= (const dictionary &rhs) |
Conditionally include entries from the given dictionary. More... | |
void | operator<<= (const dictionary &rhs) |
Unconditionally include entries from the given dictionary. More... | |
template<class T > | |
T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
template<class T > | |
T | lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
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 add initial item pointer. More... | |
ILList (Istream &is) | |
Construct from Istream. More... | |
ILList (const ILList< LListBase, T > &lst) | |
Copy construct using the 'clone()' method for each element. More... | |
ILList (ILList< LListBase, T > &&lst) | |
Move construct. More... | |
template<class CloneArg > | |
ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone 'clone()'. More... | |
template<class INew > | |
ILList (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
~ILList () | |
Destructor. More... | |
bool | eraseHead () |
Remove the head element specified from the list and delete it. More... | |
bool | erase (T *item) |
Remove the specified element from the list and delete it. More... | |
void | clear () |
Clear the contents of the list. More... | |
void | transfer (ILList< LListBase, T > &lst) |
void | operator= (const ILList< LListBase, T > &lst) |
Copy assignment using the 'clone()' method for each element. More... | |
void | operator= (ILList< LListBase, T > &&lst) |
Move assignment. More... | |
Public Member Functions inherited from UILList< LListBase, T > | |
UILList ()=default | |
Default construct. More... | |
UILList (T *item) | |
Construct and add initial item pointer. More... | |
UILList (const UILList< LListBase, T > &lst) | |
Construct as copy. More... | |
T * | first () |
The first entry in the list. More... | |
const T * | first () const |
The first entry in the list (const access) More... | |
T * | last () |
The last entry in the list. More... | |
const T * | last () const |
The last entry in the list (const access) More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *item) |
Remove and return element. More... | |
T * | remove (iterator &iter) |
Remove and return item specified by iterator. More... | |
void | operator= (const UILList< LListBase, T > &lst) |
Copy assignment. More... | |
bool | operator== (const UILList< LListBase, T > &lst) const |
Equality. True both lists are element-wise equal. More... | |
bool | operator!= (const UILList< LListBase, T > &lst) const |
The opposite of the equality operation. Takes linear time. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write UILList with line-breaks when length exceeds shortLen. More... | |
iterator | begin () |
Iterator to first item in list with non-const access. More... | |
const_iterator | cbegin () const |
Iterator to first item in list with const access. More... | |
reverse_iterator | rbegin () |
Iterator to last item in list with non-const access. More... | |
const_reverse_iterator | crbegin () const |
Iterator to last item in list with const access. More... | |
const_iterator | begin () const |
Iterator to first item in list with const access. More... | |
const_reverse_iterator | rbegin () const |
Iterator to last item in list with const access. More... | |
const iterator & | end () |
End of list for forward iterators. More... | |
const const_iterator & | cend () const |
End of list for forward iterators. More... | |
const reverse_iterator & | rend () |
End of list for reverse iterators. More... | |
const const_reverse_iterator & | crend () const |
End of list for reverse iterators. More... | |
const const_iterator & | end () const |
End of list for forward iterators. More... | |
const const_reverse_iterator & | rend () const |
End of list for reverse iterators. More... | |
Public Member Functions inherited from edgeInterpolation | |
ClassName ("edgeInterpolation") | |
edgeInterpolation (const faMesh &) | |
Construct given an faMesh. More... | |
~edgeInterpolation () | |
Destructor. More... | |
const faMesh & | mesh () const noexcept |
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... | |
const edgeVectorField & | correctionVectors () const |
Return reference to non-orthogonality correction vectors array. More... | |
const edgeVectorField & | skewCorrectionVectors () const |
Return reference to skew vectors array. More... | |
bool | orthogonal () const |
Return whether mesh is orthogonal or not. More... | |
bool | skew () const |
Return whether mesh is skew or not. More... | |
bool | movePoints () const |
Do what is necessary if the mesh has moved. More... | |
bool | hasWeights () const noexcept |
True if weights exist. More... | |
Public Member Functions inherited from faSolution | |
faSolution (const faSolution &)=delete | |
No copy construct. More... | |
void | operator= (const faSolution &)=delete |
No copy assignment. More... | |
faSolution (const objectRegistry &obr, const IOobject::readOption rOpt, const word &dictName, const dictionary *fallback=nullptr) | |
Construct for objectRegistry, readOption, (system) dictionary name. More... | |
faSolution (const objectRegistry &obr, const word &dictName, const dictionary *fallback=nullptr) | |
faSolution (const objectRegistry &obr, const IOobject::readOption rOpt, const dictionary *fallback=nullptr) | |
faSolution (const objectRegistry &obr, const dictionary *fallback=nullptr) | |
faSolution (const objectRegistry &obr, const dictionary &dict) | |
Public Member Functions inherited from solution | |
solution (const objectRegistry &obr, const IOobject::readOption rOpt, const fileName &dictName, const dictionary *fallback=nullptr) | |
Construct for objectRegistry, readOption, (system) dictionary name. More... | |
solution (const objectRegistry &obr, const fileName &dictName, const dictionary *fallback=nullptr) | |
virtual | ~solution () |
Destructor. More... | |
bool | cache (const word &name) const |
Return true if the given field should be cached. More... | |
bool | relaxField (const word &name) const |
Return true if the relaxation factor is given for the field. More... | |
bool | relaxEquation (const word &name) const |
Return true if the relaxation factor is given for the equation. More... | |
scalar | fieldRelaxationFactor (const word &name) const |
Return the relaxation factor for the given field. More... | |
scalar | equationRelaxationFactor (const word &name) const |
Return the relaxation factor for the given equation. More... | |
const dictionary & | solutionDict () const |
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 Member Functions | |
static int | geometryOrder () noexcept |
Return the current geometry treatment (0: primitive, 1: standard) More... | |
static int | geometryOrder (const int order) noexcept |
Set the preferred geometry treatment. More... | |
static autoPtr< faMesh > | TryNew (const polyMesh &pMesh) |
Read construction from polyMesh if all files are available. More... | |
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 regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static 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... | |
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 schemesLookup | |
static int | debug |
Debug switch. 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 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 | |
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) defined using a patch of faces on a polyMesh (ie, uindirectPrimitivePatch).
The ordering of faces and points on the faMesh corresponds to the localFaces and localPoints as per Foam::PrimitivePatch but the edge addressing is handled slightly differently. The internal edges of the faMesh will generally correspond identically to the internalEdges of the PrimitivePatch (may change in the future) but the boundaryEdges will be reordered compared to the PrimitivePatch to allow edge boundary slices to be obtained.
typedef faBoundaryMesh BoundaryMesh |
Read construct from polyMesh, using its IOobject properties.
Definition at line 316 of file faMesh.C.
References IOobject::AUTO_WRITE, DebugInFunction, Foam::endl(), Foam::fileHandler(), lduScheduleEntry::init, Foam::isFile(), faMesh::mesh(), faMesh::meshSubDir, IOobject::MUST_READ, faMesh::time(), objectRegistry::time(), timeName, and Time::timePath().
faMesh | ( | const polyMesh & | pMesh, |
const Foam::zero | |||
) |
Construct zero-sized from polyMesh.
Boundary is added using addFaPatches() member function
faMesh | ( | const faMesh & | baseMesh, |
const Foam::zero | |||
) |
Construct as copy (for dictionaries) and zero-sized without boundary, using IOobject properties from polyMesh.
Boundary is added using addFaPatches() member function
Construct as copy (for dictionaries) and faceLabels without boundary, using IOobject properties from polyMesh.
Boundary is added using addFaPatches() member function
Construct from components (face labels) without boundary, using IOobject properties from polyMesh.
Boundary is added using addFaPatches() member function.
Construct from components (face labels) without boundary, using alternative IOobject properties (primarily the readOption).
Boundary is added using addFaPatches() member function.
Construct from single polyPatch.
Definition at line 571 of file faMesh.C.
References faMesh::addFaPatches(), DebugInFunction, Foam::endl(), lduScheduleEntry::init, and patchIdentifier::name().
faMesh | ( | const polyMesh & | pMesh, |
const dictionary & | faMeshDefinition, | ||
const bool | doInit = true |
||
) |
Construct from definition.
Definition at line 598 of file faMesh.C.
References faMesh::addFaPatches(), IOobject::AUTO_WRITE, DebugInFunction, Foam::endl(), Foam::fileHandler(), dictionary::findDict(), dictionary::getOrDefault(), lduScheduleEntry::init, Foam::isFile(), faMesh::mesh(), faMesh::meshSubDir, IOobject::MUST_READ, dictionary::subDict(), faMesh::time(), objectRegistry::time(), timeName, and Time::timePath().
TypeName | ( | "faMesh" | ) |
Runtime type information.
|
inlinestaticnoexcept |
|
inlinestaticnoexcept |
|
static |
Read construction from polyMesh if all files are available.
Definition at line 146 of file faMeshNew.C.
References Time::New().
void addFaPatches | ( | faPatchList & | plist, |
const bool | validBoundary = true |
||
) |
Add boundary patches. Constructor helper.
Definition at line 37 of file faMeshPatches.C.
References Foam::abort(), faMesh::boundary(), faBoundaryMesh::checkDefinition(), Foam::FatalError, FatalErrorInFunction, and PtrList< T >::transfer().
Referenced by faMesh::faMesh(), faMeshTools::loadOrCreateMesh(), and faMeshDecomposition::writeDecomposition().
Add boundary patches. Constructor helper.
Definition at line 63 of file faMeshPatches.C.
References p.
Initialise non-demand-driven data etc.
const_cast<areaVectorField&>(faceAreaNormals()).boundaryFieldRef() .evaluateCoupled<processorFaPatch>();
Definition at line 268 of file faMesh.C.
References UPstream::parRun().
|
inline |
Return access to polyMesh.
Definition at line 31 of file faMeshI.H.
References MeshObject< Mesh, MeshObjectType, Type >::mesh().
Referenced by faMeshDistributor::distribute(), surfactantProperties::dSigma(), faMesh::faMesh(), faMeshReconstructor::faMeshReconstructor(), faMesh::moving(), faMesh::operator()(), and lumpedPointDisplacementPointPatchVectorField::setPatchControls().
Interface to referenced polyMesh (similar to GeoMesh)
Definition at line 608 of file faMesh.H.
References faMesh::mesh().
Foam::fileName meshDir | ( | ) | const |
Return the local mesh directory (dbDir()/meshSubDir)
Definition at line 667 of file faMesh.C.
References polyMesh::dbDir(), mesh, and faMesh::meshSubDir.
const Foam::Time & time | ( | ) | const |
Return reference to time.
Definition at line 673 of file faMesh.C.
References mesh, and fvMesh::time().
Referenced by reconstructionSchemes::alreadyReconstructed(), blackBodyEmission::blackBodyEmission(), contactAngleForce::correct(), faMeshDistributor::distributeField(), surfactantProperties::dSigma(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), faMesh::faMesh(), faMeshSubset::interpolate(), phaseModel::phaseModel(), and filmTurbulenceModel::primaryRegionFriction().
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 679 of file faMesh.C.
References mesh, and polyMesh::pointsInstance().
const Foam::fileName & facesInstance | ( | ) | const |
Return the current instance directory for faces.
Definition at line 685 of file faMesh.C.
References polyMesh::facesInstance(), and mesh.
|
inlinevirtualnoexcept |
Return communicator used for parallel communication.
Implements lduMesh.
Definition at line 44 of file faMeshI.H.
Referenced by lduMatrix::solver::normFactor().
|
inlinenoexcept |
|
inlinenoexcept |
Number of local mesh points.
Definition at line 56 of file faMeshI.H.
Referenced by Foam::createReconstructMap(), and faMeshDecomposition::writeDecomposition().
|
inlinenoexcept |
Number of local mesh edges.
Definition at line 62 of file faMeshI.H.
Referenced by Foam::createReconstructMap(), and faMeshDistributor::faMeshDistributor().
|
inlinenoexcept |
Number of internal faces.
Definition at line 68 of file faMeshI.H.
Referenced by faFieldReconstructor::reconstructField(), 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 Foam::createReconstructMap(), faFieldReconstructor::reconstructField(), and faMeshDecomposition::writeDecomposition().
|
inline |
|
inlinenoexcept |
|
inline |
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
True if the internalEdges use an ordering that does not correspond 1-to-1 with the patch internalEdges.
Definition at line 148 of file faMeshI.H.
Referenced by faMeshDistributor::distribute().
|
virtual |
|
virtual |
Return reference to the mesh database.
Reimplemented from lduMesh.
Definition at line 697 of file faMesh.C.
References mesh, and fvMesh::thisDb().
Referenced by faFieldDecomposer::decomposeField(), faMeshDistributor::distributeField(), faMeshSubset::interpolate(), faMesh::name(), faFieldReconstructor::reconstructField(), faMeshDecomposition::writeDecomposition(), and faMeshTools::writeProcAddressing().
|
inline |
Name function is needed to disambiguate those inherited from base classes
Definition at line 687 of file faMesh.H.
References IOobject::name(), and faMesh::thisDb().
const Foam::word & regionName | ( | ) | const |
The mesh region name or word::null if polyMesh::defaultRegion.
Definition at line 703 of file faMesh.C.
References Foam::name(), and polyMesh::regionName().
|
inlinenoexcept |
Return constant reference to boundary mesh.
Definition at line 38 of file faMeshI.H.
Referenced by faMesh::addFaPatches(), interfaceTrackingFvMesh::correctUsBoundaryConditions(), Foam::createReconstructMap(), faFieldDecomposer::decomposeField(), faMeshDistributor::distribute(), faMeshDistributor::distributeField(), faMeshMapper::faMeshMapper(), fvMatrix< Type >::fvMatrix(), faMeshSubset::interpolate(), fvMeshSubset::interpolate(), faMeshTools::loadOrCreateMesh(), faFieldReconstructor::reconstructField(), faFieldDecomposer::reset(), interfaceTrackingFvMesh::update(), faMeshDecomposition::writeDecomposition(), and faMeshReconstructor::writeMesh().
|
inlinenoexcept |
Return the underlying polyMesh face labels.
Definition at line 122 of file faMeshI.H.
Referenced by faMeshDistributor::distribute(), faMeshDistributor::faMeshDistributor(), and volSurfaceMapping::mapToSurface().
const Foam::faGlobalMeshData & globalData | ( | ) | const |
Return parallel info.
Definition at line 893 of file faMesh.C.
Referenced by faMesh::updateMesh().
|
virtual |
Return ldu addressing.
Implements lduMesh.
Definition at line 904 of file faMesh.C.
Referenced by dynamicOversetFvMesh::lduAddr(), faMesh::neighbour(), faMesh::owner(), and dynamicOversetFvMesh::updateAddressing().
|
inlinevirtual |
|
inline |
Internal face owner.
Definition at line 719 of file faMesh.H.
References faMesh::lduAddr(), and lduAddressing::lowerAddr().
Referenced by contactAngleForce::correct().
|
inline |
Internal face neighbour.
Definition at line 725 of file faMesh.H.
References faMesh::lduAddr(), and lduAddressing::upperAddr().
Referenced by contactAngleForce::correct().
|
inlinenoexcept |
|
inline |
Foam::labelList boundaryProcs | ( | ) | const |
Boundary edge neighbour processors (does not include own proc)
Definition at line 758 of file faMeshTopology.C.
References HashTable< T, Key, Hash >::erase(), HashSet< Key, Hash >::insert(), processorFaPatch::myProcNo(), PstreamBuffers::nProcs(), and HashTable< T, Key, Hash >::sortedToc().
Foam::List< Foam::labelPair > boundaryProcSizes | ( | ) | const |
List of proc/size for the boundary edge neighbour processors (does not include own proc)
Definition at line 776 of file faMeshTopology.C.
References HashTable< T, Key, Hash >::erase(), processorFaPatch::myProcNo(), PstreamBuffers::nProcs(), Foam::output(), HashTable< T, Key, Hash >::size(), and HashTable< T, Key, Hash >::sortedToc().
const Foam::faMeshBoundaryHalo & boundaryHaloMap | ( | ) | const |
Mapping/swapping for boundary halo neighbours.
Definition at line 803 of file faMeshTopology.C.
References faMeshBoundaryHalo::reset().
const Foam::pointField & haloFaceCentres | ( | ) | const |
Face centres of boundary halo neighbours.
Definition at line 857 of file faMeshTopology.C.
const Foam::vectorField & haloFaceNormals | ( | ) | const |
Face normals of boundary halo neighbours.
Definition at line 868 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 880 of file faMeshTopology.C.
References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Time::New(), Foam::nl, and UList< T >::size().
Foam::tmp< Foam::vectorField > haloFaceNormals | ( | const label | patchi | ) | const |
Face normals of boundary halo neighbours for specified patch.
Definition at line 905 of file faMeshTopology.C.
References boundary, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Time::New(), Foam::nl, and UList< T >::size().
void removeFiles | ( | const fileName & | instanceDir | ) | const |
Remove all files from mesh instance.
Definition at line 709 of file faMesh.C.
References fileName::path(), and Foam::rm().
void removeFiles | ( | ) | const |
Remove all files from mesh instance()
Definition at line 718 of file faMesh.C.
References mesh.
Referenced by hexRef8::removeFiles(), meshRefinement::removeFiles(), hexRef8::write(), and STARCDMeshWriter::write().
|
inline |
Is mesh moving.
Definition at line 776 of file faMesh.H.
References faMesh::mesh(), and polyMesh::moving().
Referenced by boundedBackwardFaDdtScheme::facDdt(), and boundedBackwardFaDdtScheme::famDdt().
|
virtual |
Update after mesh motion.
Definition at line 915 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.
Definition at line 38 of file faMeshUpdate.C.
References faMeshMapper::areaMap(), faBoundaryMesh::calcGeometry(), PrimitivePatch< FaceList, PointField >::edgeFaces(), forAll, HashTable< T, Key, Hash >::found(), 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(), UPtrList< T >::size(), and faBoundaryMesh::updateMesh().
|
virtual |
Map all fields in time using given map.
Definition at line 151 of file faMeshUpdate.C.
Referenced by faMesh::updateMesh().
|
virtual |
Map face areas in time using given map.
Definition at line 173 of file faMeshUpdate.C.
References faMeshMapper::areaMap(), DebugInFunction, Foam::endl(), Foam::faceMap(), forAll, faAreaMapper::newFaceLabelsMap(), nFaces(), and List< T >::setSize().
Referenced by faMesh::updateMesh().
|
inline |
Return constant reference to primitive patch.
Definition at line 128 of file faMeshI.H.
Referenced by faMeshDecomposition::decomposeMesh(), faMeshDistributor::distribute(), and faMesh::updateMesh().
|
inline |
const Foam::labelList & patchStarts | ( | ) | const |
const Foam::edgeVectorField & Le | ( | ) | const |
Return edge length vectors.
Definition at line 735 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion().
const Foam::edgeScalarField & magLe | ( | ) | const |
Return edge length magnitudes.
Definition at line 746 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion().
const Foam::areaVectorField & areaCentres | ( | ) | const |
Return face centres as areaVectorField.
Definition at line 757 of file faMesh.C.
Referenced by areaMesh::C(), and faMeshDistributor::faMeshDistributor().
const Foam::edgeVectorField & edgeCentres | ( | ) | const |
Return edge centres as edgeVectorField.
Definition at line 768 of file faMesh.C.
Referenced by edgeMesh::C(), and faMeshDistributor::faMeshDistributor().
const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S | ( | ) | const |
Return face areas.
Definition at line 780 of file faMesh.C.
Referenced by sensitivitySurface::computeRadius(), contactAngleForce::correct(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::famDdt(), liquidFilmModel::info(), liquidFilmModel::postEvolveRegion(), filmTurbulenceModel::primaryRegionFriction(), and interfaceTrackingFvMesh::update().
const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S0 | ( | ) | const |
Return old-time face areas.
Definition at line 792 of file faMesh.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by boundedBackwardFaDdtScheme::facDdt(), and boundedBackwardFaDdtScheme::famDdt().
const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S00 | ( | ) | const |
Return old-old-time face areas.
Definition at line 806 of file faMesh.C.
References IOobject::AUTO_WRITE, mesh, IOobject::NO_READ, IOobject::NO_WRITE, and timeName.
Referenced by boundedBackwardFaDdtScheme::facDdt(), and boundedBackwardFaDdtScheme::famDdt().
const Foam::areaVectorField & faceAreaNormals | ( | ) | const |
Return face area normals.
Definition at line 830 of file faMesh.C.
Referenced by kinematicThinFilm::evolveRegion(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), liquidFilmBase::liquidFilmBase(), filmTurbulenceModel::primaryRegionFriction(), interfaceTrackingFvMesh::surfaceTensionGrad(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), and liquidFilmBase::Uw().
const Foam::edgeVectorField & edgeAreaNormals | ( | ) | const |
const Foam::vectorField & pointAreaNormals | ( | ) | const |
const Foam::areaScalarField & faceCurvatures | ( | ) | const |
Return face curvatures.
Definition at line 870 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 1026 of file faMeshDemandDrivenData.C.
References DebugInFunction, Foam::endl(), bitSet::flip(), Foam::markupBoundaryPoints(), and bitSet::sortedToc().
Foam::labelList boundaryPoints | ( | ) | const |
Return boundary point labels.
Definition at line 1038 of file faMeshDemandDrivenData.C.
References DebugInFunction, Foam::endl(), Foam::markupBoundaryPoints(), and bitSet::sortedToc().
Foam::tmp< Foam::edgeScalarField > edgeLengthCorrection | ( | ) | const |
Return edge length correction.
Definition at line 1899 of file faMeshDemandDrivenData.C.
References alpha, Foam::asin(), boundary, Foam::correction(), Foam::cos(), DebugInFunction, Foam::dimless, Foam::endl(), forAll, Foam::mag(), mesh, and Time::New().
bool correctPatchPointNormals | ( | const label | patchID | ) | const |
Whether point normals should be corrected for a patch.
Definition at line 976 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 1005 of file faMesh.C.
Referenced by faMeshTools::loadOrCreateMesh(), and faMeshDecomposition::writeDecomposition().
|
static |
|
static |
The mesh sub-directory name (usually "faMesh")
Definition at line 504 of file faMesh.H.
Referenced by faMesh::faMesh(), faMeshTools::loadOrCreateMesh(), faMesh::meshDir(), faMeshTools::newMesh(), faMeshTools::readProcAddressing(), processorFaMeshes::removeFiles(), sensitivitySurface::smoothSensitivities(), faMeshReconstructor::writeAddressing(), faMeshDecomposition::writeDecomposition(), and faMeshTools::writeProcAddressing().