SIMPLE control class to supply convergence information/checks for the SIMPLE loop. More...
#include <SIMPLEControl.H>
Public Member Functions | |
| TypeName ("SIMPLEControl") | |
| Run-time type information. | |
| 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. | |
| virtual | ~SIMPLEControl ()=default |
| Destructor. | |
| virtual bool | read () |
| Read controls from optimisationDict. | |
| virtual void | readIters () |
| void | checkMeanSolution () const |
| virtual const dictionary | dict () const |
| Return the solution dictionary. | |
| label & | pRefCell () |
| Return pressure reference cell. | |
| scalar & | pRefValue () |
| Return pressure reference value. | |
| virtual bool | write (const bool valid=true) const =0 |
| Whether to call time.write() or not. | |
| virtual bool | loop ()=0 |
| Loop. | |
| virtual bool | converged () |
| Is the solver converged. | |
| virtual bool | performIter () |
| Perform this iteration? | |
| virtual void | incrementIter () |
| Increment iteration counter. | |
| Public Member Functions inherited from solverControl | |
| TypeName ("solverControl") | |
| Run-time type information. | |
| solverControl (const solver &solver) | |
| Construct from solver. | |
| virtual | ~solverControl ()=default |
| Destructor. | |
| virtual const dictionary | solverDict () const |
| Read controls from optimisationDict. | |
| virtual const dictionary | solutionDict () const |
| Return the solutionControls dictionary. | |
| bool | printMaxMags () const |
| Print max mags of solver fields. | |
| bool | storeInitValues () const |
| Re-initialize. | |
| label | iter () const |
| Return iteration index. | |
| label & | averageIter () |
| Return average iteration index reference. | |
| label | averageIter () const |
| Return const average iteration index reference. | |
| label | averageStartIter () const |
| Return iteration index. | |
| bool | doAverageIter () const |
| Whether or not to add fields of the current iteration to the average fields. | |
| bool | useAveragedFields () const |
| Use averaged fields? For solving the adjoint equations or computing sensitivities based on averaged fields. | |
| bool | average () const |
| Whether averaging is enabled or not. | |
| const solver & | getSolver () const |
| Return reference to the underlaying solver. | |
| Public Member Functions inherited from simpleControl | |
| TypeName ("simpleControl") | |
| Run-time type information. | |
| simpleControl (fvMesh &mesh, const word &dictName="SIMPLE", const bool verbose=true) | |
| Construct from mesh and the name of control sub-dictionary. | |
| virtual | ~simpleControl ()=default |
| Destructor. | |
| Public Member Functions inherited from solutionControl | |
| TypeName ("solutionControl") | |
| Run-time type information. | |
| solutionControl (fvMesh &mesh, const word &algorithmName) | |
| Construct from mesh. | |
| virtual | ~solutionControl ()=default |
| Destructor. | |
| label | corr () const |
| Current corrector loop index. | |
| label | corrNonOrtho () const |
| Current non-orthogonal corrector index. | |
| label | nNonOrthCorr () const |
| Maximum number of non-orthogonal correctors. | |
| bool | finalNonOrthogonalIter () const |
| Helper function to identify final non-orthogonal iteration. | |
| bool | momentumPredictor () const |
| Flag to indicate to solve for momentum. | |
| bool | transonic () const |
| Flag to indicate to solve using transonic algorithm. | |
| bool | consistent () const |
| Flag to indicate to relax pressure using the. | |
| bool | frozenFlow () const |
| Flag to indicate that the flow system of equations should not. | |
| bool | correctNonOrthogonal () |
| Non-orthogonal corrector loop. | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| 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). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| 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. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time). | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| 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. | |
| 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. | |
| 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. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| 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. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| 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. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
Static Public Member Functions | |
| static autoPtr< SIMPLEControl > | New (fvMesh &mesh, const word &managerType, const solver &solver) |
| Return a reference to the selected turbulence model. | |
| Static Public Member Functions inherited from solutionControl | |
| 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. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
Protected Attributes | |
| const word & | managerType_ |
| Optimisation type. | |
| label | nIters_ |
| Number of SIMPLE iterations. | |
| label | pRefCell_ |
| Pressure reference cell. | |
| scalar | pRefValue_ |
| Pressure reference value. | |
| Protected Attributes inherited from solverControl | |
| const solver & | solver_ |
| Reference to the underlaying solver. | |
| bool | printMaxMags_ |
| Whether to print the max magnitude during each solver iteration. | |
| label | iter_ |
| Current iteration index. | |
| label | averageIter_ |
| Current averaging iteration index. | |
| label | averageStartIter_ |
| Averaging start index. | |
| bool | storeInitValues_ |
| Whether to re-initialize the solution based on the initial time step. Makes sense only for optimisation or FD runs. | |
| bool | average_ |
| Do averaging. | |
| Protected Attributes inherited from simpleControl | |
| bool | initialised_ |
| Initialised flag. | |
| Protected Attributes inherited from solutionControl | |
| fvMesh & | mesh_ |
| Reference to the mesh database. | |
| List< fieldData > | residualControl_ |
| List of residual data per field. | |
| const word | algorithmName_ |
| The dictionary name, e.g. SIMPLE, PIMPLE. | |
| label | nNonOrthCorr_ |
| Maximum number of non-orthogonal correctors. | |
| bool | momentumPredictor_ |
| Flag to indicate to solve for momentum. | |
| bool | transonic_ |
| Flag to indicate to solve using transonic algorithm. | |
| bool | consistent_ |
| Flag to indicate to relax pressure using the. | |
| bool | frozenFlow_ |
| Flag to indicate that the flow system of equations should not. | |
| label | corr_ |
| Current corrector loop index. | |
| label | corrNonOrtho_ |
| Current non-orthogonal corrector loop index. | |
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 = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Protected Member Functions inherited from simpleControl | |
| bool | read () |
| Read controls from fvSolution dictionary. | |
| bool | criteriaSatisfied () |
| Return true if all convergence checks are satisfied. | |
| Protected Member Functions inherited from solutionControl | |
| virtual bool | read (const bool absTolOnly) |
| Read controls from fvSolution dictionary. | |
| virtual label | applyToField (const word &fieldName, const bool useRegEx=true) const |
| Return index of field in residualControl_ if present. | |
| virtual void | storePrevIterFields () const |
| Store previous iteration fields. | |
| template<class Type> | |
| void | storePrevIter () const |
| Store previous iteration field for vol<Type>Fields. | |
| Pair< scalar > | maxResidual (const entry &solverPerfDictEntry) const |
| Extract the maximum residual for the specified field. | |
| virtual void | setFirstIterFlag (const bool check=true, const bool force=false) |
| Set the firstIteration flag on the mesh data dictionary. | |
| virtual bool | writeData (Ostream &) const |
| Dummy write for regIOobject. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Static Protected Member Functions inherited from solutionControl | |
| 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. | |
| 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. | |
| 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. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
SIMPLE control class to supply convergence information/checks for the SIMPLE loop.
Definition at line 46 of file SIMPLEControl.H.
Construct from mesh.
Definition at line 36 of file SIMPLEControl.C.
References managerType_, mesh, nIters_, pRefCell_, pRefValue_, read(), and Foam::Zero.
|
virtualdefault |
Destructor.
References mesh.
| TypeName | ( | "SIMPLEControl" | ) |
Run-time type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| SIMPLEControl | , | ||
| dictionary | , | ||
| (fvMesh &mesh, const word &managerType, const solver &solver) | , | ||
| (mesh, managerType, solver) | ) |
References mesh.
|
static |
Return a reference to the selected turbulence model.
Definition at line 56 of file SIMPLEControl.C.
References Foam::exit(), Foam::FatalError, FatalErrorInLookup, and mesh.
|
virtual |
Read controls from optimisationDict.
Reimplemented from solverControl.
Reimplemented in SIMPLEControlOpt, and SIMPLEControlSingleRun.
Definition at line 79 of file SIMPLEControl.C.
References solverControl::average_, solverControl::averageStartIter_, Foam::endl(), nIters_, Foam::nl, simpleControl::read(), solverControl::read(), readIters(), solverControl::solver_, Foam::tab, and WarningInFunction.
Referenced by SIMPLEControlOpt::read(), SIMPLEControlSingleRun::read(), and SIMPLEControl().
|
virtual |
Reimplemented in SIMPLEControlSingleRun.
Definition at line 99 of file SIMPLEControl.C.
References dict, dictionary::get(), and nIters_.
Referenced by read().
| void checkMeanSolution | ( | ) | const |
Definition at line 105 of file SIMPLEControl.C.
References solverControl::average_, solverControl::averageStartIter_, Foam::endl(), solverControl::iter_, Foam::nl, solverControl::solver_, Foam::tab, and WarningInFunction.
Referenced by SIMPLEControlOpt::loop(), and SIMPLEControlSingleRun::loop().
|
inlinevirtual |
Return the solution dictionary.
Reimplemented from solutionControl.
Definition at line 26 of file SIMPLEControlI.H.
References solverControl::solutionDict().
Referenced by SIMPLEControlOpt::read().
|
inline |
Return pressure reference cell.
Definition at line 32 of file SIMPLEControlI.H.
References pRefCell_.
|
inline |
Return pressure reference value.
Definition at line 38 of file SIMPLEControlI.H.
References pRefValue_.
|
pure virtual |
Whether to call time.write() or not.
Reimplemented from regIOobject.
Implemented in SIMPLEControlOpt, and SIMPLEControlSingleRun.
|
pure virtual |
Loop.
Reimplemented from simpleControl.
Implemented in SIMPLEControlOpt, and SIMPLEControlSingleRun.
|
virtual |
Is the solver converged.
Definition at line 118 of file SIMPLEControl.C.
References simpleControl::criteriaSatisfied().
|
virtual |
Perform this iteration?
Definition at line 124 of file SIMPLEControl.C.
|
virtual |
Increment iteration counter.
Definition at line 130 of file SIMPLEControl.C.
|
protected |
|
protected |
Number of SIMPLE iterations.
Definition at line 64 of file SIMPLEControl.H.
Referenced by SIMPLEControlSingleRun::checkEndTime(), SIMPLEControlSingleRun::loop(), SIMPLEControlOpt::nIters(), read(), SIMPLEControlOpt::read(), readIters(), SIMPLEControlSingleRun::readIters(), and SIMPLEControl().
|
protected |
Pressure reference cell.
Definition at line 69 of file SIMPLEControl.H.
Referenced by pRefCell(), and SIMPLEControl().
|
protected |
Pressure reference value.
Definition at line 74 of file SIMPLEControl.H.
Referenced by pRefValue(), and SIMPLEControl().
1.16.1 