Provides a centralized coordinateSystem collection. More...
Public Member Functions | |
TypeName ("coordinateSystems") | |
Runtime type information. More... | |
coordinateSystems (const IOobject &) | |
Read construct from IOobject. More... | |
coordinateSystems (const IOobject &, const PtrList< coordinateSystem > &) | |
Construct from IOobject and a PtrList. More... | |
coordinateSystems (const IOobject &, PtrList< coordinateSystem > &&) | |
Construct from IOobject and transferring the PtrList contents. More... | |
coordinateSystems (const coordinateSystems &)=delete | |
Disallow default bitwise copy construction. More... | |
labelList | findIndices (const keyType &key) const |
Find and return indices for all matches. More... | |
label | findIndex (const keyType &key) const |
Find and return index for the first match, return -1 if not found. More... | |
bool | found (const keyType &key) const |
Search for given key. More... | |
wordList | toc () const |
Return the table of contents (list of all keywords) More... | |
bool | writeData (Ostream &) const |
Write data. More... | |
void | operator= (const coordinateSystems &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from IOPtrList< coordinateSystem > | |
TypeName ("PtrList") | |
Runtime type information. More... | |
IOPtrList (const IOobject &, const INew &) | |
Construct from IOobject using given Istream constructor class. More... | |
IOPtrList (const IOobject &) | |
Construct from IOobject. More... | |
IOPtrList (const IOobject &, const label) | |
Construct from IOobject with given size. More... | |
IOPtrList (const IOobject &, const PtrList< coordinateSystem > &) | |
Construct from IOobject and a PtrList. More... | |
IOPtrList (const IOobject &, PtrList< coordinateSystem > &&) | |
Move construct by transferring the PtrList contents. More... | |
IOPtrList (IOPtrList< coordinateSystem > &&) | |
Move constructor. More... | |
virtual | ~IOPtrList () |
Destructor. More... | |
bool | writeData (Ostream &) const |
Pure virtual writaData function. More... | |
void | operator= (const IOPtrList< coordinateSystem > &) |
void | operator= (IOPtrList< coordinateSystem > &&) |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &, const bool isTime=false) | |
Construct from IOobject. Optional flag for if IOobject is the. More... | |
regIOobject (const regIOobject &) | |
Copy constructor. More... | |
regIOobject (const regIOobject &, bool registerCopy) | |
Copy constructor, transferring registry registration to copy. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy constructor with new name, transferring registry registration. More... | |
regIOobject (const IOobject &, const regIOobject &) | |
Copy constructor with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
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... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release () |
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 up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. 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 read=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. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | global () const |
Is object same for all processors. More... | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const |
Write using given format, version and compression. More... | |
virtual bool | write (const bool write=true) const |
Write using setting from DB. More... | |
void | operator= (const IOobject &) |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
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) | |
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) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Construct from copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct from copy resetting name. More... | |
IOobject (const IOobject &io)=default | |
Copy constructor. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () const |
Return the optional note. More... | |
bool & | registerObject () |
Register object created from this IOobject with registry if true. More... | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. More... | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
word | modelName (const char *name) const |
Return the name of the object within this model. More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. More... | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. More... | |
fileName | localPath () const |
Return the path relative to the case. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | localObjectPath () const |
Return complete localPath + object name. More... | |
fileName | localFilePath (const word &typeName) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true) |
Read header (uses typeFilePath to find file) and check header. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &) const |
Write header. More... | |
bool | writeHeader (Ostream &, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
template<class Name > | |
Foam::word | modelName (Name name, const word &model) |
Public Member Functions inherited from PtrList< coordinateSystem > | |
PtrList () | |
Null Constructor. More... | |
PtrList (const label) | |
Construct with size specified. More... | |
PtrList (const PtrList< coordinateSystem > &) | |
Copy constructor. More... | |
PtrList (const PtrList< coordinateSystem > &, const CloneArg &) | |
Copy constructor with additional argument for clone. More... | |
PtrList (PtrList< coordinateSystem > &&) | |
Move constructor. More... | |
PtrList (PtrList< coordinateSystem > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< coordinateSystem > &) | |
Construct as copy of SLPtrList<T> More... | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. More... | |
void | setSize (const label) |
Reset size of PtrList. If extending the PtrList, new entries are. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. More... | |
void | append (coordinateSystem *) |
Append an element at the end of the list. More... | |
void | append (const autoPtr< coordinateSystem > &) |
void | append (const tmp< coordinateSystem > &) |
void | transfer (PtrList< coordinateSystem > &) |
Transfer the contents of the argument PtrList into this PtrList. More... | |
bool | set (const label) const |
Is element set. More... | |
autoPtr< coordinateSystem > | set (const label, coordinateSystem *) |
Set element to given T* and return old element (can be nullptr) More... | |
autoPtr< coordinateSystem > | set (const label, const autoPtr< coordinateSystem > &) |
Set element to given autoPtr<T> and return old element. More... | |
autoPtr< coordinateSystem > | set (const label, const tmp< coordinateSystem > &) |
Set element to given tmp<T> and return old element. More... | |
void | reorder (const labelUList &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
void | operator= (const PtrList< coordinateSystem > &) |
Assignment operator. More... | |
void | operator= (PtrList< coordinateSystem > &&) |
Move assignment operator. More... | |
Public Member Functions inherited from UPtrList< T > | |
UPtrList () | |
Null Constructor. More... | |
UPtrList (const label) | |
Construct with size specified. More... | |
UPtrList (UPtrList< T > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
label | size () const |
Return the number of elements in the UPtrList. More... | |
bool | empty () const |
Return true if the UPtrList is empty (ie, size() is zero) More... | |
T & | first () |
Return reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. More... | |
void | setSize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | resize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | clear () |
Clear the UPtrList, i.e. set size to zero. More... | |
void | transfer (UPtrList< T > &) |
Transfer the contents of the argument UPtrList into this. More... | |
bool | set (const label) const |
Is element set. More... | |
T * | set (const label, T *) |
Set element. Return old element (can be nullptr). More... | |
void | reorder (const labelUList &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
const T & | operator[] (const label) const |
Return element const reference. More... | |
T & | operator[] (const label) |
Return element reference. More... | |
const T * | operator() (const label) const |
Return element const pointer. More... | |
iterator | begin () |
Return an iterator to begin traversing the UPtrList. More... | |
iterator | end () |
Return an iterator to end traversing the UPtrList. More... | |
const_iterator | cbegin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | cend () const |
Return an const_iterator to end traversing the UPtrList. More... | |
const_iterator | begin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | end () const |
Return an const_iterator to end traversing the UPtrList. More... | |
Static Public Member Functions | |
static const coordinateSystems & | New (const objectRegistry &) |
Return previously registered or read construct from "constant". More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
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... | |
template<class Name > | |
static word | modelName (Name name, const word &model) |
Return the name of the object within the given model. More... | |
template<class Stream > | |
static Stream & | writeBanner (Stream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
template<class Stream > | |
static Stream & | writeDivider (Stream &os) |
Write the standard file section divider. More... | |
template<class Stream > | |
static Stream & | writeEndDivider (Stream &os) |
Write the standard end file divider. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from UPtrList< T > | |
typedef T | value_type |
Type of values the UPtrList contains. More... | |
typedef T & | reference |
Type that can be used for storing into UPtrList::value_type objects. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant UPtrList::value_type. More... | |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static constexpr const char * | foamFile = "FoamFile" |
Keyword for the FoamFile header sub-dictionary. More... | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Protected Member Functions inherited from PtrList< coordinateSystem > | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. More... | |
Provides a centralized coordinateSystem collection.
1 ( cat1 { coordinateSystem system_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 both a dictionary and an objectRegistry.
Definition at line 71 of file coordinateSystems.H.
|
explicit |
Read construct from IOobject.
Definition at line 41 of file coordinateSystems.C.
Referenced by coordinateSystems::coordinateSystems().
coordinateSystems | ( | const IOobject & | io, |
const PtrList< coordinateSystem > & | lst | ||
) |
Construct from IOobject and a PtrList.
Definition at line 48 of file coordinateSystems.C.
References coordinateSystems::coordinateSystems().
coordinateSystems | ( | const IOobject & | io, |
PtrList< coordinateSystem > && | lst | ||
) |
Construct from IOobject and transferring the PtrList contents.
Definition at line 58 of file coordinateSystems.C.
References coordinateSystems::New().
|
delete |
Disallow default bitwise copy construction.
TypeName | ( | "coordinateSystems" | ) |
Runtime type information.
|
static |
Return previously registered or read construct from "constant".
Definition at line 71 of file coordinateSystems.C.
References TimePaths::constant(), objectRegistry::foundObject(), objectRegistry::lookupObject(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, regIOobject::store(), and objectRegistry::time().
Referenced by coordinateSystem::coordinateSystem(), and coordinateSystems::coordinateSystems().
Foam::labelList findIndices | ( | const keyType & | key | ) | const |
Find and return indices for all matches.
Definition at line 101 of file coordinateSystems.C.
References Foam::findStrings(), forAll, keyType::isPattern(), IOobject::name(), List< T >::setSize(), UPtrList< T >::size(), and coordinateSystems::toc().
Referenced by coordinateSystems::findIndex().
Foam::label findIndex | ( | const keyType & | key | ) | const |
Find and return index for the first match, return -1 if not found.
Definition at line 126 of file coordinateSystems.C.
References UList< T >::empty(), coordinateSystems::findIndices(), forAll, keyType::isPattern(), and IOobject::name().
Referenced by coordinateSystems::found().
bool found | ( | const keyType & | key | ) | const |
Search for given key.
Definition at line 152 of file coordinateSystems.C.
References coordinateSystems::findIndex().
Foam::wordList toc | ( | ) | const |
Return the table of contents (list of all keywords)
Definition at line 158 of file coordinateSystems.C.
References forAll, UPtrList< T >::operator[](), and UPtrList< T >::size().
Referenced by coordinateSystems::findIndices().
|
virtual |
Write data.
Implements regIOobject.
Definition at line 171 of file coordinateSystems.C.
References token::BEGIN_LIST, token::END_LIST, forAll, IOstream::good(), Foam::nl, UPtrList< T >::operator[](), and UPtrList< T >::size().
|
delete |
Disallow default bitwise assignment.