Base class for solution control classes. More...
Classes | |
struct | fieldData |
Simple convenient storage of field residuals. More... | |
Public Member Functions | |
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 | |
void | operator= (const regIOobject &)=delete |
No copy assignment. More... | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
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 object from registry, and remove all file watches. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
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 dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () 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... | |
Istream & | readStream (const word &, const bool readOnProc=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 label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
virtual bool | write (const bool writeOnProc=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 cmp, const bool writeOnProc) 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 ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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 ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. 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... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. 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... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global 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 |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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 |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) 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) |
template<class Type > | |
Foam::fileName | typeFilePath (const bool search) const |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Static Public Member Functions | |
static Pair< scalar > | maxResidual (const fvMesh &fvmesh, const entry &dataDictEntry) |
Extract maximum residual for the solver performance entry, provided the corresponding volume field is available on the mesh. More... | |
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 (std::unique_ptr< 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 (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 word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 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 Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Protected Member Functions | |
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... | |
Static Protected Member Functions | |
template<class Type > | |
static bool | maxTypeResidual (const fvMesh &fvmesh, const entry &solverPerfDictEntry, Pair< scalar > &residuals) |
Initial and final residual of the specified field-name, provided that the corresponding volume field is available on the fvMesh. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Protected Attributes | |
fvMesh & | mesh_ |
Reference to the mesh database. More... | |
List< fieldData > | residualControl_ |
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 | 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... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
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 Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
solutionControl | ( | fvMesh & | mesh, |
const word & | algorithmName | ||
) |
Construct from mesh.
Definition at line 265 of file solutionControl.C.
|
virtualdefault |
Destructor.
|
static |
Extract maximum residual for the solver performance entry, provided the corresponding volume field is available on the mesh.
Definition at line 236 of file solutionControl.C.
References Foam::ensightOutput::debug, Foam::Info, and Foam::nl.
|
protectedvirtual |
Read controls from fvSolution dictionary.
Definition at line 34 of file solutionControl.C.
References solutionControl::fieldData::absTol, solutionControl::applyToField(), solutionControl::consistent_, Foam::ensightOutput::debug, solutionControl::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, solutionControl::frozenFlow_, dictionary::get(), dictionary::getOrDefault(), Foam::Info, solutionControl::fieldData::initialResidual, solutionControl::momentumPredictor_, solutionControl::fieldData::name, Foam::nl, solutionControl::nNonOrthCorr_, solutionControl::fieldData::relTol, solutionControl::residualControl_, solutionDict(), and solutionControl::transonic_.
|
protectedvirtual |
Read controls from fvSolution dictionary.
Reimplemented from regIOobject.
Reimplemented in SIMPLEControl, pimpleControl, pisoControl, SIMPLEControlOpt, SIMPLEControlSingleRun, and simpleControl.
Definition at line 129 of file solutionControl.C.
References Foam::read().
Referenced by simpleControl::read(), and pimpleControl::read().
|
protectedvirtual |
Return index of field in residualControl_ if present.
Definition at line 136 of file solutionControl.C.
References forAll, string::match(), and Foam::name().
Referenced by solutionControl::read().
|
protectedpure virtual |
Return true if all convergence checks are satisfied.
Implemented in pimpleControl, SIMPLEControlOpt, and simpleControl.
|
protectedvirtual |
Store previous iteration fields.
Definition at line 153 of file solutionControl.C.
Referenced by SIMPLEControlSingleRun::loop(), and SIMPLEControlOpt::loop().
|
protected |
Store previous iteration field for vol<Type>Fields.
Definition at line 29 of file solutionControlTemplates.C.
References solutionControl::algorithmName_, string::contains(), DebugInfo, Foam::endl(), fld, solutionControl::mesh_, and solution::relaxField().
|
staticprotected |
Initial and final residual of the specified field-name, provided that the corresponding volume field is available on the fvMesh.
Populate residuals with initial residual as first member and the final residual as second (last) member.
Definition at line 211 of file solutionControl.C.
References Foam::cmptMax(), Pair< T >::first(), objectRegistry::foundObject(), entry::keyword(), FixedList< T, N >::last(), and entry::stream().
|
protected |
Extract the maximum residual for the specified field.
Definition at line 165 of file solutionControl.C.
|
protectedvirtual |
Set the firstIteration flag on the mesh data dictionary.
Reimplemented in pimpleControl.
Definition at line 174 of file solutionControl.C.
References Foam::check(), DebugInfo, and Foam::endl().
Referenced by simpleControl::loop(), SIMPLEControlSingleRun::loop(), and pimpleControl::setFirstIterFlag().
|
protectedvirtual |
Dummy write for regIOobject.
Implements regIOobject.
Definition at line 199 of file solutionControl.C.
References NotImplemented.
TypeName | ( | "solutionControl" | ) |
Run-time type information.
|
virtual |
Return the solution dictionary.
Reimplemented in SIMPLEControl.
Definition at line 293 of file solutionControl.C.
References dictionary::subOrEmptyDict().
Referenced by pimpleControl::read(), and solutionControl::read().
|
inline |
Current corrector loop index.
Definition at line 23 of file solutionControlI.H.
References solutionControl::corr_.
|
inline |
Current non-orthogonal corrector index.
Definition at line 29 of file solutionControlI.H.
|
inline |
Maximum number of non-orthogonal correctors.
Definition at line 35 of file solutionControlI.H.
|
inline |
Helper function to identify final non-orthogonal iteration.
Definition at line 41 of file solutionControlI.H.
|
inline |
Flag to indicate to solve for momentum.
Definition at line 47 of file solutionControlI.H.
|
inline |
Flag to indicate to solve using transonic algorithm.
Definition at line 53 of file solutionControlI.H.
|
inline |
Flag to indicate to relax pressure using the.
"consistent" approach of SIMPLEC
Definition at line 59 of file solutionControlI.H.
|
inline |
Flag to indicate that the flow system of equations should not.
be evolved
Definition at line 65 of file solutionControlI.H.
|
pure virtual |
Main control loop.
Implemented in pimpleControl, SIMPLEControl, SIMPLEControlOpt, SIMPLEControlSingleRun, and simpleControl.
|
inline |
Non-orthogonal corrector loop.
Definition at line 71 of file solutionControlI.H.
References Foam::ensightOutput::debug, Foam::endl(), and Foam::Info.
|
protected |
Reference to the mesh database.
Definition at line 85 of file solutionControl.H.
Referenced by solutionControl::storePrevIter().
List of residual data per field.
Definition at line 90 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
The dictionary name, e.g. SIMPLE, PIMPLE.
Definition at line 95 of file solutionControl.H.
Referenced by solutionControl::storePrevIter().
|
protected |
Maximum number of non-orthogonal correctors.
Definition at line 103 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
Flag to indicate to solve for momentum.
Definition at line 108 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
Flag to indicate to solve using transonic algorithm.
Definition at line 113 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
Flag to indicate to relax pressure using the.
"consistent" approach of SIMPLEC
Definition at line 120 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
Flag to indicate that the flow system of equations should not.
be evolved
Definition at line 127 of file solutionControl.H.
Referenced by solutionControl::read().
|
protected |
Current corrector loop index.
Definition at line 135 of file solutionControl.H.
Referenced by solutionControl::corr().
|
protected |
Current non-orthogonal corrector loop index.
Definition at line 140 of file solutionControl.H.