solverControl Class Reference

Base class for solver control classes. More...

Inheritance diagram for solverControl:

Collaboration diagram for solverControl:

Public Member Functions
	TypeName ("solverControl")
	solverControl (const solver &solver)
virtual	~solverControl ()=default
virtual const dictionary	solverDict () const
virtual const dictionary	solutionDict () const
bool	printMaxMags () const
bool	storeInitValues () const
label	iter () const
label &	averageIter ()
label	averageIter () const
label	averageStartIter () const
bool	doAverageIter () const
bool	useAveragedFields () const
bool	average () const

Protected Member Functions
virtual bool	read ()

Protected Attributes
const solver &	solver_
bool	printMaxMags_
label	iter_
label	averageIter_
label	averageStartIter_
bool	storeInitValues_
bool	average_

Detailed Description

Base class for solver control classes.

Definition at line 45 of file solverControl.H.

Constructor & Destructor Documentation

solverControl()

solverControl

(

const solver &

solver

)

Definition at line 49 of file solverControl.C.

References solverControl::read().

Here is the call graph for this function:

~solverControl()

virtual ~solverControl ( )

virtualdefault

Member Function Documentation

read()

bool read ( )

protectedvirtual

Reimplemented in SIMPLEControl, SIMPLEControlOpt, and SIMPLEControlSingleRun.

Definition at line 34 of file solverControl.C.

References solverControl::averageStartIter_, dictionary::getOrDefault(), solverControl::printMaxMags_, solverControl::solutionDict(), and dictionary::subOrEmptyDict().

Referenced by SIMPLEControl::read(), and solverControl::solverControl().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"solverControl"

)

solverDict()

const Foam::dictionary solverDict ( ) const

inlinevirtual

Definition at line 26 of file solverControlI.H.

References solver::dict(), and solverControl::solver_.

Here is the call graph for this function:

solutionDict()

const Foam::dictionary solutionDict ( ) const

inlinevirtual

Definition at line 32 of file solverControlI.H.

References dictionary::subDict().

Referenced by SIMPLEControl::dict(), and solverControl::read().

Here is the call graph for this function:

Here is the caller graph for this function:

printMaxMags()

bool printMaxMags ( ) const

inline

Definition at line 38 of file solverControlI.H.

Referenced by adjointSpalartAllmaras::correct().

Here is the caller graph for this function:

storeInitValues()

bool storeInitValues ( ) const

inline

Definition at line 44 of file solverControlI.H.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::restoreInitValues(), incompressibleVars::restoreInitValues(), incompressibleVars::setInitFields(), and incompressibleVars::storeInitValues().

Here is the caller graph for this function:

iter()

Foam::label iter ( ) const

inline

Definition at line 50 of file solverControlI.H.

averageIter() [1/2]

Foam::label averageIter ( )

inline

Definition at line 56 of file solverControlI.H.

Referenced by objective::accumulateJMean(), incompressibleAdjointVars::computeMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::computeMeanFields(), adjointRASModel::computeMeanFields(), incompressibleAdjointVars::resetMeanFields(), and incompressibleVars::resetMeanFields().

Here is the caller graph for this function:

averageIter() [2/2]

label averageIter ( ) const

inline

averageStartIter()

Foam::label averageStartIter ( ) const

inline

Definition at line 68 of file solverControlI.H.

doAverageIter()

bool doAverageIter ( ) const

inline

Definition at line 74 of file solverControlI.H.

Referenced by objective::accumulateJMean(), incompressibleAdjointVars::computeMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::computeMeanFields(), and adjointRASModel::computeMeanFields().

Here is the caller graph for this function:

useAveragedFields()

bool useAveragedFields ( ) const

inline

Definition at line 87 of file solverControlI.H.

Referenced by adjointRASModel::getAdjointTMVariable1(), adjointRASModel::getAdjointTMVariable2(), RASModelVariables::nutRef(), incompressibleVars::p(), incompressibleAdjointMeanFlowVars::pa(), incompressibleVars::phi(), incompressibleAdjointMeanFlowVars::phia(), RASModelVariables::TMVar1(), RASModelVariables::TMVar2(), incompressibleVars::U(), and incompressibleAdjointMeanFlowVars::Ua().

Here is the caller graph for this function:

average()

bool average ( ) const

inline

Definition at line 100 of file solverControlI.H.

Referenced by RASModelVariables::allocateMeanFields(), incompressibleAdjointMeanFlowVars::computeMeanFields(), incompressibleVars::correctNonTurbulentBoundaryConditions(), incompressibleAdjointVars::resetMeanFields(), RASModelVariables::resetMeanFields(), incompressibleVars::resetMeanFields(), adjointRASModel::resetMeanFields(), incompressibleAdjointMeanFlowVars::setMeanFields(), incompressibleVars::setMeanFields(), and adjointRASModel::setMeanFields().

Here is the caller graph for this function:

Member Data Documentation

solver_

const solver& solver_

protected

Definition at line 52 of file solverControl.H.

Referenced by SIMPLEControl::read(), and solverControl::solverDict().

printMaxMags_

bool printMaxMags_

protected

Definition at line 58 of file solverControl.H.

Referenced by solverControl::read().

iter_

label iter_

protected

Definition at line 64 of file solverControl.H.

averageIter_

label averageIter_

protected

Definition at line 67 of file solverControl.H.

averageStartIter_

label averageStartIter_

protected

Definition at line 70 of file solverControl.H.

Referenced by solverControl::read(), and SIMPLEControl::read().

storeInitValues_

bool storeInitValues_

protected

Definition at line 76 of file solverControl.H.

average_

bool average_

protected

Definition at line 79 of file solverControl.H.

Referenced by SIMPLEControl::read().

---

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

• src/optimisation/adjointOptimisation/adjoint/solvers/solverControl/solverControl/solverControl.H
• src/optimisation/adjointOptimisation/adjoint/solvers/solverControl/solverControl/solverControl.C
• src/optimisation/adjointOptimisation/adjoint/solvers/solverControl/solverControl/solverControlI.H