Inheritance diagram for DAObjFunc:

[legend]

Collaboration diagram for DAObjFunc:

[legend]

Public Member Functions
	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...

virtual void	calcObjFunc (const labelList &objFuncFaceSources, const labelList &objFuncCellSources, scalarList &objFuncFaceValues, scalarList &objFuncCellValues, scalar &objFuncValue)=0
	calculate the value of objective function 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...

Static Public Member Functions
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
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...

Protected Attributes
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...

Detailed Description

Definition at line 33 of file DAObjFunc.H.

Constructor & Destructor Documentation

◆ DAObjFunc()

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
	)

Definition at line 22 of file DAObjFunc.C.

References DAObjFunc::calcObjFuncSources(), forAll(), DAObjFunc::objFuncCellSources_, DAObjFunc::objFuncCellValues_, DAObjFunc::objFuncFaceSources_, and DAObjFunc::objFuncFaceValues_.

Here is the call graph for this function:

◆ ~DAObjFunc()

virtual ~DAObjFunc ( )

inlinevirtual

Definition at line 150 of file DAObjFunc.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DAObjFunc" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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)
	)

◆ New()

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
	)

static

Definition at line 62 of file DAObjFunc.C.

References daIndex(), daModel(), daOption(), and mesh.

Referenced by DASolver::calcdFdACTAD(), DASolver::calcdFdBCAD(), DASolver::calcdFdFieldAD(), DASolver::calcdFdW(), DASolver::calcdFdWAD(), DASolver::calcdFdXvAD(), DAPartDerivdFdFFD::calcPartDerivMat(), DAPartDerivdFdAOA::calcPartDerivMat(), DAPartDerivdFdBC::calcPartDerivMat(), DAPartDerivdFdACTD::calcPartDerivMat(), DAPartDerivdFdW::calcPartDerivMat(), ColoringSolid::run(), ColoringCompressible::run(), ColoringIncompressible::run(), and DASolver::setDAObjFuncList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear ( )

inline

clear up members

Definition at line 155 of file DAObjFunc.H.

References DAObjFunc::objFuncCellSources_, DAObjFunc::objFuncCellValues_, DAObjFunc::objFuncConInfo_, DAObjFunc::objFuncFaceSources_, and DAObjFunc::objFuncFaceValues_.

◆ calcObjFuncSources()

void calcObjFuncSources	(	labelList &	faceSources,
		labelList &	cellSources
	)

calculate DAObjFunc::objFuncFaceSources_ and DAObjFunc::objFuncCellSources_

Definition at line 123 of file DAObjFunc.C.

References DAObjFunc::mesh_, and DAObjFunc::objFuncDict_.

Referenced by DAObjFunc::DAObjFunc().

Here is the caller graph for this function:

◆ calcObjFunc()

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

pure virtual

calculate the value of objective function

Implemented in DAObjFuncWallHeatFlux, DAObjFuncForce, DAObjFuncTotalPressureRatio, DAObjFuncTotalTemperatureRatio, DAObjFuncFieldInversion, DAObjFuncVariableVolSum, DAObjFuncPatchMean, DAObjFuncCenterOfPressure, DAObjFuncMassFlowRate, DAObjFuncPower, DAObjFuncTotalPressure, DAObjFuncMeshQualityKS, DAObjFuncMoment, DAObjFuncVonMisesStressKS, and DAObjFuncMass.

Referenced by DAObjFunc::getObjFuncValue().

Here is the caller graph for this function:

◆ getObjFuncValue()

scalar getObjFuncValue ( )

calculate the value of objective function

Definition at line 290 of file DAObjFunc.C.

References DAObjFunc::calcObjFunc(), DAObjFunc::objFuncCellSources_, DAObjFunc::objFuncCellValues_, DAObjFunc::objFuncFaceSources_, DAObjFunc::objFuncFaceValues_, and DAObjFunc::objFuncValue_.

Referenced by DASolver::getObjFuncValue(), DAObjFunc::masterFunction(), and DASolver::printAllObjFuncs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ masterFunction()

