SIMPLE control class to supply convergence information/checks for the SIMPLE loop. More...
Public Member Functions | |
| 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... | |
| 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 | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| 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 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. More... | |
| Istream & | readStream (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 label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) 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 ®istry, readOption r=NO_READ, writeOption w=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, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| 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, 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, readOption, writeOption) | |
| Copy construct, resetting io options. 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 |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return 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 |
| Return non-constant access to the optional note. 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 | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. 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 fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| 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 |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| 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... | |
| template<> | |
| bool | isHeaderClassName () 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 | |
| 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 label | applyToField (const word &fieldName, const bool useRegEx=true) const |
| Return index of field in residualControl_ if present. 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 | |
| bool | initialised_ |
| Initialised flag. More... | |
| Protected Attributes inherited from solutionControl | |
| 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 | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. 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 an 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 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 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 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... | |
SIMPLE control class to supply convergence information/checks for the SIMPLE loop.
Definition at line 52 of file simpleControl.H.
| simpleControl | ( | fvMesh & | mesh, |
| const word & | dictName = "SIMPLE", |
||
| const bool | verbose = true |
||
| ) |
Construct from mesh and the name of control sub-dictionary.
Definition at line 94 of file simpleControl.C.
References Foam::endl(), Foam::Info, Foam::nl, Foam::read(), and token::TAB.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Read controls from fvSolution dictionary.
Reimplemented from solutionControl.
Reimplemented in SIMPLEControl, SIMPLEControlOpt, and SIMPLEControlSingleRun.
Definition at line 42 of file simpleControl.C.
References solutionControl::read().
Referenced by SIMPLEControl::read().
|
protectedvirtual |
Return true if all convergence checks are satisfied.
Implements solutionControl.
Reimplemented in SIMPLEControlOpt.
Definition at line 49 of file simpleControl.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Info.
Referenced by SIMPLEControlOpt::criteriaSatisfied().
| TypeName | ( | "simpleControl" | ) |
Run-time type information.
|
virtual |
SIMPLE loop.
Implements solutionControl.
Reimplemented in SIMPLEControl, SIMPLEControlOpt, and SIMPLEControlSingleRun.
Definition at line 136 of file simpleControl.C.
References Foam::endl(), Foam::Info, Time::loop(), Foam::nl, Foam::read(), runTime, solutionControl::setFirstIterFlag(), Time::timeName(), and Time::writeAndEnd().
|
protected |
Initialised flag.
Definition at line 62 of file simpleControl.H.
1.8.17 