ArmijoConditions Class Reference

Class satisfying the Armijo line search conditions. More...

Inheritance diagram for ArmijoConditions:

Collaboration diagram for ArmijoConditions:

Public Member Functions
	TypeName ("ArmijoConditions")
	declareRunTimeSelectionTable (autoPtr, ArmijoConditions, dictionary,(const dictionary &dict, const Time &time),(dict))
	ArmijoConditions (const dictionary &dict, const Time &time)
virtual	~ArmijoConditions ()=default
virtual bool	converged ()
virtual void	updateStep ()
Public Member Functions inherited from lineSearch
	TypeName ("lineSearch")
	declareRunTimeSelectionTable (autoPtr, lineSearch, dictionary,(const dictionary &dict, const Time &time),(dict, time))
	lineSearch (const dictionary &dict, const Time &time)
virtual	~lineSearch ()=default
virtual void	setDeriv (const scalar deriv)
void	setDirection (const scalarField &direction)
void	setNewMeritValue (const scalar value)
void	setOldMeritValue (const scalar value)
virtual void	reset ()
label	maxIters () const
scalar	step () const
virtual void	updateStep (const scalar newStep)
virtual lineSearch &	operator++ ()
virtual lineSearch &	operator++ (int)

Protected Attributes
scalar	c1_
Protected Attributes inherited from lineSearch
const dictionary	dict_
IOdictionary	lineSearchDict_
scalar	directionalDeriv_
scalarField	direction_
scalar	oldMeritValue_
scalar	newMeritValue_
scalar	prevMeritDeriv_
scalar	initialStep_
scalar	minStep_
scalar	step_
label	iter_
label	maxIters_
bool	extrapolateInitialStep_
autoPtr< stepUpdate >	stepUpdate_

Additional Inherited Members
Static Public Member Functions inherited from lineSearch
static autoPtr< lineSearch >	New (const dictionary &dict, const Time &time)
Protected Member Functions inherited from lineSearch
const dictionary &	coeffsDict ()

Detailed Description

Class satisfying the Armijo line search conditions.

Source files

• ArmijoConditions.H
• ArmijoConditions.C

Definition at line 48 of file ArmijoConditions.H.

Constructor & Destructor Documentation

ArmijoConditions()

ArmijoConditions	(	const dictionary &	dict,
		const Time &	time
	)

Definition at line 43 of file ArmijoConditions.C.

~ArmijoConditions()

virtual ~ArmijoConditions ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"ArmijoConditions"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		ArmijoConditions	,
		dictionary	,
		(const dictionary &dict, const Time &time)	,
		(dict)
	)

converged()

bool converged ( )

virtual

Implements lineSearch.

Definition at line 55 of file ArmijoConditions.C.

References ArmijoConditions::c1_, lineSearch::directionalDeriv_, Foam::endl(), Foam::Info, lineSearch::newMeritValue_, lineSearch::oldMeritValue_, and lineSearch::step_.

Here is the call graph for this function:

updateStep()

void updateStep ( )

virtual

Implements lineSearch.

Definition at line 65 of file ArmijoConditions.C.

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

Here is the call graph for this function:

Member Data Documentation

c1_

scalar c1_

protected

Definition at line 58 of file ArmijoConditions.H.

Referenced by ArmijoConditions::converged().

---

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

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