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

Single-region-specific derivation of the corrector convergence control class. More...

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

Public Member Functions

 TypeName ("singleRegionCorrectorConvergenceControl")
 Run-time type information. More...
 
 singleRegionCorrectorConvergenceControl (const singleRegionSolutionControl &control, const word &loopName)
 Construct from a solution control and the loop name. More...
 
virtual ~singleRegionCorrectorConvergenceControl ()
 Destructor. More...
 
bool readCorrResidualControls ()
 Read residual controls. More...
 
void printCorrResidualControls (const label n) const
 Print the residual controls. More...
 
virtual bool hasCorrResidualControls () const
 Return true if corrector residual controls are present. More...
 
virtual bool corrCriteriaSatisfied () const
 Return true if all correction convergence checks are satisfied. More...
 
virtual void resetCorrSolveIndex ()
 Reset the solve index in the correction residual control data. More...
 
virtual void updateCorrSolveIndex ()
 Update the solve index in the correction residual control data. More...
 
- Public Member Functions inherited from correctorConvergenceControl
 TypeName ("correctorConvergenceControl")
 Run-time type information. More...
 
 correctorConvergenceControl (const solutionControl &control, const word &loopName)
 Construct from a solution control and the loop name. More...
 
virtual ~correctorConvergenceControl ()
 Destructor. More...
 

Protected Attributes

const fvMesh & mesh_
 Reference to the mesh. More...
 
List< corrResidualData > corrResidualControl_
 List of residual data per field. More...
 
HashTable< label > solveIndex_
 The index of the solution at the start of the corrector loop, for. More...
 
- Protected Attributes inherited from correctorConvergenceControl
const solutionControl & control_
 Reference to the solution control. More...
 
const word loopName_
 Name of the corrector loop. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from correctorConvergenceControl
static void getNSolves (const fvMesh &mesh, const word &fieldName, label &n)
 Get the number of solves that have happened for this variable in. More...
 
template<class Type >
static void getNTypeSolves (const fvMesh &mesh, const word &fieldName, label &n)
 Get the number of solves that have happened for this variable in. More...
 

Detailed Description

Single-region-specific derivation of the corrector convergence control class.

Source files

Definition at line 50 of file singleRegionCorrectorConvergenceControl.H.

Constructor & Destructor Documentation

◆ singleRegionCorrectorConvergenceControl()

singleRegionCorrectorConvergenceControl ( const singleRegionSolutionControl &  control,
const word &  loopName 
)

Construct from a solution control and the loop name.

Definition at line 42 of file singleRegionCorrectorConvergenceControl.C.

References singleRegionCorrectorConvergenceControl::~singleRegionCorrectorConvergenceControl().

Here is the call graph for this function:

◆ ~singleRegionCorrectorConvergenceControl()

~singleRegionCorrectorConvergenceControl ( )
virtual

Destructor.

Definition at line 56 of file singleRegionCorrectorConvergenceControl.C.

Referenced by singleRegionCorrectorConvergenceControl::singleRegionCorrectorConvergenceControl().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "singleRegionCorrectorConvergenceControl"  )

Run-time type information.

◆ readCorrResidualControls()

bool readCorrResidualControls ( )

Read residual controls.

Definition at line 62 of file singleRegionCorrectorConvergenceControl.C.

References correctorConvergenceControl::corrResidualData::absTol, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, forAllConstIter(), Foam::Info, dictionary::lookup(), correctorConvergenceControl::corrResidualData::name, Foam::nl, singleRegionCorrectorConvergenceControl::printCorrResidualControls(), Foam::readScalar(), correctorConvergenceControl::corrResidualData::relTol, and convergenceControl::residualControlIndex().

Here is the call graph for this function:

◆ printCorrResidualControls()

void printCorrResidualControls ( const label  n) const

Print the residual controls.

Definition at line 129 of file singleRegionCorrectorConvergenceControl.C.

References Foam::endl(), forAll, singleRegionCorrectorConvergenceControl::hasCorrResidualControls(), Foam::Info, and Foam::nl.

Referenced by pimpleControl::pimpleControl(), and singleRegionCorrectorConvergenceControl::readCorrResidualControls().

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

◆ hasCorrResidualControls()

bool hasCorrResidualControls ( ) const
virtual

Return true if corrector residual controls are present.

Implements correctorConvergenceControl.

Definition at line 154 of file singleRegionCorrectorConvergenceControl.C.

References singleRegionCorrectorConvergenceControl::corrCriteriaSatisfied().

Referenced by singleRegionCorrectorConvergenceControl::printCorrResidualControls().

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

◆ corrCriteriaSatisfied()

bool corrCriteriaSatisfied ( ) const
virtual

Return true if all correction convergence checks are satisfied.

Implements correctorConvergenceControl.

Definition at line 161 of file singleRegionCorrectorConvergenceControl.C.

References Foam::endl(), fieldNames, forAll, convergenceControl::getFieldNames(), convergenceControl::getInitialResiduals(), Foam::Info, convergenceControl::residualControlIndex(), and Foam::ROOTVSMALL.

Referenced by singleRegionCorrectorConvergenceControl::hasCorrResidualControls().

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

◆ resetCorrSolveIndex()

void resetCorrSolveIndex ( )
virtual

Reset the solve index in the correction residual control data.

Implements correctorConvergenceControl.

Definition at line 225 of file singleRegionCorrectorConvergenceControl.C.

◆ updateCorrSolveIndex()

void updateCorrSolveIndex ( )
virtual

Update the solve index in the correction residual control data.

Implements correctorConvergenceControl.

Definition at line 231 of file singleRegionCorrectorConvergenceControl.C.

References fieldNames, forAll, and convergenceControl::getFieldNames().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 59 of file singleRegionCorrectorConvergenceControl.H.

◆ corrResidualControl_

List<corrResidualData> corrResidualControl_
protected

List of residual data per field.

Definition at line 62 of file singleRegionCorrectorConvergenceControl.H.

◆ solveIndex_

HashTable<label> solveIndex_
protected

The index of the solution at the start of the corrector loop, for.

each field. If the field name is not in the table then the index is assumed to be zero; i.e, the first solution.

Definition at line 67 of file singleRegionCorrectorConvergenceControl.H.

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