Dimensioned<Type> registered with the database as a registered IOobject which has the functionality of a uniform field and allows values from the top-level code to be passed to boundary conditions etc. More...
Public Member Functions | |
| TypeName ("UniformDimensionedField") | |
| Runtime type information. More... | |
| UniformDimensionedField (const IOobject &io, const dimensioned< Type > &dt) | |
| Construct from components. Either reads or uses supplied value. More... | |
| UniformDimensionedField (const UniformDimensionedField< Type > &rdt) | |
| Construct as copy. More... | |
| UniformDimensionedField (const IOobject &io) | |
| Construct from Istream. More... | |
| virtual | ~UniformDimensionedField () |
| Destructor. More... | |
| virtual const word & | name () const |
| Name function provided to resolve the ambiguity between the. More... | |
| virtual bool | readData (Istream &) |
| ReadData function required for regIOobject read operation. More... | |
| bool | writeData (Ostream &) const |
| WriteData function required for regIOobject write operation. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| void | operator= (const UniformDimensionedField< Type > &rhs) |
| Assign name, dimensions and value. More... | |
| void | operator= (const dimensioned< Type > &rhs) |
| Assign name, dimensions and value. More... | |
| Type | operator[] (const label) const |
 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 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 |
| 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... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. 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 dimensioned< Type > | |
| dimensioned () | |
| A dimensionless Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims) | |
| A dimensioned Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims, const Foam::zero) | |
| A dimensioned Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims, const Foam::one) | |
| A dimensioned pTraits::one, named "1". More... | |
| dimensioned (const Type &val) | |
| Implicit construct dimensionless from given value. More... | |
| dimensioned (const dimensionSet &dims, const Type &val) | |
| Construct dimensioned from given value. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const Type &val) | |
| Construct from components (name, dimensions, value). More... | |
| dimensioned (const word &name, const dimensioned< Type > &dt) | |
| Copy construct dimensioned Type with a new name. More... | |
| dimensioned (const primitiveEntry &e) | |
| Construct from primitive entry with given name. More... | |
| dimensioned (const primitiveEntry &e, const dimensionSet &dims) | |
| Construct from primitive entry with given name and dimensions. More... | |
| dimensioned (const word &name, const dictionary &dict) | |
| Construct from dictionary lookup with a given name. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict) | |
| Construct from dictionary lookup with a given name and dimensions. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName) | |
| Construct from dictionary lookup with a given name and dimensions. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict) | |
| const word & | name () const |
| Return const reference to name. More... | |
| word & | name () |
| Return non-const reference to name. More... | |
| const dimensionSet & | dimensions () const |
| Return const reference to dimensions. More... | |
| dimensionSet & | dimensions () |
| Return non-const reference to dimensions. More... | |
| const Type & | value () const |
| Return const reference to value. More... | |
| Type & | value () |
| Return non-const reference to value. More... | |
| dimensioned< cmptType > | component (const direction d) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | replace (const direction d, const dimensioned< cmptType > &dc) |
| Return a component with a dimensioned<cmptType> More... | |
| dimensioned< Type > | T () const |
| Return transpose. More... | |
| bool | read (const dictionary &dict) |
| bool | readIfPresent (const dictionary &dict) |
| bool | read (const word &entryName, const dictionary &dict) |
| bool | readIfPresent (const word &entryName, const dictionary &dict) |
| Istream & | read (Istream &is, const bool readName=true) |
| Istream & | read (Istream &is, const dictionary &readSet) |
| Istream & | read (Istream &is, const HashTable< dimensionedScalar > &readSet) |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write as a dictionary entry with keyword. More... | |
| dimensioned< cmptType > | operator[] (const direction d) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | operator+= (const dimensioned< Type > &dt) |
| void | operator-= (const dimensioned< Type > &dt) |
| void | operator*= (const scalar s) |
| void | operator/= (const scalar s) |
| dimensioned (Istream &is) | |
| dimensioned (const word &name, Istream &is) | |
| dimensioned (const word &name, const dimensionSet &dims, Istream &is) | |
Additional Inherited Members | |
| 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 dimensioned< Type > | |
| typedef Type | value_type |
| The underlying data type. More... | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. 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 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 dimensioned< Type > | |
| static dimensioned< Type > | getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero)) |
| Construct dimensioned from dictionary, with default value. More... | |
| static dimensioned< Type > | getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero)) |
| Construct dimensionless from dictionary, with default value. More... | |
| static dimensioned< Type > | getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero)) |
| Construct dimensioned from dictionary, with default value. More... | |
| static dimensioned< Type > | getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero)) |
| Construct dimensionless from dictionary, with default value. More... | |
| static dimensioned< Type > | lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero)) |
| static dimensioned< Type > | lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero)) |
| Construct dimensionless from dictionary, with default value. More... | |
| static dimensioned< Type > | lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero)) |
| Construct dimensioned from dictionary, with default value. More... | |
| static dimensioned< Type > | lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero)) |
| Construct dimensionless from dictionary, with default value. 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... | |
| 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... | |
| 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) |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Dimensioned<Type> registered with the database as a registered IOobject which has the functionality of a uniform field and allows values from the top-level code to be passed to boundary conditions etc.
Is a 'global' field, same on all processors
Definition at line 56 of file UniformDimensionedField.H.
| UniformDimensionedField | ( | const IOobject & | io, |
| const dimensioned< Type > & | dt | ||
| ) |
Construct from components. Either reads or uses supplied value.
The name of the dimensioned<Type> defines the name of the field.
Definition at line 34 of file UniformDimensionedField.C.
| UniformDimensionedField | ( | const UniformDimensionedField< Type > & | rdt | ) |
Construct as copy.
Definition at line 49 of file UniformDimensionedField.C.
| UniformDimensionedField | ( | const IOobject & | io | ) |
Construct from Istream.
Definition at line 60 of file UniformDimensionedField.C.
|
virtual |
Destructor.
Definition at line 78 of file UniformDimensionedField.C.
| TypeName | ( | "UniformDimensionedField< Type >" | ) |
Runtime type information.
|
inlinevirtual |
Name function provided to resolve the ambiguity between the.
name functions in regIOobject and dimensioned<Type>
Definition at line 94 of file UniformDimensionedField.H.
ReadData function required for regIOobject read operation.
Reimplemented from regIOobject.
Definition at line 85 of file UniformDimensionedField.C.
WriteData function required for regIOobject write operation.
Implements regIOobject.
Definition at line 103 of file UniformDimensionedField.C.
|
inlinevirtual |
Is object global.
Reimplemented from regIOobject.
Definition at line 106 of file UniformDimensionedField.H.
|
inlinevirtual |
Return complete path + object name if the file exists.
either in the case/processor or case otherwise null
Reimplemented from regIOobject.
Definition at line 113 of file UniformDimensionedField.H.
| void operator= | ( | const UniformDimensionedField< Type > & | rhs | ) |
Assign name, dimensions and value.
Definition at line 118 of file UniformDimensionedField.C.
| void operator= | ( | const dimensioned< Type > & | rhs | ) |
Assign name, dimensions and value.
Definition at line 128 of file UniformDimensionedField.C.
|
inline |
Definition at line 127 of file UniformDimensionedField.H.
1.8.17 