pisoControl Class Reference

Piso control class. Provides time-loop and piso-loop control methods. No convergence checking is done. More...

Inheritance diagram for pisoControl:
Collaboration diagram for pisoControl:

Public Member Functions

 TypeName ("pisoControl")
 Run-time type information. More...
 
 pisoControl (fvMesh &mesh, const word &algorithmName="PISO")
 Construct from a mesh and the name of the algorithm. More...
 
virtual ~pisoControl ()
 Destructor. More...
 
virtual bool read ()
 Read controls. More...
 
label nCorrPiso () const
 Maximum number of piso correctors. More...
 
bool anyPisoIter () const
 Flag to indicate any piso iteration. More...
 
bool firstPisoIter () const
 Flag to indicate the first piso iteration. More...
 
bool finalPisoIter () const
 Flag to indicate the last piso iteration. More...
 
bool finalInnerIter () const
 Flag to indicate the last inner iteration (last piso and last. More...
 
virtual bool isFinal () const
 Flag to indicate whether in final state. More...
 
bool correct ()
 Piso loop. More...
 
bool run (Time &time)
 Time run loop. More...
 
bool loop (Time &time)
 Time loop loop. More...
 
- Public Member Functions inherited from fluidSolutionControl
 TypeName ("fluidSolutionControl")
 Run-time type information. More...
 
 fluidSolutionControl (fvMesh &mesh, const word &algorithmName)
 Construct from a mesh and the name of the algorithm. More...
 
virtual ~fluidSolutionControl ()
 Destructor. More...
 
bool models () const
 Flag to indicate to solve for the options models. More...
 
bool thermophysics () const
 Flag to indicate to solve for the thermophysics. More...
 
bool flow () const
 Flag to indicate to solve for the flow. 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 "consistent". More...
 
- Public Member Functions inherited from nonOrthogonalSolutionControl
 TypeName ("nonOrthogonalSolutionControl")
 Run-time type information. More...
 
 nonOrthogonalSolutionControl (fvMesh &mesh, const word &algorithmName)
 Construct from a mesh and the name of the algorithm. More...
 
virtual ~nonOrthogonalSolutionControl ()
 Destructor. More...
 
label nCorrNonOrth () const
 Maximum number of non-orthogonal correctors. More...
 
bool anyNonOrthogonalIter () const
 Flag to indicate any non-orthogonal iteration. More...
 
bool firstNonOrthogonalIter () const
 Flag to indicate the first non-orthogonal iteration. More...
 
bool finalNonOrthogonalIter () const
 Flag to indicate the last non-orthogonal iteration. More...
 
bool correctNonOrthogonal ()
 Non-orthogonal corrector loop. More...
 
- Public Member Functions inherited from singleRegionSolutionControl
 TypeName ("singleRegionSolutionControl")
 Run-time type information. More...
 
 singleRegionSolutionControl (fvMesh &mesh, const word &algorithmName)
 Construct from a mesh and the name of the algorithm. More...
 
virtual ~singleRegionSolutionControl ()
 Destructor. More...
 
const fvMeshmesh () const
 Return the mesh. More...
 
fvMeshmesh ()
 Return the mesh. More...
 
virtual const dictionarydict () const
 Return the solution dictionary. More...
 
void updateFinal () const
 Update the mesh data for the final state. More...
 
void storePrevIterFields ()
 Store previous iteration for fields. More...
 
- Public Member Functions inherited from solutionControl
 TypeName ("solutionControl")
 Run-time type information. More...
 
 solutionControl (const objectRegistry &registry, const Time &time, const word &algorithmName)
 Construct from the time, the name of the algorithm and a registry. More...
 
virtual ~solutionControl ()
 Destructor. More...
 
const Timetime () const
 Return the time. More...
 
const wordalgorithmName () const
 Return the name of the algorithm. More...
 
const char * algorithmSpace () const
 Return some whitespace the same length as the algorithm name. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
boolregisterObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 

Protected Attributes

label nCorrPiso_
 Maximum number of piso correctors. More...
 
label corrPiso_
 Current piso corrector. More...
 
- Protected Attributes inherited from fluidSolutionControl
bool models_
 Flag to indicate to solve for the optional models. More...
 
bool thermophysics_
 Flag to indicate to solve for the thermophysics. More...
 
bool flow_
 Flag to indicate to solve for the flow. 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 "consistent" approach. More...
 
- Protected Attributes inherited from nonOrthogonalSolutionControl
label nCorrNonOrth_
 Maximum number of non-orthogonal correctors. More...
 
label corrNonOrth_
 Current non-orthogonal corrector index. More...
 
- Protected Attributes inherited from singleRegionSolutionControl
fvMeshmesh_
 Reference to the mesh. More...
 
- Protected Attributes inherited from solutionControl
const Timetime_
 Reference to the time. More...
 
const word algorithmName_
 Name of the algorithm. More...
 
const string algorithmSpaceStr_
 Whitespace the same length as the algorithm name. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Protected Member Functions inherited from singleRegionSolutionControl
template<class Type >
void storePrevIterTypeFields () const
 Store previous iteration for fields. More...
 
- Protected Member Functions inherited from solutionControl
virtual bool writeData (Ostream &) const
 Dummy write for regIOobject. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Detailed Description

Piso control class. Provides time-loop and piso-loop control methods. No convergence checking is done.

Source files

Definition at line 52 of file pisoControl.H.

Constructor & Destructor Documentation

◆ pisoControl()

pisoControl ( fvMesh mesh,
const word algorithmName = "PISO" 
)

Construct from a mesh and the name of the algorithm.

Definition at line 38 of file pisoControl.C.

References pisoControl::read().

Here is the call graph for this function:

◆ ~pisoControl()

~pisoControl ( )
virtual

Destructor.

Definition at line 50 of file pisoControl.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pisoControl"  )

Run-time type information.

◆ read()

bool read ( )
virtual

Read controls.

Reimplemented from fluidSolutionControl.

Reimplemented in pimpleNoLoopControl, and pimpleControl.

Definition at line 56 of file pisoControl.C.

References singleRegionSolutionControl::dict(), dictionary::lookupOrDefault(), pisoControl::nCorrPiso_, and fluidSolutionControl::read().

Referenced by pisoControl::correct(), pisoControl::pisoControl(), and pimpleNoLoopControl::read().

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

◆ nCorrPiso()

Foam::label nCorrPiso ( ) const
inline

Maximum number of piso correctors.

Definition at line 28 of file pisoControlI.H.

References pisoControl::nCorrPiso_.

◆ anyPisoIter()

bool anyPisoIter ( ) const
inline

Flag to indicate any piso iteration.

Definition at line 34 of file pisoControlI.H.

References pisoControl::corrPiso_.

Referenced by pisoControl::isFinal().

Here is the caller graph for this function:

◆ firstPisoIter()

bool firstPisoIter ( ) const
inline

Flag to indicate the first piso iteration.

Definition at line 40 of file pisoControlI.H.

References pisoControl::corrPiso_.

◆ finalPisoIter()

bool finalPisoIter ( ) const
inline

Flag to indicate the last piso iteration.

Definition at line 46 of file pisoControlI.H.

References pisoControl::corrPiso_, and pisoControl::nCorrPiso_.

Referenced by pisoControl::correct(), pisoControl::finalInnerIter(), and pisoControl::isFinal().

Here is the caller graph for this function:

◆ finalInnerIter()

bool finalInnerIter ( ) const
inline

Flag to indicate the last inner iteration (last piso and last.

non-orthogonal)

Definition at line 52 of file pisoControlI.H.

References nonOrthogonalSolutionControl::finalNonOrthogonalIter(), and pisoControl::finalPisoIter().

Here is the call graph for this function:

◆ isFinal()

bool isFinal ( ) const
virtual

Flag to indicate whether in final state.

Reimplemented from singleRegionSolutionControl.

Reimplemented in pimpleNoLoopControl.

Definition at line 71 of file pisoControl.C.

References nonOrthogonalSolutionControl::anyNonOrthogonalIter(), pisoControl::anyPisoIter(), nonOrthogonalSolutionControl::finalNonOrthogonalIter(), and pisoControl::finalPisoIter().

Referenced by pimpleNoLoopControl::isFinal().

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

◆ correct()

bool correct ( )

Piso loop.

Definition at line 80 of file pisoControl.C.

References pisoControl::corrPiso_, pisoControl::finalPisoIter(), pisoControl::read(), and singleRegionSolutionControl::updateFinal().

Referenced by thermoSingleLayer::evolveRegion(), and kinematicSingleLayer::evolveRegion().

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

◆ run()

bool run ( Time time)

Time run loop.

Definition at line 101 of file pisoControl.C.

References Time::run().

Here is the call graph for this function:

◆ loop()

bool loop ( Time time)

Time loop loop.

Definition at line 107 of file pisoControl.C.

References Time::loop().

Here is the call graph for this function:

Member Data Documentation

◆ nCorrPiso_

label nCorrPiso_
protected

Maximum number of piso correctors.

Definition at line 61 of file pisoControl.H.

Referenced by pisoControl::finalPisoIter(), pisoControl::nCorrPiso(), and pisoControl::read().

◆ corrPiso_

label corrPiso_
protected

Current piso corrector.

Definition at line 64 of file pisoControl.H.

Referenced by pisoControl::anyPisoIter(), pisoControl::correct(), pisoControl::finalPisoIter(), and pisoControl::firstPisoIter().


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