MeshObject to store the solver performance residuals of all the fields of the type it is instantiated on. More...
Public Member Functions | |
TypeName ("residuals") | |
Runtime type information. More... | |
Residuals (const polyMesh &mesh) | |
Construct for given mesh. More... | |
Residuals (const Residuals< Type > &)=delete | |
Disallow default bitwise copy construction. More... | |
void | operator= (const Residuals< Type > &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > > | |
MeshObject (const polyMesh &mesh) | |
virtual | ~MeshObject () |
const polyMesh & | mesh () const |
virtual bool | writeData (Foam::Ostream &) const |
Public Member Functions inherited from GeometricMeshObject< polyMesh > | |
GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
Public Member Functions inherited from TopologicalMeshObject< polyMesh > | |
TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
Public Member Functions inherited from meshObject | |
ClassName ("meshObject") | |
meshObject (const word &typeName, const objectRegistry &obr) | |
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 HashTable< DynamicList< SolverPerformance< Type > > > | |
bool | set (const word &, const DynamicList< SolverPerformance< Type > > &newElmt) |
Assign a new hashedEntry, overwriting existing entries. More... | |
HashTable (const label size=128) | |
Construct given initial table size. More... | |
HashTable (Istream &, const label size=128) | |
Construct from Istream. More... | |
HashTable (const HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &) | |
Copy constructor. More... | |
HashTable (HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &&) | |
Move constructor. More... | |
HashTable (std::initializer_list< Tuple2< word, DynamicList< SolverPerformance< Type > > >>) | |
Construct from an initializer list. More... | |
~HashTable () | |
Destructor. More... | |
label | capacity () const |
The size of the underlying table. More... | |
label | size () const |
Return number of elements in table. More... | |
bool | empty () const |
Return true if the hash table is empty. More... | |
bool | found (const word &) const |
Return true if hashedEntry is found in table. More... | |
iterator | find (const word &) |
Find and return an iterator set at the hashedEntry. More... | |
const_iterator | find (const word &) const |
Find and return an const_iterator set at the hashedEntry. More... | |
List< word > | toc () const |
Return the table of contents. More... | |
List< word > | sortedToc () const |
Return the table of contents as a sorted list. More... | |
Ostream & | printInfo (Ostream &) const |
Print information. More... | |
bool | insert (const word &, const DynamicList< SolverPerformance< Type > > &newElmt) |
Insert a new hashedEntry. More... | |
bool | erase (const iterator &) |
Erase a hashedEntry specified by given iterator. More... | |
bool | erase (const word &) |
Erase a hashedEntry specified by the given key. More... | |
label | erase (const UList< word > &) |
Remove entries given by the listed keys from this HashTable. More... | |
label | erase (const HashTable< AnyType, word, AnyHash > &) |
Remove entries given by the given keys from this HashTable. More... | |
Foam::label | erase (const HashTable< AnyType, word, AnyHash > &rhs) |
void | resize (const label newSize) |
Resize the hash table for efficiency. More... | |
void | clear () |
Clear all entries from table. More... | |
void | clearStorage () |
Clear the table entries and the table itself. More... | |
void | shrink () |
Shrink the allocated table to approx. twice number of elements. More... | |
void | transfer (HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &) |
Transfer the contents of the argument table into this table. More... | |
DynamicList< SolverPerformance< Type > > & | operator[] (const word &) |
Find and return a hashedEntry. More... | |
const DynamicList< SolverPerformance< Type > > & | operator[] (const word &) const |
Find and return a hashedEntry. More... | |
DynamicList< SolverPerformance< Type > > & | operator() (const word &) |
Find and return a hashedEntry, create it null if not present. More... | |
void | operator= (const HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &) |
Assignment operator. More... | |
void | operator= (HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &&) |
Move assignment operator. More... | |
void | operator= (std::initializer_list< Tuple2< word, DynamicList< SolverPerformance< Type > > >>) |
Assignment to an initializer list. More... | |
bool | operator== (const HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &) const |
Equality. Hash tables are equal if the keys and values are equal. More... | |
bool | operator!= (const HashTable< DynamicList< SolverPerformance< Type > >, word, string::hash > &) const |
The opposite of the equality operation. Takes linear time. More... | |
iterator | begin () |
Iterator set to the beginning of the HashTable. More... | |
const_iterator | begin () const |
const_iterator set to the beginning of the HashTable More... | |
const_iterator | cbegin () const |
const_iterator set to the beginning of the HashTable More... | |
Public Member Functions inherited from HashTableCore | |
HashTableCore () | |
Construct null. More... | |
ClassName ("HashTable") | |
Define template name and debug. More... | |
Static Public Member Functions | |
static List< word > | fieldNames (const polyMesh &mesh) |
Return the list of field names of the particular type. More... | |
static bool | found (const polyMesh &mesh, const word &fieldName) |
Return true if residuals for the given field are stored. More... | |
static const DynamicList< SolverPerformance< Type > > & | field (const polyMesh &mesh, const word &fieldName) |
Return the list of solver performance residuals for the given field. More... | |
static void | append (const polyMesh &mesh, const SolverPerformance< Type > &) |
Append the given solver performance residuals. More... | |
Static Public Member Functions inherited from MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > > | |
static const Residuals< Type > & | New (const polyMesh &mesh) |
static const Residuals< Type > & | New (const polyMesh &mesh, const Data1 &d) |
static const Residuals< Type > & | New (const polyMesh &mesh, const Data1 &, const Data2 &) |
static const Residuals< Type > & | New (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &) |
static const Residuals< Type > & | New (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &) |
static bool | Delete (const polyMesh &mesh) |
Static Public Member Functions inherited from meshObject | |
template<class Mesh > | |
static void | movePoints (objectRegistry &) |
template<class Mesh > | |
static void | updateMesh (objectRegistry &, const mapPolyMesh &) |
template<class Mesh > | |
static void | addPatch (objectRegistry &, const label patchi) |
template<class Mesh > | |
static void | reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary) |
template<class Mesh , template< class > class MeshObjectType> | |
static void | clear (objectRegistry &) |
template<class Mesh , template< class > class FromType, template< class > class ToType> | |
static void | clearUpto (objectRegistry &) |
Clear all meshObject derived from FromType up to (but not including) 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... | |
Static Public Member Functions inherited from HashTableCore | |
static label | canonicalSize (const label) |
Return a canonical (power-of-two) size. More... | |
static iteratorEnd | cend () |
iteratorEnd set to beyond the end of any HashTable More... | |
static iteratorEnd | end () |
iteratorEnd set to beyond the end of any HashTable 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 HashTable< DynamicList< SolverPerformance< Type > > > | |
typedef DynamicList< SolverPerformance< Type > > | value_type |
Type of values the HashTable contains. More... | |
typedef DynamicList< SolverPerformance< Type > > & | reference |
Type that can be used for storing into HashTable::value_type. More... | |
typedef const DynamicList< SolverPerformance< Type > > & | const_reference |
Type that can be used for storing into constant. More... | |
typedef label | size_type |
The type that can represent the size of a HashTable. 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... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable table size. 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 Attributes inherited from MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > > | |
const polyMesh & | mesh_ |
MeshObject to store the solver performance residuals of all the fields of the type it is instantiated on.
Definition at line 52 of file Residuals.H.
Construct for given mesh.
Definition at line 32 of file Residuals.C.
TypeName | ( | "residuals" | ) |
Runtime type information.
|
static |
Return the list of field names of the particular type.
for which residuals are stored
Definition at line 42 of file Residuals.C.
References MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > >::New(), and HashTable< DynamicList< SolverPerformance< Type > > >::toc().
Return true if residuals for the given field are stored.
Definition at line 52 of file Residuals.C.
References Residuals< Type >::field(), and MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > >::New().
Referenced by Residuals< Type >::append().
|
static |
Return the list of solver performance residuals for the given field.
Definition at line 64 of file Residuals.C.
References Residuals< Type >::append(), and MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > >::New().
Referenced by Residuals< Type >::found().
|
static |
Append the given solver performance residuals.
in the corresponding list
Definition at line 78 of file Residuals.C.
References Residuals< Type >::append(), meshObject::clear(), SolverPerformance< Type >::fieldName(), Residuals< Type >::found(), HashTable< DynamicList< SolverPerformance< Type > > >::insert(), MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > >::New(), Time::prevTimeState(), Time::subCycling(), objectRegistry::time(), timeIndex, and TimeState::timeIndex().
Referenced by Residuals< Type >::append(), and Residuals< Type >::field().