Pimple single region control class. Provides time-loop control methods which exit the simulation once convergence criteria have been reached. Also provides Pimple-loop control methods which exit the iteration once corrector convergence criteria have been met. Example usage: More...
Public Member Functions | |
TypeName ("pimpleSingleRegionControl") | |
Run-time type information. More... | |
pimpleSingleRegionControl (pimpleNoLoopControl &pimple) | |
Construct from single region pimple. More... | |
pimpleSingleRegionControl (const pimpleSingleRegionControl &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~pimpleSingleRegionControl () |
Destructor. More... | |
virtual bool | read () |
Read controls. More... | |
bool | loop () |
Pimple loop. More... | |
bool | run (Time &time) |
Time run loop. More... | |
bool | loop (Time &time) |
Time loop loop. More... | |
Public Member Functions inherited from pimpleLoop | |
TypeName ("pimpleLoop") | |
Run-time type information. More... | |
pimpleLoop (const solutionControl &control) | |
Construct from a solution control. More... | |
virtual | ~pimpleLoop () |
Destructor. More... | |
label | nCorr () const |
Maximum number of correctors. More... | |
bool | anyIter () const |
Flag to indicate any iteration. More... | |
bool | firstIter () const |
Flag to indicate the first iteration. More... | |
bool | finalIter () const |
Flag to indicate the last iteration. More... | |
bool | loop (correctorConvergenceControl &convergence) |
Pimple loop. More... | |
Additional Inherited Members | |
Protected Attributes inherited from pimpleLoop | |
const solutionControl & | control_ |
Reference to the solution control. More... | |
label | nCorr_ |
Maximum number of correctors. More... | |
label | corr_ |
Current corrector. More... | |
bool | converged_ |
Flag to indicate convergence of the pimple loop. More... | |
Pimple single region control class. Provides time-loop control methods which exit the simulation once convergence criteria have been reached. Also provides Pimple-loop control methods which exit the iteration once corrector convergence criteria have been met. Example usage:
pimpleSingleRegionControl pimple(mesh); while (pimple.run(runTime)) { // pre-time-increment operations ... runTime ++; Info<< "Time = " << runTime.userTimeName() << nl << endl; while (pimple.loop()) { // solve ... } // post-solve operations ... }
Definition at line 72 of file pimpleSingleRegionControl.H.
pimpleSingleRegionControl | ( | pimpleNoLoopControl & | pimple | ) |
Construct from single region pimple.
Definition at line 38 of file pimpleSingleRegionControl.C.
References solutionControl::algorithmName(), Foam::endl(), Foam::Info, singleRegionSolutionControl::mesh(), pimpleLoop::nCorr_, Foam::nl, singleRegionCorrectorConvergenceControl::printCorrResidualControls(), singleRegionConvergenceControl::printResidualControls(), pimpleSingleRegionControl::read(), fvMesh::schemes(), fvSchemes::steady(), and fvSchemes::transient().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 77 of file pimpleSingleRegionControl.C.
TypeName | ( | "pimpleSingleRegionControl" | ) |
Run-time type information.
|
virtual |
Read controls.
Reimplemented from pimpleLoop.
Definition at line 85 of file pimpleSingleRegionControl.C.
References pimpleLoop::read().
Referenced by pimpleSingleRegionControl::pimpleSingleRegionControl().
bool loop | ( | ) |
Pimple loop.
Definition at line 91 of file pimpleSingleRegionControl.C.
References pimpleLoop::loop().
bool run | ( | Time & | time | ) |
Time run loop.
Definition at line 108 of file pimpleSingleRegionControl.C.
bool loop | ( | Time & | time | ) |
Time loop loop.
Definition at line 119 of file pimpleSingleRegionControl.C.
References Time::loop().