SIMPLEControlSingleRun Class Reference

SIMPLE control class for single runs (i.e. not optimisation). Time acts as in simpleFoam, with all solver control read through optimisationDict. More...

Inheritance diagram for SIMPLEControlSingleRun:
[legend]
Collaboration diagram for SIMPLEControlSingleRun:
[legend]

Public Member Functions

 TypeName ("singleRun")
 Run-time type information. More...
 
 SIMPLEControlSingleRun (fvMesh &mesh, const word &managerType, const solver &solver)
 Construct from mesh. More...
 
virtual ~SIMPLEControlSingleRun ()=default
 Destructor. More...
 
virtual bool write (const bool valid=true) const
 Whether to call time.write() or not. More...
 
void writeNow ()
 Write fields, even if it is not a writeTime. More...
 
virtual bool loop ()
 Loop. More...
 
- Public Member Functions inherited from SIMPLEControl
 TypeName ("SIMPLEControl")
 Run-time type information. More...
 
 declareRunTimeSelectionTable (autoPtr, SIMPLEControl, dictionary,(fvMesh &mesh, const word &managerType, const solver &solver),(mesh, managerType, solver))
 
 SIMPLEControl (fvMesh &mesh, const word &managerType, const solver &solver)
 Construct from mesh. More...
 
virtual ~SIMPLEControl ()=default
 Destructor. More...
 
virtual bool read ()
 Read controls from fvSolution dictionary. More...
 
virtual void readIters ()
 
void checkMeanSolution () const
 
virtual const dictionary dict () const
 Return the solution dictionary. More...
 
label & pRefCell ()
 Return pressure reference cell. More...
 
scalar & pRefValue ()
 Return pressure reference value. More...
 
virtual bool write (const bool valid=true) const =0
 Whether to call time.write() or not. More...
 
virtual bool loop ()=0
 Loop. More...
 
- Public Member Functions inherited from solverControl
 TypeName ("solverControl")
 Run-time type information. More...
 
 solverControl (const solver &solver)
 Construct from solver. More...
 
virtual ~solverControl ()=default
 Destructor. More...
 
virtual const dictionary solverDict () const
 Read controls from optimisationDict. More...
 
virtual const dictionary solutionDict () const
 Return the solutionControls dictionary. More...
 
bool printMaxMags () const
 Print max mags of solver fields. More...
 
bool storeInitValues () const
 Re-initialize. More...
 
label iter () const
 Return iteration index. More...
 
label & averageIter ()
 Return average iteration index reference. More...
 
label averageIter () const
 Return const average iteration index reference. More...
 
label averageStartIter () const
 Return iteration index. More...
 
bool doAverageIter () const
 
bool useAveragedFields () const
 
bool average () const
 Whether averaging is enabled or not. More...
 
- Public Member Functions inherited from simpleControl
 TypeName ("simpleControl")
 Run-time type information. More...
 
 simpleControl (fvMesh &mesh, const word &dictName="SIMPLE", const bool verbose=true)
 Construct from mesh and the name of control sub-dictionary. More...
 
virtual ~simpleControl ()=default
 Destructor. More...
 
virtual bool loop ()
 SIMPLE loop. More...
 
- Public Member Functions inherited from solutionControl
 TypeName ("solutionControl")
 Run-time type information. More...
 
 solutionControl (fvMesh &mesh, const word &algorithmName)
 Construct from mesh. More...
 
virtual ~solutionControl ()=default
 Destructor. More...
 
virtual const dictionary dict () const
 Return the solution dictionary. More...
 
label corr () const
 Current corrector loop index. More...
 
label corrNonOrtho () const
 Current non-orthogonal corrector index. More...
 
label nNonOrthCorr () const
 Maximum number of non-orthogonal correctors. More...
 
bool finalNonOrthogonalIter () const
 Helper function to identify final non-orthogonal iteration. More...
 
bool momentumPredictor () const
 Flag to indicate to solve for momentum. More...
 
bool transonic () const
 Flag to indicate to solve using transonic algorithm. More...
 
bool consistent () const
 Flag to indicate to relax pressure using the. More...
 
bool frozenFlow () const
 Flag to indicate that the flow system of equations should not. More...
 
virtual bool loop ()=0
 Main control loop. More...
 
bool correctNonOrthogonal ()
 Non-orthogonal corrector loop. More...
 
- Public Member Functions inherited from regIOobject
 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 registered () const noexcept
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 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 dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () 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. Does not check the headerClassName. More...
 
