Inheritance diagram for DAObjFuncVariableVolSum:

Collaboration diagram for DAObjFuncVariableVolSum:

Public Member Functions
	TypeName ("variableVolSum")

	DAObjFuncVariableVolSum (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)

virtual	~DAObjFuncVariableVolSum ()

virtual void	calcObjFunc (const labelList &objFuncFaceSources, const labelList &objFuncCellSources, scalarList &objFuncFaceValues, scalarList &objFuncCellValues, scalar &objFuncValue)
	calculate the value of objective function More...

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

	declareRunTimeSelectionTable (autoPtr, DAObjFunc, dictionary,(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict),(mesh, daOption, daModel, daIndex, daResidual, objFuncName, objFuncPart, objFuncDict))

	DAObjFunc (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)

virtual	~DAObjFunc ()

void	clear ()
	clear up members More...

void	calcObjFuncSources (labelList &faceSources, labelList &cellSources)
	calculate DAObjFunc::objFuncFaceSources_ and DAObjFunc::objFuncCellSources_ More...

scalar	getObjFuncValue ()
	calculate the value of objective function More...

scalar	masterFunction (const dictionary &options, const Vec xvVec, const Vec wVec)
	the master function to compute objective function given the state and point vectors More...

word	getObjFuncName ()
	return the name of objective function More...

word	getObjFuncPart ()
	return the part of objective function More...

word	getObjFuncType ()
	return the part of objective function More...

const labelList &	getObjFuncFaceSources () const
	return DAObjFunc::objFuncFaceSources_ More...

const labelList &	getObjFuncCellSources () const
	return DAObjFunc::objFuncCellSources_ More...

const scalarList &	getObjFuncFaceValues () const
	return DAObjFunc::objFuncFaceValues_ More...

const scalarList &	getObjFuncCellValues () const
	return DAObjFunc::objFuncCellValues_ More...

const List< List< word > > &	getObjFuncConInfo () const
	return DAObjFunc::objFuncConInfo_ More...

Protected Attributes
word	varName_
	name of the variable More...

word	varType_
	type of the variable either vector or scalar More...

label	component_
	if vector which element? More...

label	isSquare_
	whether to take a square of the variable More...

label	divByTotalVol_
	whether to normalize the volume sum with the total volume More...

Protected Attributes inherited from DAObjFunc
const fvMesh &	mesh_
	fvMesh More...

const DAOption &	daOption_
	DAOption object. More...

const DAModel &	daModel_
	DAModel object. More...

const DAIndex &	daIndex_
	DAIndex object. More...

const DAResidual &	daResidual_
	DAResidual object. More...

word	objFuncName_
	the name of the objective function More...

word	objFuncPart_
	the part of the objective function More...

word	objFuncType_
	the type of the objective function More...

const dictionary &	objFuncDict_
	dictionary containing the information for the objective function More...

DAField	daField_
	DAField object. More...

labelList	objFuncFaceSources_
	a sorted list of all face sources for the objective function More...

labelList	objFuncCellSources_
	a sorted list of all cell sources for the objective function More...

scalarList	objFuncFaceValues_
	value of the obj function on the discrete faces More...

scalarList	objFuncCellValues_
	value of the obj function in the discrete cells More...

scalar	scale_
	scale of the objective function More...

scalar	objFuncValue_
	the value of the objective function More...

List< List< word > >	objFuncConInfo_
	the connectivity information for the objective function More...

Additional Inherited Members
Static Public Member Functions inherited from DAObjFunc
static autoPtr< DAObjFunc >	New (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)

Public Attributes inherited from DAObjFunc
scalar	expSumKS = 1.0
	expSumKS stores sum[exp(coeffKS*x_i)] for KS function which will be used to scale dFdW More...

label	calcRefCoeffs = 1
	whether to compute reference coefficients for special objFunc treatment such as totalPressureRatio More...

Detailed Description

