Provides a centralised coordinateSystem collection. More...
Public Member Functions | |
| TypeName ("coordinateSystems") | |
| Runtime type information. More... | |
| coordinateSystems (const coordinateSystems &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~coordinateSystems () |
| Destructor. More... | |
| virtual bool | global () const |
| Is object global. 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... | |
| void | operator= (const coordinateSystems &)=delete |
| Disallow default bitwise assignment. More... | |
 Public Member Functions inherited from DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems > | |
| virtual const word & | type () const |
| Runtime type information. More... | |
| virtual | ~DemandDrivenMeshObject () |
| const objectRegistry & | mesh () const |
| 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 &&) | |
| Move 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... | |
| virtual bool | globalFile () const |
| Return true if object is global, i.e. same for all processors. More... | |
| const fileName & | caseName () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | registered () const |
| Is this object registered with the registry? 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... | |
| 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 | read () |
| Read object. 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 | dependenciesModified () const |
| Return true if the object's dependencies have been modified. More... | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) 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 &) |
| Assign to IOobject. More... | |
| void | operator= (const regIOobject &)=delete |
| Disallow default assignment. More... | |
| const fileName & | caseName (const bool global) const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | filePath (const word &typeName, const bool global) const |
| Return complete path + object name if the file exists. More... | |
| 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... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () const |
| Return the instance directory, constant, system, <time> etc. More... | |
| void | updateInstance () const |
| If the instance is a time directory update to the current time. More... | |
| const fileName & | local () const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | relativePath () const |
| Return the path relative to the case directory. More... | |
| fileName | relativeObjectPath () const |
| Return complete relativePath + object name. More... | |
| fileName | filePath (const word &typeName, const bool global) const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read header of local object without type-checking. 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) |
| Public Member Functions inherited from DeletableMeshObject< Mesh > | |
| template<class Type > | |
| DeletableMeshObject (Type &mo) | |
| virtual | ~DeletableMeshObject ()=default |
| Virtual destructor to make class polymorphic. More... | |
| Public Member Functions inherited from PtrDictionary< coordinateSystem > | |
| PtrDictionary (const label size=128) | |
| Construct given initial table size. More... | |
| PtrDictionary (const PtrDictionary &) | |
| Copy constructor. More... | |
| PtrDictionary (PtrDictionary &&) | |
| Move constructor. More... | |
| PtrDictionary (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrDictionary (Istream &) | |
| Construct from Istream. More... | |
| const coordinateSystem & | operator[] (const word &key) const |
| Find and return entry. More... | |
| coordinateSystem & | operator[] (const word &key) |
| Find and return entry. More... | |
| Public Member Functions inherited from DictionaryBase< IDLListType, T > | |
| DictionaryBase (const label size=128) | |
| Construct given initial table size. More... | |
| DictionaryBase (const DictionaryBase &) | |
| Copy constructor. More... | |
| DictionaryBase (DictionaryBase &&) | |
| Move constructor. More... | |
| template<class INew > | |
| DictionaryBase (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| DictionaryBase (Istream &) | |
| Construct from Istream using default Istream constructor class. More... | |
| bool | found (const word &) const |
| Search DictionaryBase for given keyword. More... | |
| const T * | lookupPtr (const word &) const |
| Find and return an entry if present, otherwise return nullptr. More... | |
| T * | lookupPtr (const word &) |
| Find and return an entry if present, otherwise return nullptr. More... | |
| const T * | lookup (const word &) const |
| Find and return entry. More... | |
| T * | lookup (const word &) |
| Find and return entry. More... | |
| wordList | toc () const |
| Return the table of contents. More... | |
| wordList | sortedToc () const |
| Return the table of contents as a sorted list. More... | |
| void | insert (const word &, T *) |
| Add at head of dictionary. More... | |
| void | append (const word &, T *) |
| Add at tail of dictionary. More... | |
| T * | remove (const word &) |
| Remove and return entry specified by keyword. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (DictionaryBase< IDLListType, T > &) |
| Transfer the contents of the argument into this DictionaryBase. More... | |
| void | operator= (const DictionaryBase &) |
| const T * | operator[] (const word &key) const |
| Find and return entry. More... | |
| T * | operator[] (const word &key) |
| Find and return entry. More... | |
Protected Member Functions | |
| coordinateSystems (const objectRegistry &obr) | |
| Read construct from objectRegistry. More... | |
| Protected Member Functions inherited from DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems > | |
| DemandDrivenMeshObject (const IOobject &io, const objectRegistry &mesh) | |
| Construct from mesh and IOobject. More... | |
| DemandDrivenMeshObject (const word &name, const objectRegistry &mesh) | |
| Construct from mesh and name. More... | |
| DemandDrivenMeshObject (const objectRegistry &mesh) | |
| Construct from mesh, the name is set to Type::typeName. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
| Read header, check readOpt flags and read data if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
| Protected Member Functions inherited from DictionaryBase< IDLListType, T > | |
| void | addEntries () |
Friends | |
| class | DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems > |
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... | |
| Static Public Member Functions inherited from DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems > | |
| static coordinateSystems & | New (const word &name, const objectRegistry &mesh) |
| Construct and return the named DemandDrivenMeshObject. More... | |
| static coordinateSystems & | New (const objectRegistry &mesh) |
| Construct and return the DemandDrivenMeshObject named Type::typeName. More... | |
| static coordinateSystems & | New (const word &name, const objectRegistry &mesh, const Args &... args) |
| Construct and return the named DemandDrivenMeshObject. More... | |
| static coordinateSystems & | New (const objectRegistry &mesh, const Args &... args) |
| Construct and return the DemandDrivenMeshObject named Type::typeName. More... | |
| static bool | found (const word &name, const objectRegistry &mesh) |
| Return true if the DemandDrivenMeshObject with the given name. More... | |
| static bool | found (const objectRegistry &mesh) |
| Return true if the DemandDrivenMeshObject named Type::typeName. 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 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... | |
| 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 Attributes inherited from DictionaryBase< IDLListType, T > | |
| HashTable< T * > | hashedTs_ |
| HashTable of the entries held on the IDLListType for quick lookup. More... | |
Provides a centralised coordinateSystem collection.
For example with the porous region specified in constant/fvModels as
porosity
{
type porosityForce;
porosityForceCoeffs
{
select cellZone;
cellZone porousBlockage;
type DarcyForchheimer;
// D 100; // Very little blockage
// D 200; // Some blockage but steady flow
// D 500; // Slight waviness in the far wake
D 1000; // Fully shedding behavior
d ($D $D $D);
f (0 0 0);
coordinateSystem porousBlockage;
}
}
the corresponding coordinate system porousBlockage is looked-up automatically from the constant/coordinateSystems dictionary:
porousBlockage
{
type cartesian;
origin (0 0 0);
coordinateRotation
{
type axesRotation;
e1 (1 0 0);
e2 (0 1 0);
}
}
See tutorials/modules/incompressibleFluid/porousBlockage
Definition at line 97 of file coordinateSystems.H.
|
explicitprotected |
Read construct from objectRegistry.
Definition at line 42 of file coordinateSystems.C.
References IOstream::ASCII, and regIOobject::readHeaderOk().
|
delete |
Disallow default bitwise copy construction.
|
inlinevirtual |
Destructor.
Definition at line 142 of file coordinateSystems.H.
| TypeName | ( | "coordinateSystems" | ) |
Runtime type information.
|
inlinevirtual |
Is object global.
Reimplemented from regIOobject.
Definition at line 149 of file coordinateSystems.H.
|
virtual |
ReadData function required for regIOobject read operation.
Reimplemented from regIOobject.
Definition at line 72 of file coordinateSystems.C.
References IOstream::bad(), dict, forAllConstIter, Foam::vtkWriteOps::insert(), Foam::name(), and coordinateSystem::New().
|
virtual |
WriteData function required for regIOobject write operation.
Reimplemented from DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems >.
Definition at line 95 of file coordinateSystems.C.
|
delete |
Disallow default bitwise assignment.
|
friend |
Definition at line 1 of file coordinateSystems.H.
1.9.1