bisection Class Reference

Reduces step by a given ratio. More...

Inheritance diagram for bisection:
Collaboration diagram for bisection:

Public Member Functions

 TypeName ("bisection")
 Runtime type information. More...
 bisection (const dictionary &dict)
 Construct from components. More...
virtual ~bisection ()=default
 Destructor. More...
virtual void updateStep (scalar &step)
 Update the line search step. 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...
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...

Protected Attributes

scalar ratio_
- 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

Reduces step by a given ratio.

Source files

Definition at line 53 of file bisection.H.

Constructor & Destructor Documentation

◆ bisection()

bisection ( const dictionary dict)

Construct from components.

Definition at line 49 of file bisection.C.

◆ ~bisection()

virtual ~bisection ( )


Member Function Documentation

◆ TypeName()

TypeName ( "bisection"  )

Runtime type information.

◆ updateStep()

void updateStep ( scalar &  step)

Update the line search step.

Implements stepUpdate.

Definition at line 58 of file bisection.C.

Member Data Documentation

◆ ratio_

scalar ratio_

Definition at line 61 of file bisection.H.

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