stepUpdate Class Reference

Abstract base class for step update methods used in line search. More...

Inheritance diagram for stepUpdate:

Collaboration diagram for stepUpdate:

Public Member Functions
	TypeName ("stepUpdate")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, stepUpdate, dictionary,(const dictionary &dict),(dict))
	stepUpdate (const dictionary &dict)
	Construct from components. More...
virtual	~stepUpdate ()=default
	Destructor. More...
virtual void	updateStep (scalar &step)=0
	Update the line search step. More...
virtual void	setDeriv (const scalar deriv)
	Set objective derivative. More...
virtual void	setNewMeritValue (const scalar value)
	Set new merit value. More...
virtual void	setOldMeritValue (const scalar value)
	Set old merit value. More...

Static Public Member Functions
static autoPtr< stepUpdate >	New (const dictionary &dict)
	Return a reference to the selected turbulence model. More...

Protected Member Functions
const dictionary &	coeffsDict ()
	Optional coeffs dict. More...

Protected Attributes
const dictionary	dict_

Detailed Description

Abstract base class for step update methods used in line search.

Source files

• stepUpdate.H
• stepUpdate.C

Definition at line 54 of file stepUpdate.H.

Constructor & Destructor Documentation

stepUpdate()

stepUpdate

(

const dictionary &

dict

)

Construct from components.

Definition at line 51 of file stepUpdate.C.

~stepUpdate()

virtual ~stepUpdate ( )

virtualdefault

Destructor.

Member Function Documentation

coeffsDict()

const Foam::dictionary & coeffsDict ( )

protected

Optional coeffs dict.

Definition at line 43 of file stepUpdate.C.

References stepUpdate::dict_, dictionary::optionalSubDict(), and Foam::type().

Here is the call graph for this function:

TypeName()

TypeName

(

"stepUpdate"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		stepUpdate	,
		dictionary	,
		(const dictionary &dict)	,
		(dict)
	)

New()

Foam::autoPtr< Foam::stepUpdate > New ( const dictionary &  dict )

static

Return a reference to the selected turbulence model.

Definition at line 59 of file stepUpdate.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::getOrDefault(), Foam::Info, and Foam::type().

Here is the call graph for this function:

updateStep()

virtual void updateStep ( scalar &  step )

pure virtual

Update the line search step.

Implemented in bisection, and quadratic.

setDeriv()

void setDeriv ( const scalar  deriv )

virtual

Set objective derivative.

Reimplemented in quadratic.

Definition at line 85 of file stepUpdate.C.

setNewMeritValue()

void setNewMeritValue ( const scalar  value )

virtual

Set new merit value.

Reimplemented in quadratic.

Definition at line 91 of file stepUpdate.C.

setOldMeritValue()

void setOldMeritValue ( const scalar  value )

virtual

Set old merit value.

Reimplemented in quadratic.

Definition at line 97 of file stepUpdate.C.

Member Data Documentation

dict_

const dictionary dict_

protected

Definition at line 60 of file stepUpdate.H.

Referenced by stepUpdate::coeffsDict().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/lineSearch/stepUpdate/stepUpdate/stepUpdate.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/lineSearch/stepUpdate/stepUpdate/stepUpdate.C