Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pimpleLoop Class Reference

Pimple loop class. Implements the logic which controls the pimple loop generically for a given corrector convergence control. Can therefore be used be either single- or multi-region control classes. More...

Inheritance diagram for pimpleLoop:
Inheritance graph
[legend]
Collaboration diagram for pimpleLoop:
Collaboration graph
[legend]

Public Member Functions

 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...
 

Protected Member Functions

virtual bool read ()
 Read controls. More...
 

Protected Attributes

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...
 

Detailed Description

Pimple loop class. Implements the logic which controls the pimple loop generically for a given corrector convergence control. Can therefore be used be either single- or multi-region control classes.

Source files

Definition at line 51 of file pimpleLoop.H.

Constructor & Destructor Documentation

◆ pimpleLoop()

pimpleLoop ( const solutionControl &  control)

Construct from a solution control.

Definition at line 49 of file pimpleLoop.C.

◆ ~pimpleLoop()

~pimpleLoop ( )
virtual

Destructor.

Definition at line 60 of file pimpleLoop.C.

Member Function Documentation

◆ read()

bool read ( )
protectedvirtual

Read controls.

Reimplemented in pimpleSingleRegionControl, and pimpleMultiRegionControl.

Definition at line 38 of file pimpleLoop.C.

References pimpleLoop::control_, solutionControl::dict(), dictionary::lookupOrDefault(), and pimpleLoop::nCorr_.

Referenced by pimpleMultiRegionControl::read(), and pimpleSingleRegionControl::read().

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

◆ TypeName()

TypeName ( "pimpleLoop"  )

Run-time type information.

◆ nCorr()

Foam::label nCorr ( ) const
inline

Maximum number of correctors.

Definition at line 28 of file pimpleLoopI.H.

References pimpleLoop::nCorr_.

◆ anyIter()

bool anyIter ( ) const
inline

Flag to indicate any iteration.

Definition at line 34 of file pimpleLoopI.H.

◆ firstIter()

bool firstIter ( ) const
inline

Flag to indicate the first iteration.

Definition at line 40 of file pimpleLoopI.H.

Referenced by pimpleControl::firstPimpleIter().

Here is the caller graph for this function:

◆ finalIter()

bool finalIter ( ) const
inline

Flag to indicate the last iteration.

Definition at line 46 of file pimpleLoopI.H.

Referenced by pimpleControl::finalPimpleIter().

Here is the caller graph for this function:

◆ loop()

bool loop ( correctorConvergenceControl &  convergence)

Pimple loop.

Definition at line 66 of file pimpleLoop.C.

References correctorConvergenceControl::corrCriteriaSatisfied(), Foam::endl(), correctorConvergenceControl::hasCorrResidualControls(), Foam::Info, Foam::nl, Foam::read(), correctorConvergenceControl::resetCorrSolveIndex(), and correctorConvergenceControl::updateCorrSolveIndex().

Referenced by pimpleMultiRegionControl::loop(), and pimpleSingleRegionControl::loop().

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

Member Data Documentation

◆ control_

const solutionControl& control_
protected

Reference to the solution control.

Definition at line 58 of file pimpleLoop.H.

Referenced by pimpleLoop::read().

◆ nCorr_

label nCorr_
protected

Maximum number of correctors.

Definition at line 61 of file pimpleLoop.H.

Referenced by pimpleLoop::nCorr(), pimpleMultiRegionControl::pimpleMultiRegionControl(), pimpleSingleRegionControl::pimpleSingleRegionControl(), and pimpleLoop::read().

◆ corr_

label corr_
protected

Current corrector.

Definition at line 64 of file pimpleLoop.H.

◆ converged_

bool converged_
protected

Flag to indicate convergence of the pimple loop.

Definition at line 67 of file pimpleLoop.H.

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