scalar masterFunction	(	const dictionary &	options,
		const Vec	xvVec,
		const Vec	wVec
	)

the master function to compute objective function given the state and point vectors

Definition at line 228 of file DAObjFunc.C.

References DAResidual::correctBoundaryConditions(), DAObjFunc::daField_, daModel(), DAObjFunc::daModel_, DAObjFunc::daResidual_, DAObjFunc::getObjFuncValue(), DAField::pointVec2OFMesh(), DAField::specialBCTreatment(), DAField::stateVec2OFField(), and DAResidual::updateIntermediateVariables().

Here is the call graph for this function:

◆ getObjFuncName()

word getObjFuncName ( )

inline

return the name of objective function

Definition at line 187 of file DAObjFunc.H.

References DAObjFunc::objFuncName_.

Referenced by DASolver::getObjFuncValue(), and DASolver::printAllObjFuncs().

Here is the caller graph for this function:

◆ getObjFuncPart()

word getObjFuncPart ( )

inline

return the part of objective function

Definition at line 193 of file DAObjFunc.H.

References DAObjFunc::objFuncPart_.

Referenced by DASolver::printAllObjFuncs().

Here is the caller graph for this function:

◆ getObjFuncType()

word getObjFuncType ( )

inline

return the part of objective function

Definition at line 199 of file DAObjFunc.H.

References DAObjFunc::objFuncType_.

Referenced by DASolver::printAllObjFuncs().

Here is the caller graph for this function:

◆ getObjFuncFaceSources()

const labelList& getObjFuncFaceSources ( ) const

inline

return DAObjFunc::objFuncFaceSources_

Definition at line 205 of file DAObjFunc.H.

References DAObjFunc::objFuncFaceSources_.

◆ getObjFuncCellSources()

const labelList& getObjFuncCellSources ( ) const

inline

return DAObjFunc::objFuncCellSources_

Definition at line 211 of file DAObjFunc.H.

References DAObjFunc::objFuncCellSources_.

◆ getObjFuncFaceValues()

const scalarList& getObjFuncFaceValues ( ) const

inline

return DAObjFunc::objFuncFaceValues_

Definition at line 217 of file DAObjFunc.H.

References DAObjFunc::objFuncFaceValues_.

◆ getObjFuncCellValues()

const scalarList& getObjFuncCellValues ( ) const

inline

return DAObjFunc::objFuncCellValues_

Definition at line 223 of file DAObjFunc.H.

References DAObjFunc::objFuncCellValues_.

◆ getObjFuncConInfo()

const List<List<word> >& getObjFuncConInfo ( ) const

inline

return DAObjFunc::objFuncConInfo_

Definition at line 229 of file DAObjFunc.H.

References DAObjFunc::objFuncConInfo_.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

fvMesh

Definition at line 45 of file DAObjFunc.H.

◆ daOption_

const DAOption& daOption_

protected

DAOption object.

Definition at line 48 of file DAObjFunc.H.

Referenced by DAObjFuncForce::DAObjFuncForce(), DAObjFuncTotalPressureRatio::DAObjFuncTotalPressureRatio(), and DAObjFuncTotalTemperatureRatio::DAObjFuncTotalTemperatureRatio().

◆ daModel_

const DAModel& daModel_

protected

DAModel object.

Definition at line 51 of file DAObjFunc.H.

Referenced by DAObjFunc::masterFunction().

◆ daIndex_

const DAIndex& daIndex_

protected

DAIndex object.

Definition at line 54 of file DAObjFunc.H.

Referenced by DAObjFuncMoment::calcObjFunc(), DAObjFuncCenterOfPressure::calcObjFunc(), DAObjFuncMassFlowRate::calcObjFunc(), DAObjFuncPower::calcObjFunc(), DAObjFuncTotalPressure::calcObjFunc(), DAObjFuncPatchMean::calcObjFunc(), DAObjFuncTotalTemperatureRatio::calcObjFunc(), DAObjFuncForce::calcObjFunc(), DAObjFuncTotalPressureRatio::calcObjFunc(), and DAObjFuncWallHeatFlux::calcObjFunc().