IstreamreadStream (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 labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writeData function. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. 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...
 
- Public Member Functions inherited from IOobject
 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 &registry, readOption rOpt=NO_READ, writeOption wOpt=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 &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
virtual void rename (const word &newName)
 Rename the object. 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 hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. 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 fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
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
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 

Protected Member Functions

virtual bool read ()
 Read controls from optimisationDict. More...
 
virtual void readIters ()
 Set end time if number of iters has changed. More...
 
void checkEndTime (bool &isRunning)
 
virtual bool read ()
 Read controls from optimisationDict. More...
 
- Protected Member Functions inherited from simpleControl
bool read ()
 Read controls from fvSolution dictionary. More...
 
bool criteriaSatisfied ()
 Return true if all convergence checks are satisfied. More...
 
- Protected Member Functions inherited from solutionControl
virtual bool read (const bool absTolOnly)
 Read controls from fvSolution dictionary. More...
 
virtual bool read ()
 Read controls from fvSolution dictionary. More...
 
virtual label applyToField (const word &fieldName, const bool useRegEx=true) const
 Return index of field in residualControl_ if present. More...
 
virtual bool criteriaSatisfied ()=0
 Return true if all convergence checks are satisfied. More...
 
virtual void storePrevIterFields () const
 Store previous iteration fields. More...
 
template<class Type >
void storePrevIter () const
 Store previous iteration field for vol<Type>Fields. More...
 
Pair< scalar > maxResidual (const entry &solverPerfDictEntry) const
 Extract the maximum residual for the specified field. More...
 
virtual void setFirstIterFlag (const bool check=true, const bool force=false)
 Set the firstIteration flag on the mesh data dictionary. More...
 
virtual bool writeData (Ostream &) const
 Dummy write for regIOobject. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 

Protected Attributes

scalar startTime_
 Start time. More...
 
scalar endTime_
 End time. More...
 
- Protected Attributes inherited from SIMPLEControl
const wordmanagerType_
 Optimisation type. More...
 
label nIters_
 Number of SIMPLE iterations. More...
 
label pRefCell_
 Pressure reference cell. More...
 
scalar pRefValue_
 Pressure reference value. More...
 
- Protected Attributes inherited from solverControl
const solversolver_
 Reference to the underlaying solver. More...
 
bool printMaxMags_
 Whether to print the max magnitude during each solver iteration. More...
 
label iter_
 Current iteration index. More...
 
label averageIter_
 Current averaging iteration index. More...
 
label averageStartIter_
 Averaging start index. More...
 
bool storeInitValues_
 
bool average_
 Do averaging. More...
 
- Protected Attributes inherited from simpleControl
bool initialised_
 Initialised flag. More...
 
- Protected Attributes inherited from solutionControl
fvMeshmesh_
 Reference to the mesh database. More...
 
List< fieldDataresidualControl_
 List of residual data per field. More...
 
const word algorithmName_
 The dictionary name, e.g. SIMPLE, PIMPLE. More...
 
label nNonOrthCorr_
 Maximum number of non-orthogonal correctors. More...
 
bool momentumPredictor_
 Flag to indicate to solve for momentum. More...
 
bool transonic_
 Flag to indicate to solve using transonic algorithm. More...
 
bool consistent_
 Flag to indicate to relax pressure using the. More...
 
bool frozenFlow_
 Flag to indicate that the flow system of equations should not. More...
 
label corr_
 Current corrector loop index. More...
 
label corrNonOrtho_
 Current non-orthogonal corrector loop index. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
enum  objectState : char { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from SIMPLEControl
static autoPtr< SIMPLEControlNew (fvMesh &mesh, const word &managerType, const solver &solver)
 Return a reference to the selected turbulence model. More...
 
- Static Public Member Functions inherited from solutionControl
static Pair< scalar > maxResidual (const fvMesh &fvmesh, const entry &dataDictEntry)
 
- Static Public Member Functions inherited from regIOobject
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 Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable 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 OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 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...
 
- Static Protected Member Functions inherited from solutionControl
template<class Type >
static bool maxTypeResidual (const fvMesh &fvmesh, const entry &solverPerfDictEntry, Pair< scalar > &residuals)
 
- Static Protected Member Functions inherited from IOobject
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 Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

SIMPLE control class for single runs (i.e. not optimisation). Time acts as in simpleFoam, with all solver control read through optimisationDict.

Definition at line 52 of file SIMPLEControlSingleRun.H.

Constructor & Destructor Documentation

◆ SIMPLEControlSingleRun()

SIMPLEControlSingleRun ( fvMesh mesh,
const word managerType,
const solver solver 
)

Construct from mesh.

Definition at line 93 of file SIMPLEControlSingleRun.C.

◆ ~SIMPLEControlSingleRun()

virtual ~SIMPLEControlSingleRun ( )
virtualdefault

Destructor.

Member Function Documentation

◆ read()

bool read ( )
protectedvirtual

Read controls from optimisationDict.

Reimplemented from SIMPLEControl.

Definition at line 49 of file SIMPLEControlSingleRun.C.

References SIMPLEControl::read().

Here is the call graph for this function:

◆ readIters()

void readIters ( )
protectedvirtual

Set end time if number of iters has changed.

Reimplemented from SIMPLEControl.

Definition at line 55 of file SIMPLEControlSingleRun.C.

References dict, Foam::endl(), Time::endTime(), dictionary::get(), Foam::Info, runTime, Time::setEndTime(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ checkEndTime()

void checkEndTime ( bool isRunning)
protected

Check whether endTime has been overwritten by a run-time modification of controlDict

Definition at line 74 of file SIMPLEControlSingleRun.C.

References TimeState::deltaTValue(), Time::endTime(), Time::setEndTime(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "singleRun"  )

Run-time type information.

◆ write()

bool write ( const bool  valid = true) const
virtual

Whether to call time.write() or not.

Implements SIMPLEControl.

Definition at line 108 of file SIMPLEControlSingleRun.C.

References regIOobject::write().

Here is the call graph for this function:

◆ writeNow()

void writeNow ( )

Write fields, even if it is not a writeTime.

Definition at line 118 of file SIMPLEControlSingleRun.C.

References Time::writeNow(), and TimeState::writeTime().

Here is the call graph for this function:

◆ loop()

bool loop ( )
virtual

Loop.

Implements SIMPLEControl.

Definition at line 131 of file SIMPLEControlSingleRun.C.

References Foam::endl(), Foam::Info, Time::loop(), Foam::nl, Foam::read(), runTime, solutionControl::setFirstIterFlag(), and Time::timeName().

Here is the call graph for this function:

Member Data Documentation

◆ startTime_

scalar startTime_
protected

Start time.

Definition at line 61 of file SIMPLEControlSingleRun.H.

◆ endTime_

scalar endTime_
protected

End time.

Definition at line 64 of file SIMPLEControlSingleRun.H.


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