Specialization of the pimpleControl class for PISO control. More...
Public Member Functions | |
TypeName ("pisoControl") | |
Run-time type information. More... | |
pisoControl (fvMesh &mesh, const word &dictName="PISO") | |
Construct from mesh and the name of control sub-dictionary. More... | |
virtual | ~pisoControl () |
Destructor. More... | |
bool | finalInnerIter () const |
Return true if in the final inner (PISO) iteration. More... | |
Public Member Functions inherited from pimpleControl | |
TypeName ("pimpleControl") | |
Run-time type information. More... | |
pimpleControl (fvMesh &mesh, const word &dictName="PIMPLE") | |
Construct from mesh and the name of control sub-dictionary. More... | |
virtual | ~pimpleControl () |
Destructor. More... | |
label | nCorrPIMPLE () const |
Maximum number of PIMPLE correctors. More... | |
label | nCorrPISO () const |
Maximum number of PISO correctors. More... | |
label | corrPISO () const |
Current PISO corrector index. More... | |
virtual bool | loop () |
PIMPLE loop. More... | |
bool | correct () |
Pressure corrector loop. More... | |
bool | storeInitialResiduals () const |
Helper function to identify when to store the intial residuals. More... | |
bool | firstIter () const |
Helper function to identify first PIMPLE (outer) iteration. More... | |
bool | finalIter () const |
Helper function to identify final PIMPLE (outer) iteration. More... | |
bool | finalInnerIter () const |
Helper function to identify final inner iteration. More... | |
bool | turbCorr () const |
Helper function to identify whether to solve for turbulence. 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 () |
Destructor. More... | |
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 | correctNonOrthogonal () |
Non-orthogonal corrector loop. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. More... | |
Foam::autoPtr< IOobject > | clone () const |
Clone. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () const |
Return the optional note. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
bool & | registerObject () |
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 |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
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 |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. More... | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
bool | headerOk () |
Read and check header info. 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< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
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... | |
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) |
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... | |
Protected Member Functions inherited from pimpleControl | |
virtual void | read () |
Read controls from fvSolution dictionary. More... | |
virtual bool | criteriaSatisfied () |
Return true if all convergence checks are satisfied. More... | |
Protected Member Functions inherited from solutionControl | |
virtual void | 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... | |
template<class Type > | |
void | maxTypeResidual (const word &fieldName, ITstream &data, scalar &firstRes, scalar &lastRes) const |
scalar | maxResidual (const word &fieldName, ITstream &data, scalar &lastRes) const |
Protected Member Functions inherited from IOobject | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Istream * | objectStream (const fileName &) |
Construct and return an IFstream for the object given the. More... | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Protected Attributes inherited from pimpleControl | |
label | nCorrPIMPLE_ |
Maximum number of PIMPLE correctors. More... | |
label | nCorrPISO_ |
Maximum number of PISO correctors. More... | |
label | corrPISO_ |
Current PISO corrector. More... | |
bool | turbOnFinalIterOnly_ |
Flag to indicate whether to only solve turbulence on final iter. More... | |
bool | converged_ |
Converged 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... | |
label | corr_ |
Current corrector loop index. More... | |
label | corrNonOrtho_ |
Current non-orthogonal corrector loop index. More... | |
Specialization of the pimpleControl class for PISO control.
Definition at line 49 of file pisoControl.H.
pisoControl | ( | fvMesh & | mesh, |
const word & | dictName = "PISO" |
||
) |
Construct from mesh and the name of control sub-dictionary.
Definition at line 38 of file pisoControl.C.
|
virtual |
Destructor.
Definition at line 48 of file pisoControl.C.
TypeName | ( | "pisoControl" | ) |
Run-time type information.
|
inline |
Return true if in the final inner (PISO) iteration.
Definition at line 29 of file pisoControl.H.