SIMPLE control class to supply convergence information/checks for the SIMPLE loop. More...

Inheritance diagram for simpleControl:
Collaboration diagram for simpleControl:

Public Member Functions

 TypeName ("simpleControl")
 Run-time type information. More...
 
 simpleControl (fvMesh &mesh)
 Construct from mesh. More...
 
virtual ~simpleControl ()
 Destructor. More...
 
virtual bool loop ()
 Loop 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 ()
 Destructor. More...
 
const dictionarydict () 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 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 &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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Protected Member Functions

void read ()
 Read controls from fvSolution dictionary. More...
 
bool criteriaSatisfied ()
 Return true if all convergence checks are satisfied. More...
 
 simpleControl (const simpleControl &)
 Disallow default bitwise copy construct. More...
 
void operator= (const simpleControl &)
 Disallow default bitwise assignment. 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...
 
 solutionControl (const solutionControl &)
 Disallow default bitwise copy construct. More...
 
void operator= (const solutionControl &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (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

bool initialised_
 Initialised flag. More...
 
- Protected Attributes inherited from solutionControl
fvMeshmesh_
 Reference to the mesh database. More...
 
List< fieldDataresidualControl_
 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...
 
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 { 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...
 

Detailed Description

SIMPLE control class to supply convergence information/checks for the SIMPLE loop.

Definition at line 47 of file simpleControl.H.

Constructor & Destructor Documentation

simpleControl ( const simpleControl )
protected

Disallow default bitwise copy construct.

~simpleControl ( )
virtual

Destructor.

Definition at line 118 of file simpleControl.C.

Member Function Documentation

void read ( )
protected

Read controls from fvSolution dictionary.

Definition at line 39 of file simpleControl.C.

References solutionControl::read().

Referenced by simpleControl::simpleControl().

Here is the call graph for this function:

Here is the caller graph for this function:

bool criteriaSatisfied ( )
protectedvirtual

Return true if all convergence checks are satisfied.

Implements solutionControl.

Definition at line 45 of file simpleControl.C.

References Foam::endl(), UList< T >::first(), forAllConstIter, and Foam::Info.

Here is the call graph for this function:

void operator= ( const simpleControl )
protected

Disallow default bitwise assignment.

TypeName ( "simpleControl"  )

Run-time type information.

bool loop ( )
virtual

Loop loop.

Implements solutionControl.

Definition at line 124 of file simpleControl.C.

References Foam::endl(), Foam::Info, Time::loop(), Foam::nl, Time::timeName(), and Time::writeAndEnd().

Here is the call graph for this function:

Member Data Documentation

bool initialised_
protected

Initialised flag.

Definition at line 57 of file simpleControl.H.


The documentation for this class was generated from the following files:
  • src/finiteVolume/cfdTools/general/solutionControl/simpleControl/simpleControl.H
  • src/finiteVolume/cfdTools/general/solutionControl/simpleControl/simpleControl.C