◆ daResidual_

const DAResidual& daResidual_

protected

DAResidual object.

Definition at line 57 of file DAObjFunc.H.

Referenced by DAObjFunc::masterFunction().

◆ objFuncName_

word objFuncName_

protected

the name of the objective function

Definition at line 60 of file DAObjFunc.H.

Referenced by DAObjFunc::getObjFuncName().

◆ objFuncPart_

word objFuncPart_

protected

the part of the objective function

Definition at line 63 of file DAObjFunc.H.

Referenced by DAObjFunc::getObjFuncPart().

◆ objFuncType_

word objFuncType_

protected

the type of the objective function

Definition at line 66 of file DAObjFunc.H.

Referenced by DAObjFuncCenterOfPressure::DAObjFuncCenterOfPressure(), DAObjFuncFieldInversion::DAObjFuncFieldInversion(), DAObjFuncForce::DAObjFuncForce(), DAObjFuncMass::DAObjFuncMass(), DAObjFuncMassFlowRate::DAObjFuncMassFlowRate(), DAObjFuncMeshQualityKS::DAObjFuncMeshQualityKS(), DAObjFuncMoment::DAObjFuncMoment(), DAObjFuncPatchMean::DAObjFuncPatchMean(), DAObjFuncPower::DAObjFuncPower(), DAObjFuncTotalPressure::DAObjFuncTotalPressure(), DAObjFuncTotalPressureRatio::DAObjFuncTotalPressureRatio(), DAObjFuncTotalTemperatureRatio::DAObjFuncTotalTemperatureRatio(), DAObjFuncVariableVolSum::DAObjFuncVariableVolSum(), DAObjFuncVonMisesStressKS::DAObjFuncVonMisesStressKS(), DAObjFuncWallHeatFlux::DAObjFuncWallHeatFlux(), and DAObjFunc::getObjFuncType().

◆ objFuncDict_

const dictionary& objFuncDict_

protected

dictionary containing the information for the objective function

Definition at line 69 of file DAObjFunc.H.

Referenced by DAObjFuncMoment::calcObjFunc(), DAObjFuncPower::calcObjFunc(), DAObjFuncFieldInversion::calcObjFunc(), DAObjFuncForce::calcObjFunc(), DAObjFunc::calcObjFuncSources(), DAObjFuncCenterOfPressure::DAObjFuncCenterOfPressure(), DAObjFuncFieldInversion::DAObjFuncFieldInversion(), DAObjFuncForce::DAObjFuncForce(), DAObjFuncMass::DAObjFuncMass(), DAObjFuncMassFlowRate::DAObjFuncMassFlowRate(), DAObjFuncMeshQualityKS::DAObjFuncMeshQualityKS(), DAObjFuncMoment::DAObjFuncMoment(), DAObjFuncPatchMean::DAObjFuncPatchMean(), DAObjFuncPower::DAObjFuncPower(), DAObjFuncTotalPressure::DAObjFuncTotalPressure(), DAObjFuncTotalPressureRatio::DAObjFuncTotalPressureRatio(), DAObjFuncTotalTemperatureRatio::DAObjFuncTotalTemperatureRatio(), DAObjFuncVariableVolSum::DAObjFuncVariableVolSum(), DAObjFuncVonMisesStressKS::DAObjFuncVonMisesStressKS(), and DAObjFuncWallHeatFlux::DAObjFuncWallHeatFlux().

◆ daField_

DAField daField_

protected

DAField object.

Definition at line 72 of file DAObjFunc.H.

Referenced by DAObjFunc::masterFunction().

◆ objFuncFaceSources_

labelList objFuncFaceSources_

protected

a sorted list of all face sources for the objective function

Definition at line 75 of file DAObjFunc.H.

Referenced by DAObjFunc::clear(), DAObjFunc::DAObjFunc(), DAObjFunc::getObjFuncFaceSources(), and DAObjFunc::getObjFuncValue().

◆ objFuncCellSources_

labelList objFuncCellSources_

protected

a sorted list of all cell sources for the objective function

Definition at line 78 of file DAObjFunc.H.

