quadratic Class Reference

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

Inheritance diagram for quadratic:
[legend]
Collaboration diagram for quadratic:
[legend]

Public Member Functions

 TypeName ("quadratic")
 Runtime type information. More...
 
 quadratic (const dictionary &dict)
 Construct from components. More...
 
virtual ~quadratic ()=default
 Destructor. More...
 
virtual void updateStep (scalar &step)
 Update step in given direction. 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...
 
- Public Member Functions inherited from stepUpdate
 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...
 

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< stepUpdateNew (const dictionary &dict)
 Return a reference to the selected turbulence model. More...
 
- Protected Member Functions inherited from stepUpdate
const dictionarycoeffsDict ()
 Optional coeffs dict. More...
 

Detailed Description

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

Source files

Definition at line 54 of file quadratic.H.

Constructor & Destructor Documentation

◆ quadratic()

quadratic ( const dictionary dict)

Construct from components.

Definition at line 49 of file quadratic.C.

◆ ~quadratic()

virtual ~quadratic ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "quadratic"  )

Runtime type information.

◆ updateStep()

void updateStep ( scalar &  step)
virtual

Update step in given direction.

Implements stepUpdate.

Definition at line 61 of file quadratic.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ setDeriv()

void setDeriv ( const scalar  deriv)
virtual

Set objective derivative.

Reimplemented from stepUpdate.

Definition at line 83 of file quadratic.C.

◆ setNewMeritValue()

void setNewMeritValue ( const scalar  value)
virtual

Set new merit value.

Reimplemented from stepUpdate.

Definition at line 89 of file quadratic.C.

◆ setOldMeritValue()

void setOldMeritValue ( const scalar  value)
virtual

Set old merit value.

Reimplemented from stepUpdate.

Definition at line 95 of file quadratic.C.

Member Data Documentation

◆ minRatio_

scalar minRatio_
protected

Definition at line 62 of file quadratic.H.

◆ firstMeritValue_

scalar firstMeritValue_
protected

Definition at line 63 of file quadratic.H.

◆ secondMeritValue_

scalar secondMeritValue_
protected

Definition at line 64 of file quadratic.H.

◆ meritDerivative_

scalar meritDerivative_
protected

Definition at line 65 of file quadratic.H.


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