A centralized collection of named coordinate systems. More...
Public Member Functions | |
TypeNameNoDebug ("coordinateSystems") | |
Declare type-name, virtual type (without debug switch) More... | |
coordinateSystems (const IOobject &io) | |
Read construct from IOobject. More... | |
coordinateSystems (const IOobject &io, const PtrList< coordinateSystem > &content) | |
Construct from IOobject and PtrList content. More... | |
coordinateSystems (const IOobject &io, PtrList< coordinateSystem > &&content) | |
Construct from IOobject and transferring PtrList content. More... | |
labelList | indices (const wordRe &key) const |
Find and return indices for all matches. More... | |
labelList | indices (const wordRes &matcher) const |
Find and return indices for all matches. More... | |
label | findIndex (const wordRe &key) const |
Find and return index for the first match, return -1 if not found. More... | |
label | findIndex (const wordRes &matcher) const |
Find and return index for the first match, return -1 if not found. More... | |
bool | found (const wordRe &key) const |
Search if given key exists. More... | |
const coordinateSystem * | cfind (const word &name) const |
Return pointer to named coordinateSystem or nullptr on error. More... | |
const coordinateSystem & | lookup (const word &name) const |
Return reference to named coordinateSystem or FatalErrror. More... | |
wordList | names () const |
A list of the coordinate-system names. More... | |
wordList | names (const wordRe &key) const |
A list of the coordinate-system names satisfying the input matcher. More... | |
wordList | names (const wordRes &matcher) const |
A list of the coordinate-system names satisfying the input matcher. More... | |
wordList | toc () const |
Identical to names() More... | |
bool | writeData (Ostream &os) const |
Write data. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid=true) const |
Write using stream options. More... | |
labelList | findIndices (const wordRe &key) const |
Identical to the indices() method (AUG-2018) More... | |
const coordinateSystem * | lookupPtr (const word &name) const |
Deprecated(2020-03) find named coordinateSystem or nullptr. More... | |
![]() | |
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... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. 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 | 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 |
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 | 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... | |
![]() | |
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) |
![]() | |
constexpr | PtrList () noexcept |
Default construct. More... | |
PtrList (const label len) | |
Construct with specified size, each element initialized to nullptr. More... | |
PtrList (const PtrList< coordinateSystem > &list) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< coordinateSystem > &&list) | |
Move construct. More... | |
PtrList (UList< coordinateSystem * > &list) | |
Take ownership of pointers in the list, set old pointers to null. More... | |
PtrList (const PtrList< coordinateSystem > &list, const CloneArg &cloneArgs) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< coordinateSystem > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< coordinateSystem > &list) | |
Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
PtrList (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &is) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. More... | |
PtrList< coordinateSystem > | clone (Args &&... args) const |
Make a copy by cloning each of the list elements. More... | |
Foam::PtrList< coordinateSystem > | clone (Args &&... args) const |
const coordinateSystem * | set (const label i) const |
Return const pointer to element (can be nullptr),. More... | |
autoPtr< coordinateSystem > | set (const label i, coordinateSystem *ptr) |
Set element to given pointer and return old element (can be null) More... | |
autoPtr< coordinateSystem > | set (const label i, autoPtr< coordinateSystem > &ptr) |
Set element to given autoPtr and return old element. More... | |
autoPtr< coordinateSystem > | set (const label i, autoPtr< coordinateSystem > &&ptr) |
Set element to given autoPtr and return old element. More... | |
autoPtr< coordinateSystem > | set (const label i, std::unique_ptr< coordinateSystem > &&ptr) |
Set element to given unique_ptr and return old element. More... | |
autoPtr< coordinateSystem > | set (const label i, const refPtr< coordinateSystem > &ptr) |
Set element to given refPtr and return old element. More... | |
autoPtr< coordinateSystem > | set (const label i, const tmp< coordinateSystem > &ptr) |
Set element to given tmp and return old element. More... | |
void | clear () |
Clear the PtrList. Delete allocated entries and set size to zero. More... | |
void | resize (const label newLen) |
Adjust size of PtrList. More... | |
void | setSize (const label newLen) |
Same as resize() More... | |
void | emplace_append (Args &&... args) |
Construct and append an element to the end of the list. More... | |
void | append (coordinateSystem *ptr) |
Append an element to the end of the list. More... | |
void | append (autoPtr< coordinateSystem > &ptr) |
Move append an element to the end of the list. More... | |
void | append (autoPtr< coordinateSystem > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (std::unique_ptr< coordinateSystem > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (const refPtr< coordinateSystem > &ptr) |
Move or clone append a refPtr to the end of the list. More... | |
void | append (const tmp< coordinateSystem > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
autoPtr< coordinateSystem > | emplace (const label i, Args &&... args) |
Construct and set an element. More... | |
Foam::autoPtr< coordinateSystem > | emplace (const label i, Args &&... args) |
autoPtr< coordinateSystem > | release (const label i) |
Release ownership of the pointer at the given position. More... | |
void | transfer (PtrList< coordinateSystem > &list) |
Transfer into this list and annul the argument list. More... | |
void | operator= (const PtrList< coordinateSystem > &list) |
Copy assignment. More... | |
void | operator= (PtrList< coordinateSystem > &&list) |
Move assignment. More... | |
Static Public Member Functions | |
static const coordinateSystems & | New (const objectRegistry &obr) |
Return previously registered or read construct from "constant". More... | |
![]() | |
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 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... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
![]() | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
![]() | |
void | readIstream (Istream &is, const INew &inew) |
Read from Istream using Istream constructor class. More... | |
void | free () |
Delete the allocated entries, but retain the list size. More... | |
![]() | |
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 bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
A centralized collection of named coordinate systems.
cat1 { coordinateSystem { type indirect; name _10; } porosity 0.781; Darcy { d d [0 -2 0 0 0] (-1000 -1000 0.50753e+08); f f [0 -1 0 0 0] (-1000 -1000 12.83); } }
For this to work correctly, the coordinateSystem constructor must be supplied with an objectRegistry as well as the dictionary.
Definition at line 78 of file coordinateSystems.H.
|
explicit |
Read construct from IOobject.
Definition at line 111 of file coordinateSystems.C.
coordinateSystems | ( | const IOobject & | io, |
const PtrList< coordinateSystem > & | content | ||
) |
Construct from IOobject and PtrList content.
Definition at line 121 of file coordinateSystems.C.
coordinateSystems | ( | const IOobject & | io, |
PtrList< coordinateSystem > && | content | ||
) |
Construct from IOobject and transferring PtrList content.
Definition at line 137 of file coordinateSystems.C.
TypeNameNoDebug | ( | "coordinateSystems" | ) |
Declare type-name, virtual type (without debug switch)
|
static |
Return previously registered or read construct from "constant".
Definition at line 152 of file coordinateSystems.C.
References TimePaths::constant(), objectRegistry::findObject(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, regIOobject::store(), and objectRegistry::time().
Foam::labelList indices | ( | const wordRe & | key | ) | const |
Find and return indices for all matches.
A no-op (returns empty list) for an empty key
Definition at line 185 of file coordinateSystems.C.
References Foam::PtrListOps::findMatching(), and Foam::glTF::key().
Referenced by coordinateSystems::findIndices().
Foam::labelList indices | ( | const wordRes & | matcher | ) | const |
Find and return indices for all matches.
A no-op (returns empty list) for an empty matcher
Definition at line 195 of file coordinateSystems.C.
References Foam::PtrListOps::findMatching().
Foam::label findIndex | ( | const wordRe & | key | ) | const |
Find and return index for the first match, return -1 if not found.
A no-op (returns -1) for an empty key
Definition at line 205 of file coordinateSystems.C.
References Foam::PtrListOps::firstMatching(), and Foam::glTF::key().
Foam::label findIndex | ( | const wordRes & | matcher | ) | const |
Find and return index for the first match, return -1 if not found.
A no-op (returns -1) for an empty matcher
Definition at line 215 of file coordinateSystems.C.
References Foam::PtrListOps::firstMatching().
Search if given key exists.
Definition at line 225 of file coordinateSystems.C.
References Foam::findIndex(), and Foam::glTF::key().
const Foam::coordinateSystem * cfind | ( | const word & | name | ) | const |
Return pointer to named coordinateSystem or nullptr on error.
Definition at line 232 of file coordinateSystems.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::PtrListOps::firstMatching(), InfoInFunction, and Foam::name().
Referenced by coordinateSystems::lookupPtr().
const Foam::coordinateSystem & lookup | ( | const word & | name | ) | const |
Return reference to named coordinateSystem or FatalErrror.
Definition at line 256 of file coordinateSystems.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::name(), Foam::PtrListOps::names(), and Foam::nl.
Foam::wordList names | ( | ) | const |
A list of the coordinate-system names.
Definition at line 273 of file coordinateSystems.C.
References Foam::PtrListOps::names().
Referenced by coordinateSystems::toc().
Foam::wordList names | ( | const wordRe & | key | ) | const |
A list of the coordinate-system names satisfying the input matcher.
Definition at line 279 of file coordinateSystems.C.
References Foam::glTF::key(), and Foam::PtrListOps::names().
Foam::wordList names | ( | const wordRes & | matcher | ) | const |
A list of the coordinate-system names satisfying the input matcher.
Definition at line 289 of file coordinateSystems.C.
References Foam::PtrListOps::names().
|
inline |
Identical to names()
Definition at line 169 of file coordinateSystems.H.
References coordinateSystems::names().
Write data.
Implements regIOobject.
Definition at line 299 of file coordinateSystems.C.
References token::BEGIN_LIST, token::END_LIST, IOstream::good(), Foam::nl, and os().
|
virtual |
Write using stream options.
Reimplemented from regIOobject.
Definition at line 318 of file coordinateSystems.C.
References IOstreamOption::ASCII, and regIOobject::writeObject().
Identical to the indices() method (AUG-2018)
Definition at line 192 of file coordinateSystems.H.
References coordinateSystems::indices().
|
inline |
Deprecated(2020-03) find named coordinateSystem or nullptr.
Definition at line 201 of file coordinateSystems.H.
References coordinateSystems::cfind().