Inheritance diagram for DAObjFuncMeshQualityKS:

Collaboration diagram for DAObjFuncMeshQualityKS:

Public Member Functions
	TypeName ("meshQualityKS")

	DAObjFuncMeshQualityKS (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	~DAObjFuncMeshQualityKS ()

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
scalar	coeffKS_
	coefficient for the KS function More...

word	metric_
	which mesh quality metric to use 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 27 of file DAObjFuncMeshQualityKS.H.

Constructor & Destructor Documentation

◆ DAObjFuncMeshQualityKS()

DAObjFuncMeshQualityKS	(	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 DAObjFuncMeshQualityKS.C.

References DAObjFuncMeshQualityKS::coeffKS_, DAObjFuncMeshQualityKS::metric_, DAObjFunc::objFuncConInfo_, DAObjFunc::objFuncDict_, DAObjFunc::objFuncType_, and DAObjFunc::scale_.

◆ ~DAObjFuncMeshQualityKS()

virtual ~DAObjFuncMeshQualityKS ( )

inlinevirtual

Definition at line 56 of file DAObjFuncMeshQualityKS.H.

Member Function Documentation

◆ TypeName()

TypeName ( "meshQualityKS" )

◆ 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 51 of file DAObjFuncMeshQualityKS.C.

References DAObjFuncMeshQualityKS::coeffKS_, forAll(), DAObjFunc::mesh_, and DAObjFuncMeshQualityKS::metric_.

Here is the call graph for this function:

Member Data Documentation

◆ coeffKS_

scalar coeffKS_

protected

coefficient for the KS function

Definition at line 34 of file DAObjFuncMeshQualityKS.H.

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

◆ metric_

word metric_

protected

which mesh quality metric to use

Definition at line 37 of file DAObjFuncMeshQualityKS.H.