Convergence control class. Provides methods to check the convergence of the time loop against an absolute residual tolerance. More...

Inheritance diagram for convergenceControl:

[legend]

Collaboration diagram for convergenceControl:

[legend]

Classes
struct	convergenceData
	Convergence data structure. More...

struct	residualData
	Classes. More...

Public Member Functions
	TypeName ("convergenceControl")
	Run-time type information. More...

	convergenceControl (const solutionControl &control)
	Construct from a solution control. More...

	convergenceControl (const convergenceControl &)=delete
	Disallow default bitwise copy construction. More...

virtual	~convergenceControl ()
	Destructor. More...

virtual bool	hasResidualControls () const =0
	Return true if residual controls are present. More...

virtual convergenceData	criteriaSatisfied () const =0
	Return true if all convergence checks are satisfied. More...

bool	converged ()
	Flag to indicate whether convergence has been reached. More...

bool	endIfConverged (Time &time)
	End the run if convergence has been reached. More...

void	operator= (const convergenceControl &)=delete
	Disallow default bitwise assignment. More...

template<class ResidualData >
Foam::label	residualControlIndex (const word &fieldName, const List< ResidualData > &residualControl, const bool useRegEx)

Static Public Member Functions
static DynamicList< word >	getFieldNames (const fvMesh &mesh)
	Get the list of names of the fields. More...

static void	getInitialResiduals (const fvMesh &mesh, const word &fieldName, const label solvei, scalar &r0, scalar &r)
	Get the initial residuals for the first and the i-th solves in this. More...

template<class ResidualData >
static label	residualControlIndex (const word &fieldName, const List< ResidualData > &residualControl, const bool useRegEx=true)
	Return the index of the named field in residual control data, or -1. More...

template<class Type >
static void	getFieldTypeNames (const fvMesh &mesh, DynamicList< word > &fieldNames)
	Append the of names of the fields of this Type to the given list. More...

template<class Type >
static void	getInitialTypeResiduals (const fvMesh &mesh, const word &fieldName, const label solvei, scalar &r0, scalar &r)
	Get the initial residuals for the first and the i-th solves in this. More...

Protected Attributes
const solutionControl &	control_
	Reference to the solution control. More...

Detailed Description

Convergence control class. Provides methods to check the convergence of the time loop against an absolute residual tolerance.

Source files

Definition at line 51 of file convergenceControl.H.

Constructor & Destructor Documentation

◆ convergenceControl() [1/2]

convergenceControl ( const solutionControl & control )

Construct from a solution control.

Definition at line 75 of file convergenceControl.C.

◆ convergenceControl() [2/2]

convergenceControl ( const convergenceControl & )

delete

Disallow default bitwise copy construction.

◆ ~convergenceControl()

~convergenceControl ( )

virtual

Destructor.

Definition at line 83 of file convergenceControl.C.

Member Function Documentation

◆ getFieldNames()

Foam::DynamicList< Foam::word > getFieldNames ( const fvMesh & mesh )

static

Get the list of names of the fields.

for which residual data is available

Definition at line 39 of file convergenceControl.C.

References fieldNames.

Referenced by singleRegionCorrectorConvergenceControl::corrCriteriaSatisfied(), and singleRegionCorrectorConvergenceControl::updateCorrSolveIndex().

Here is the caller graph for this function:

◆ getInitialResiduals()

void getInitialResiduals	(	const fvMesh &	mesh,
		const word &	fieldName,
		const label	solvei,
		scalar &	r0,
		scalar &	r
	)

static

Get the initial residuals for the first and the i-th solves in this.

time-step

Definition at line 56 of file convergenceControl.C.

Referenced by singleRegionCorrectorConvergenceControl::corrCriteriaSatisfied().

Here is the caller graph for this function:

◆ residualControlIndex() [1/2]

static label residualControlIndex	(	const word &	fieldName,
		const List< ResidualData > &	residualControl,
		const bool	useRegEx = `true`
	)

static

Return the index of the named field in residual control data, or -1.

if not present

Referenced by singleRegionCorrectorConvergenceControl::corrCriteriaSatisfied(), singleRegionConvergenceControl::read(), and singleRegionCorrectorConvergenceControl::read().

Here is the caller graph for this function:

◆ getFieldTypeNames()

void getFieldTypeNames	(	const fvMesh &	mesh,
		DynamicList< word > &	fieldNames
	)

static

Append the of names of the fields of this Type to the given list.

Definition at line 55 of file convergenceControlTemplates.C.

References List< T >::append(), and fieldNames.

Here is the call graph for this function:

◆ getInitialTypeResiduals()

void getInitialTypeResiduals	(	const fvMesh &	mesh,
		const word &	fieldName,
		const label	solvei,
		scalar &	r0,
		scalar &	r
	)

static

Get the initial residuals for the first and the i-th solves in this.

time-step

Definition at line 66 of file convergenceControlTemplates.C.

References Foam::cmptMax(), and objectRegistry::foundObject().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "convergenceControl" )

Run-time type information.

◆ hasResidualControls()

virtual bool hasResidualControls ( ) const

pure virtual

Return true if residual controls are present.

Implemented in pimpleMultiRegionControl, and singleRegionConvergenceControl.

◆ criteriaSatisfied()

virtual convergenceData criteriaSatisfied ( ) const

pure virtual

Return true if all convergence checks are satisfied.

Implemented in pimpleMultiRegionControl, and singleRegionConvergenceControl.

◆ converged()

bool converged ( )

Flag to indicate whether convergence has been reached.

Definition at line 89 of file convergenceControl.C.

References convergenceControl::convergenceData::checked, Foam::endl(), Foam::Info, Foam::nl, and convergenceControl::convergenceData::satisfied.

Here is the call graph for this function:

◆ endIfConverged()

bool endIfConverged ( Time & time )

End the run if convergence has been reached.

Definition at line 109 of file convergenceControl.C.

References Time::noWriteNow, Time::setEndTime(), Time::stopAt(), Time::writeAndEnd(), and TimeState::writeTime().

Here is the call graph for this function:

◆ operator=()

void operator= ( const convergenceControl & )

delete

Disallow default bitwise assignment.

◆ residualControlIndex() [2/2]

Foam::label residualControlIndex	(	const word &	fieldName,
		const List< ResidualData > &	residualControl,
		const bool	useRegEx
	)

Definition at line 31 of file convergenceControlTemplates.C.

References forAll, string::match(), and Foam::name().

Here is the call graph for this function:

Member Data Documentation

◆ control_

const solutionControl& control_

protected

Reference to the solution control.

Definition at line 128 of file convergenceControl.H.

Referenced by singleRegionConvergenceControl::read().

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

src/finiteVolume/cfdTools/general/solutionControl/convergenceControl/convergenceControl/convergenceControl.H
src/finiteVolume/cfdTools/general/solutionControl/convergenceControl/convergenceControl/convergenceControl.C
src/finiteVolume/cfdTools/general/solutionControl/convergenceControl/convergenceControl/convergenceControlTemplates.C

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ convergenceControl() [1/2]

◆ convergenceControl() [2/2]

◆ ~convergenceControl()

Member Function Documentation

◆ getFieldNames()

◆ getInitialResiduals()

◆ residualControlIndex() [1/2]

◆ getFieldTypeNames()

◆ getInitialTypeResiduals()

◆ TypeName()

◆ hasResidualControls()

◆ criteriaSatisfied()

◆ converged()

◆ endIfConverged()

◆ operator=()

◆ residualControlIndex() [2/2]

Member Data Documentation

◆ control_