Referenced by DAObjFunc::clear(), DAObjFunc::DAObjFunc(), DAObjFunc::getObjFuncCellSources(), and DAObjFunc::getObjFuncValue().

◆ objFuncFaceValues_

scalarList objFuncFaceValues_

protected

value of the obj function on the discrete faces

Definition at line 81 of file DAObjFunc.H.

Referenced by DAObjFunc::clear(), DAObjFunc::DAObjFunc(), DAObjFunc::getObjFuncFaceValues(), and DAObjFunc::getObjFuncValue().

◆ objFuncCellValues_

scalarList objFuncCellValues_

protected

value of the obj function in the discrete cells

Definition at line 84 of file DAObjFunc.H.

Referenced by DAObjFunc::clear(), DAObjFunc::DAObjFunc(), DAObjFunc::getObjFuncCellValues(), and DAObjFunc::getObjFuncValue().

◆ scale_

scalar scale_

protected

scale of the objective function

Definition at line 87 of file DAObjFunc.H.

◆ objFuncValue_

scalar objFuncValue_

protected

the value of the objective function

Definition at line 90 of file DAObjFunc.H.

Referenced by DAObjFunc::getObjFuncValue().

◆ objFuncConInfo_

List<List<word> > objFuncConInfo_

protected

the connectivity information for the objective function

Definition at line 93 of file DAObjFunc.H.

Referenced by DAObjFunc::clear(), DAObjFuncFieldInversion::DAObjFuncFieldInversion(), DAObjFuncForce::DAObjFuncForce(), DAObjFuncMass::DAObjFuncMass(), DAObjFuncMassFlowRate::DAObjFuncMassFlowRate(), DAObjFuncMeshQualityKS::DAObjFuncMeshQualityKS(), DAObjFuncMoment::DAObjFuncMoment(), DAObjFuncPower::DAObjFuncPower(), DAObjFuncTotalPressure::DAObjFuncTotalPressure(), DAObjFuncTotalPressureRatio::DAObjFuncTotalPressureRatio(), DAObjFuncTotalTemperatureRatio::DAObjFuncTotalTemperatureRatio(), DAObjFuncVariableVolSum::DAObjFuncVariableVolSum(), DAObjFuncVonMisesStressKS::DAObjFuncVonMisesStressKS(), DAObjFuncWallHeatFlux::DAObjFuncWallHeatFlux(), and DAObjFunc::getObjFuncConInfo().

◆ expSumKS

scalar expSumKS = 1.0

expSumKS stores sum[exp(coeffKS*x_i)] for KS function which will be used to scale dFdW

Definition at line 235 of file DAObjFunc.H.

Referenced by DAObjFuncVonMisesStressKS::calcObjFunc().

◆ calcRefCoeffs

label calcRefCoeffs = 1

whether to compute reference coefficients for special objFunc treatment such as totalPressureRatio

Definition at line 238 of file DAObjFunc.H.

Referenced by DAObjFuncTotalPressureRatio::calcObjFunc(), and DAObjFuncTotalTemperatureRatio::calcObjFunc().

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DAObjFunc()

◆ ~DAObjFunc()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ clear()

◆ calcObjFuncSources()

◆ calcObjFunc()

◆ getObjFuncValue()

◆ masterFunction()

◆ getObjFuncName()

◆ getObjFuncPart()

◆ getObjFuncType()

◆ getObjFuncFaceSources()

◆ getObjFuncCellSources()

◆ getObjFuncFaceValues()

◆ getObjFuncCellValues()

◆ getObjFuncConInfo()

Member Data Documentation

◆ mesh_

◆ daOption_

◆ daModel_

◆ daIndex_

◆ daResidual_

◆ objFuncName_

◆ objFuncPart_

◆ objFuncType_

◆ objFuncDict_

◆ daField_

◆ objFuncFaceSources_

◆ objFuncCellSources_

◆ objFuncFaceValues_

◆ objFuncCellValues_

◆ scale_

◆ objFuncValue_

◆ objFuncConInfo_

◆ expSumKS

◆ calcRefCoeffs