steepestDescent Class Reference

Update design variables using steepest descent. More...

Inheritance diagram for steepestDescent:

Collaboration diagram for steepestDescent:

Public Member Functions
	TypeName ("steepestDescent")
	steepestDescent (const fvMesh &mesh, const dictionary &dict)
virtual	~steepestDescent ()=default
void	computeCorrection ()
Public Member Functions inherited from updateMethod
	TypeName ("updateMethod")
	declareRunTimeSelectionTable (autoPtr, updateMethod, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
	updateMethod (const fvMesh &mesh, const dictionary &dict)
virtual	~updateMethod ()=default
void	setObjectiveDeriv (const scalarField &derivs)
void	setConstraintDeriv (const PtrList< scalarField > &derivs)
void	setObjectiveValue (const scalar value)
void	setConstraintValues (const scalarField &values)
void	setStep (const scalar eta)
void	setGlobalSum (const bool useGlobalSum)
scalarField &	returnCorrection ()
void	writeCorrection ()
virtual scalar	computeMeritFunction ()
virtual scalar	meritFunctionDirectionalDerivative ()
bool &	initialEtaSet ()
virtual void	updateOldCorrection (const scalarField &oldCorrection)
virtual void	write ()

Additional Inherited Members
Static Public Member Functions inherited from updateMethod
static autoPtr< updateMethod >	New (const fvMesh &mesh, const dictionary &dict)
Protected Member Functions inherited from updateMethod
const scalarField	leftMult (const scalarField &, const SquareMatrix< scalar > &)
const scalarField	rightMult (const SquareMatrix< scalar > &, const scalarField &)
SquareMatrix< scalar >	outerProd (const scalarField &, const scalarField &)
SquareMatrix< scalar >	inv (SquareMatrix< scalar > A)
scalar	globalSum (const scalarField &field)
scalar	globalSum (tmp< scalarField > &tfield)
dictionary	coeffsDict ()
Protected Attributes inherited from updateMethod
const fvMesh &	mesh_
const dictionary	dict_
IOdictionary	optMethodIODict_
scalarField	objectiveDerivatives_
PtrList< scalarField >	constraintDerivatives_
scalar	objectiveValue_
scalarField	cValues_
scalarField	correction_
scalarField	cumulativeCorrection_
scalar	eta_
bool	initialEtaSet_
word	correctionFolder_
bool	globalSum_

Detailed Description

Update design variables using steepest descent.

Source files

• steepestDescent.H
• steepestDescent.C

Definition at line 49 of file steepestDescent.H.

Constructor & Destructor Documentation

steepestDescent()

steepestDescent	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

Definition at line 43 of file steepestDescent.C.

~steepestDescent()

virtual ~steepestDescent ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"steepestDescent"

)

computeCorrection()

void computeCorrection ( )

virtual

Implements updateMethod.

Definition at line 54 of file steepestDescent.C.

References updateMethod::correction_, updateMethod::eta_, and updateMethod::objectiveDerivatives_.

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/updateMethod/steepestDescent/steepestDescent.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/updateMethod/steepestDescent/steepestDescent.C