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:

Collaboration diagram for pimpleLoop:

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	nCorrPimple () const
	Maximum number of pimple correctors. More...
bool	firstPimpleIter () const
	Flag to indicate the first pimple iteration. More...
bool	finalPimpleIter () const
	Flag to indicate the last pimple 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	nCorrPimple_
	Maximum number of pimple correctors. More...
label	corrPimple_
	Current pimple 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

• pimpleLoop.H
• pimpleLoopI.H
• pimpleLoop.C

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 pimpleMultiRegionControl, and pimpleControl.

Definition at line 38 of file pimpleLoop.C.

Referenced by pimpleLoop::loop(), and pimpleControl::read().

Here is the caller graph for this function:

TypeName()

TypeName

(

"pimpleLoop"

)

Run-time type information.

nCorrPimple()

Foam::label nCorrPimple ( ) const

inline

Maximum number of pimple correctors.

Definition at line 28 of file pimpleLoopI.H.

References pimpleLoop::nCorrPimple_.

firstPimpleIter()

bool firstPimpleIter ( ) const

inline

Flag to indicate the first pimple iteration.

Definition at line 34 of file pimpleLoopI.H.

References pimpleLoop::corrPimple_.

Referenced by pimpleLoop::firstIter(), and pimpleLoop::loop().

Here is the caller graph for this function:

finalPimpleIter()

bool finalPimpleIter ( ) const

inline

Flag to indicate the last pimple iteration.

Definition at line 40 of file pimpleLoopI.H.

References pimpleLoop::corrPimple_, and pimpleLoop::nCorrPimple_.

Referenced by pimpleLoop::finalIter().

Here is the caller graph for this function:

firstIter()

bool firstIter ( ) const

inline

Flag to indicate the first iteration.

Definition at line 46 of file pimpleLoopI.H.

References pimpleLoop::firstPimpleIter().

Here is the call graph for this function:

finalIter()

bool finalIter ( ) const

inline

Flag to indicate the last iteration.

Definition at line 52 of file pimpleLoopI.H.

References pimpleLoop::converged_, and pimpleLoop::finalPimpleIter().

Referenced by pimpleControl::loop(), pimpleMultiRegionControl::pimpleTurbCorr(), and pimpleControl::turbCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

loop()

bool loop

(

correctorConvergenceControl &

convergence

)

Pimple loop.

Definition at line 66 of file pimpleLoop.C.

References solutionControl::algorithmName(), solutionControl::algorithmSpace(), pimpleLoop::control_, pimpleLoop::converged_, correctorConvergenceControl::corrCriteriaSatisfied(), pimpleLoop::corrPimple_, Foam::endl(), pimpleLoop::firstPimpleIter(), correctorConvergenceControl::hasCorrResidualControls(), Foam::Info, pimpleLoop::nCorrPimple_, Foam::nl, pimpleLoop::read(), correctorConvergenceControl::resetCorrSolveIndex(), and correctorConvergenceControl::updateCorrSolveIndex().

Referenced by pimpleControl::loop(), and pimpleMultiRegionControl::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::loop().

nCorrPimple_

label nCorrPimple_

protected

Maximum number of pimple correctors.

Definition at line 61 of file pimpleLoop.H.

Referenced by pimpleLoop::finalPimpleIter(), pimpleLoop::loop(), pimpleLoop::nCorrPimple(), pimpleControl::pimpleControl(), and pimpleControl::read().

corrPimple_

label corrPimple_

protected

Current pimple corrector.

Definition at line 64 of file pimpleLoop.H.

Referenced by pimpleLoop::finalPimpleIter(), pimpleLoop::firstPimpleIter(), and pimpleLoop::loop().

converged_

bool converged_

protected

Flag to indicate convergence of the pimple loop.

Definition at line 67 of file pimpleLoop.H.

Referenced by pimpleLoop::finalIter(), and pimpleLoop::loop().

---

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

• src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleLoop/pimpleLoop.H
• src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleLoop/pimpleLoop.C
• src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleLoop/pimpleLoopI.H