bisection Class Reference

Reduces step by a given ratio. More...

#include <bisection.H>

Inheritance diagram for bisection:

Collaboration diagram for bisection:

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

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

Reduces step by a given ratio.

Source files

• bisection.H
• bisection.C

Definition at line 49 of file bisection.H.

Constructor & Destructor Documentation

bisection()

bisection

(

const dictionary &

dict

)

Construct from components.

Definition at line 42 of file bisection.C.

References stepUpdate::coeffsDict(), dict, and ratio_.

Here is the call graph for this function:

~bisection()

virtual ~bisection ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"bisection"

)

Runtime type information.

References dict.

updateStep()

void updateStep ( scalar & step )

virtual

Update the line search step.

Implements stepUpdate.

Definition at line 51 of file bisection.C.

References ratio_.

Member Data Documentation

ratio_

scalar ratio_

protected

Definition at line 57 of file bisection.H.

Referenced by bisection(), and updateStep().

---

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

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