quadratic Class Reference

Fits a quadratic polynomial of the merit function as a function of step and finds the "optimal" value. More...

#include <quadratic.H>

Inheritance diagram for quadratic:

Collaboration diagram for quadratic:

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

Protected Attributes
scalar	minRatio_
scalar	firstMeritValue_
scalar	secondMeritValue_
scalar	meritDerivative_
Protected Attributes inherited from stepUpdate
const dictionary	dict_

Additional Inherited Members
Static Public Member Functions inherited from stepUpdate
static autoPtr< stepUpdate >	New (const dictionary &dict)
	Return a reference to the selected turbulence model.
Protected Member Functions inherited from stepUpdate
const dictionary &	coeffsDict ()
	Optional coeffs dict.

Detailed Description

Fits a quadratic polynomial of the merit function as a function of step and finds the "optimal" value.

Source files

• quadratic.H
• quadratic.C

Definition at line 50 of file quadratic.H.

Constructor & Destructor Documentation

quadratic()

quadratic

(

const dictionary &

dict

)

Construct from components.

Definition at line 42 of file quadratic.C.

References stepUpdate::coeffsDict(), dict, firstMeritValue_, meritDerivative_, minRatio_, secondMeritValue_, and Foam::Zero.

Here is the call graph for this function:

~quadratic()

virtual ~quadratic ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"quadratic"

)

Runtime type information.

References dict.

updateStep()

void updateStep ( scalar & step )

virtual

Update step in given direction.

Implements stepUpdate.

Definition at line 54 of file quadratic.C.

References Foam::endl(), firstMeritValue_, Foam::Info, meritDerivative_, minRatio_, and secondMeritValue_.

Here is the call graph for this function:

setDeriv()

void setDeriv ( const scalar deriv )

virtual

Set objective derivative.

Reimplemented from stepUpdate.

Definition at line 76 of file quadratic.C.

References meritDerivative_.

setNewMeritValue()

void setNewMeritValue ( const scalar value )

virtual

Set new merit value.

Reimplemented from stepUpdate.

Definition at line 82 of file quadratic.C.

References secondMeritValue_.

setOldMeritValue()

void setOldMeritValue ( const scalar value )

virtual

Set old merit value.

Reimplemented from stepUpdate.

Definition at line 88 of file quadratic.C.

References firstMeritValue_.

Member Data Documentation

minRatio_

scalar minRatio_

protected

Definition at line 58 of file quadratic.H.

Referenced by quadratic(), and updateStep().

firstMeritValue_

scalar firstMeritValue_

protected

Definition at line 59 of file quadratic.H.

Referenced by quadratic(), setOldMeritValue(), and updateStep().

secondMeritValue_

scalar secondMeritValue_

protected

Definition at line 60 of file quadratic.H.

Referenced by quadratic(), setNewMeritValue(), and updateStep().

meritDerivative_

scalar meritDerivative_

protected

Definition at line 61 of file quadratic.H.

Referenced by quadratic(), setDeriv(), and updateStep().

---

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

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