Definition at line 26 of file DAObjFuncVariableVolSum.H.

Constructor & Destructor Documentation

◆ DAObjFuncVariableVolSum()

DAObjFuncVariableVolSum	(	const fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex,
		const DAResidual &	daResidual,
		const word	objFuncName,
		const word	objFuncPart,
		const dictionary &	objFuncDict
	)

Definition at line 19 of file DAObjFuncVariableVolSum.C.

References DAObjFuncVariableVolSum::component_, daIndex(), DAObjFuncVariableVolSum::divByTotalVol_, DAObjFuncVariableVolSum::isSquare_, DAObjFunc::objFuncConInfo_, DAObjFunc::objFuncDict_, DAObjFunc::objFuncType_, DAObjFunc::scale_, DAObjFuncVariableVolSum::varName_, and DAObjFuncVariableVolSum::varType_.

Here is the call graph for this function:

◆ ~DAObjFuncVariableVolSum()

virtual ~DAObjFuncVariableVolSum ( )

inlinevirtual

Definition at line 63 of file DAObjFuncVariableVolSum.H.

Member Function Documentation

◆ TypeName()

TypeName ( "variableVolSum" )

◆ calcObjFunc()

void calcObjFunc	(	const labelList &	objFuncFaceSources,
		const labelList &	objFuncCellSources,
		scalarList &	objFuncFaceValues,
		scalarList &	objFuncCellValues,
		scalar &	objFuncValue
	)

virtual

calculate the value of objective function

Implements DAObjFunc.

Definition at line 61 of file DAObjFuncVariableVolSum.C.

References DAObjFuncVariableVolSum::component_, DAObjFuncVariableVolSum::divByTotalVol_, forAll(), DAObjFuncVariableVolSum::isSquare_, DAObjFunc::mesh_, DAObjFunc::scale_, DAObjFuncVariableVolSum::varName_, and DAObjFuncVariableVolSum::varType_.

Here is the call graph for this function:

Member Data Documentation

◆ varName_

word varName_

protected

name of the variable

Definition at line 33 of file DAObjFuncVariableVolSum.H.

Referenced by DAObjFuncVariableVolSum::calcObjFunc(), and DAObjFuncVariableVolSum::DAObjFuncVariableVolSum().

◆ varType_

word varType_

protected

type of the variable either vector or scalar

Definition at line 36 of file DAObjFuncVariableVolSum.H.

Referenced by DAObjFuncVariableVolSum::calcObjFunc(), and DAObjFuncVariableVolSum::DAObjFuncVariableVolSum().

◆ component_

label component_

protected

if vector which element?

Definition at line 39 of file DAObjFuncVariableVolSum.H.

Referenced by DAObjFuncVariableVolSum::calcObjFunc(), and DAObjFuncVariableVolSum::DAObjFuncVariableVolSum().

◆ isSquare_

label isSquare_

protected

whether to take a square of the variable

Definition at line 42 of file DAObjFuncVariableVolSum.H.

Referenced by DAObjFuncVariableVolSum::calcObjFunc(), and DAObjFuncVariableVolSum::DAObjFuncVariableVolSum().

◆ divByTotalVol_

label divByTotalVol_

protected

whether to normalize the volume sum with the total volume

Definition at line 45 of file DAObjFuncVariableVolSum.H.

Referenced by DAObjFuncVariableVolSum::calcObjFunc(), and DAObjFuncVariableVolSum::DAObjFuncVariableVolSum().

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

dafoam/src/adjoint/DAObjFunc/DAObjFuncVariableVolSum.H
dafoam/src/adjoint/DAObjFunc/DAObjFuncVariableVolSum.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DAObjFuncVariableVolSum()

◆ ~DAObjFuncVariableVolSum()

Member Function Documentation

◆ TypeName()

◆ calcObjFunc()

Member Data Documentation

◆ varName_

◆ varType_

◆ component_

◆ isSquare_

◆ divByTotalVol_