Update design variables using steepest descent. More...

Inheritance diagram for steepestDescent:

Collaboration diagram for steepestDescent:

Public Member Functions
	TypeName ("steepestDescent")
	Runtime type information. More...

	steepestDescent (const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

virtual	~steepestDescent ()=default
	Destructor. More...

void	computeCorrection ()
	Return the correction of the design variables. More...

Public Member Functions inherited from updateMethod
	TypeName ("updateMethod")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, updateMethod, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))

	updateMethod (const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

virtual	~updateMethod ()=default
	Destructor. More...

void	setObjectiveDeriv (const scalarField &derivs)
	Set objective derivative. More...

void	setConstraintDeriv (const PtrList< scalarField > &derivs)
	Set constraints derivative. More...

void	setObjectiveValue (const scalar value)
	Set constraints derivative. More...

void	setConstraintValues (const scalarField &values)
	Set constraints derivative. More...

void	setStep (const scalar eta)
	Set step for optimisation methods. More...

void	setGlobalSum (const bool useGlobalSum)
	Set globalSum variable. More...

scalarField &	returnCorrection ()
	Return the correction of the design variables. More...

void	writeCorrection ()

virtual scalar	computeMeritFunction ()

virtual scalar	meritFunctionDirectionalDerivative ()

bool &	initialEtaSet ()
	Return whether initial eta was set. More...

virtual void	updateOldCorrection (const scalarField &oldCorrection)

virtual void	write ()
	Write useful quantities to files. More...

Additional Inherited Members
Static Public Member Functions inherited from updateMethod
static autoPtr< updateMethod >	New (const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected turbulence model. More...

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)
	Compute either global or local sum, based on globalSum flag. More...

scalar	globalSum (tmp< scalarField > &tfield)
	Compute either global or local sum, based on globalSum flag. More...

dictionary	coeffsDict ()
	Return optional dictionary with parameters specific to each method. More...

Protected Attributes inherited from updateMethod
const fvMesh &	mesh_

const dictionary	dict_

IOdictionary	optMethodIODict_
	Used to output values useful for continuation runs. More...

scalarField	objectiveDerivatives_
	Derivatives of the objective functions. More...

PtrList< scalarField >	constraintDerivatives_
	Derivatives of the constraints. More...

scalar	objectiveValue_
	Objective value. More...

scalarField	cValues_
	Constraint values. More...

scalarField	correction_
	Design variables correction. More...

scalarField	cumulativeCorrection_

scalar	eta_
	Step multiplying the correction. More...

bool	initialEtaSet_
	Is initially set? More...

word	correctionFolder_
	Folder storing the corrections to file. More...

bool	globalSum_
	Whether to use gSum or sum in the inner products. More...

Detailed Description

Update design variables using steepest descent.

Source files

Definition at line 53 of file steepestDescent.H.

Constructor & Destructor Documentation

◆ steepestDescent()

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

Construct from components.

Definition at line 50 of file steepestDescent.C.

◆ ~steepestDescent()

virtual ~steepestDescent ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "steepestDescent" )

Runtime type information.

◆ computeCorrection()

void computeCorrection ( )

virtual

Return the correction of the design variables.

Implements updateMethod.

Definition at line 61 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

Public Member Functions