constrainedOptimisationMethod Class Reference

Abstract base class for optimisation methods supporting constraints. Does not add functionality to updateMethod but act as a means to categorize constrained optimisation methods for performing sanity checks. More...

Inheritance diagram for constrainedOptimisationMethod:

Collaboration diagram for constrainedOptimisationMethod:

Public Member Functions
	TypeName ("constrainedOptimisationMethod")
	declareRunTimeSelectionTable (autoPtr, constrainedOptimisationMethod, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
	constrainedOptimisationMethod (const fvMesh &mesh, const dictionary &dict)
virtual	~constrainedOptimisationMethod ()=default
virtual void	computeCorrection ()=0
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

Abstract base class for optimisation methods supporting constraints. Does not add functionality to updateMethod but act as a means to categorize constrained optimisation methods for performing sanity checks.

Source files

• constrainedOptimisationMethod.H
• constrainedOptimisationMethod.C

Definition at line 51 of file constrainedOptimisationMethod.H.

Constructor & Destructor Documentation

constrainedOptimisationMethod()

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

Definition at line 37 of file constrainedOptimisationMethod.C.

~constrainedOptimisationMethod()

virtual ~constrainedOptimisationMethod ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"constrainedOptimisationMethod"

)

declareRunTimeSelectionTable()

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

computeCorrection()

virtual void computeCorrection ( )

pure virtual

Implements updateMethod.

Implemented in SQP, and constraintProjection.

---

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

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