solutionControl Class Referenceabstract

Solution control class. More...

Inheritance diagram for solutionControl:
Collaboration diagram for solutionControl:

Public Member Functions

 TypeName ("solutionControl")
 Run-time type information. More...
 
 solutionControl (const objectRegistry &registry, const word &algorithmName)
 Construct from the time, the name of the algorithm and a registry. More...
 
virtual ~solutionControl ()
 Destructor. More...
 
const wordalgorithmName () const
 Return the name of the algorithm. More...
 
const char * algorithmSpace () const
 Return some whitespace the same length as the algorithm name. More...
 
virtual const dictionarydict () const =0
 Return the dictionary. More...
 
- 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 global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (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...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 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 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 fileNamecaseName (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 &registry, 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 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< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () 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 fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Static Public Member Functions

static bool finalIteration (const objectRegistry &registry)
 Lookup solutionControl from the objectRegistry and return finalIter. 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...
 

Protected Member Functions

virtual bool dependenciesModified () const =0
 Return true if the dependencies have been modified. More...
 
virtual bool read ()=0
 Read controls. More...
 
virtual bool writeData (Ostream &) const
 Dummy write for regIOobject. 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 Attributes

const objectRegistryregistry_
 Reference to the objectRegistry. More...
 
const word algorithmName_
 Name of the algorithm. More...
 
const string algorithmSpaceStr_
 Whitespace the same length as the algorithm name. More...
 
bool finalIter_
 Flag set true during the final iteration. 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...
 
- 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...
 

Detailed Description

Solution control class.

Source files

Definition at line 49 of file solutionControl.H.

Constructor & Destructor Documentation

◆ solutionControl()

solutionControl ( const objectRegistry registry,
const word algorithmName 
)

Construct from the time, the name of the algorithm and a registry.

Definition at line 53 of file solutionControl.C.

◆ ~solutionControl()

~solutionControl ( )
virtual

Destructor.

Definition at line 79 of file solutionControl.C.

Member Function Documentation

◆ dependenciesModified()

virtual bool dependenciesModified ( ) const
protectedpure virtual

Return true if the dependencies have been modified.

Reimplemented from regIOobject.

Implemented in singleRegionSolutionControl.

◆ read()

bool read ( )
protectedpure virtual

Read controls.

Reimplemented from regIOobject.

Implemented in nonOrthogonalSolutionControl, fluidSolutionControl, simpleControl, pisoControl, pimpleNoLoopControl, and pimpleMultiRegionControl.

Definition at line 38 of file solutionControl.C.

Referenced by pimpleMultiRegionControl::read(), and nonOrthogonalSolutionControl::read().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream ) const
protectedvirtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 44 of file solutionControl.C.

References NotImplemented.

◆ TypeName()

TypeName ( "solutionControl"  )

Run-time type information.

◆ algorithmName()

const Foam::word & algorithmName ( ) const
inline

◆ algorithmSpace()

const char * algorithmSpace ( ) const
inline

Return some whitespace the same length as the algorithm name.

Definition at line 40 of file solutionControlI.H.

◆ dict()

virtual const dictionary& dict ( ) const
pure virtual

Return the dictionary.

Implemented in singleRegionSolutionControl, and multiRegionSolutionControl.

Referenced by singleRegionConvergenceControl::read(), singleRegionCorrectorConvergenceControl::read(), and pimpleLoop::read().

Here is the caller graph for this function:

◆ finalIteration()

bool finalIteration ( const objectRegistry registry)
static

Lookup solutionControl from the objectRegistry and return finalIter.

Definition at line 85 of file solutionControl.C.

References objectRegistry::foundType(), and objectRegistry::lookupType().

Referenced by fvMatrix< Type >::relaxationFactor(), GeometricField< Type, PatchField, GeoMesh >::relaxationFactor(), fvMatrix< Type >::fvSolver::solve(), and fvMatrix< Type >::solve().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ registry_

const objectRegistry& registry_
protected

Reference to the objectRegistry.

Definition at line 58 of file solutionControl.H.

◆ algorithmName_

const word algorithmName_
protected

Name of the algorithm.

Definition at line 61 of file solutionControl.H.

Referenced by solutionControl::algorithmName().

◆ algorithmSpaceStr_

const string algorithmSpaceStr_
protected

Whitespace the same length as the algorithm name.

Definition at line 64 of file solutionControl.H.

◆ finalIter_

bool finalIter_
mutableprotected

Flag set true during the final iteration.

Definition at line 67 of file solutionControl.H.


The documentation for this class was generated from the following files: