Inheritance diagram for DAFunctionVariance:

Collaboration diagram for DAFunctionVariance:

Public Member Functions
	TypeName ("variance")

	DAFunctionVariance (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

virtual	~DAFunctionVariance ()

virtual scalar	calcFunction ()
	calculate the value of objective function More...

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

	declareRunTimeSelectionTable (autoPtr, DAFunction, dictionary,(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName),(mesh, daOption, daModel, daIndex, functionName))

	DAFunction (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

virtual	~DAFunction ()

void	clear ()
	clear up members More...

void	calcFunctionSources ()
	calculate DAFunction::faceSources_ and DAFunction::cellSources_ More...

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

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

word	getFunctionTimeOp ()
	return the time operator such as final, sum, average, variance More...

const labelList &	getFaceSources () const
	return DAFunction::faceSources_ More...

const labelList &	getCellSources () const
	return DAFunction::cellSources_ More...

void	calcRefVar (scalar &functionValue)
	calculate (var-ref)^2 More...

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

word	mode_
	data mode options are probePoint surface or field More...

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

List< label >	indices_
	components/indices of the vector variable More...

labelList	probeCellIndex_
	cell index of the probe points More...

List< List< scalar > >	probePointCoords_
	coordinates of the probe points More...

word	probePointMethod_
	what probe point method to use More...

List< word >	surfaceNames_
	names of the surfaces for ref data More...

List< List< scalar > >	refValue_
	probe value More...

label	nRefPoints_ = 0
	total number of reference points More...

scalar	varUpperBound_
	upper bound to be considered as non-data More...

label	isRefData_
	whether we find the reference data More...

label	timeDependentRefData_
	whether the ref data is time dependent if yes we need data in all time folders otherwise get it from the 0 folder More...

DATurbulenceModel &	daTurb_
	DATurbulenceModel object. More...

scalar	Cp_ = -9999.0
	Cp used in incompressible heatFlux calculation. More...

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

const DAOption &	daOption_
	DAOption object. More...

const DAModel &	daModel_
	DAModel object. More...

const DAIndex &	daIndex_
	DAIndex object. More...

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

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

word	timeOp_
	time operator such as final, sum, or average More...

dictionary	functionDict_
	dictionary containing the information for the objective function More...

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

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

scalar	scale_
	scale of the objective function More...

label	calcRefVar_
	whether to calculate (obj-ref)^2 More...

scalarList	ref_
	if calcRefVar_ is True, set the reference value list More...

Additional Inherited Members
Static Public Member Functions inherited from DAFunction
static autoPtr< DAFunction >	New (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

Detailed Description

Definition at line 26 of file DAFunctionVariance.H.

Constructor & Destructor Documentation

◆ DAFunctionVariance()

DAFunctionVariance	(	const fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex,
		const word	functionName
	)

◆ ~DAFunctionVariance()

virtual ~DAFunctionVariance ( )

inlinevirtual

Definition at line 89 of file DAFunctionVariance.H.

Member Function Documentation

◆ TypeName()

TypeName ( "variance" )

◆ calcFunction()

scalar calcFunction ( )

virtual

calculate the value of objective function

Implements DAFunction.

Definition at line 334 of file DAFunctionVariance.C.

Here is the call graph for this function:

Member Data Documentation

◆ varName_

word varName_

protected

name of the variable

Definition at line 32 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ mode_

word mode_

protected

data mode options are probePoint surface or field

Definition at line 35 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ varType_

word varType_

protected

type of the variable either vector or scalar

Definition at line 38 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ indices_

List<label> indices_

protected

components/indices of the vector variable

Definition at line 41 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ probeCellIndex_

labelList probeCellIndex_

protected

cell index of the probe points

Definition at line 44 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ probePointCoords_

List<List<scalar> > probePointCoords_

protected

coordinates of the probe points

Definition at line 47 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::DAFunctionVariance().

◆ probePointMethod_

word probePointMethod_

protected

what probe point method to use

Definition at line 50 of file DAFunctionVariance.H.

◆ surfaceNames_

List<word> surfaceNames_

protected

names of the surfaces for ref data

Definition at line 53 of file DAFunctionVariance.H.

◆ refValue_

List<List<scalar> > refValue_

protected

probe value

Definition at line 56 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ nRefPoints_

label nRefPoints_ = 0

protected

total number of reference points

Definition at line 59 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ varUpperBound_

scalar varUpperBound_

protected

upper bound to be considered as non-data

Definition at line 62 of file DAFunctionVariance.H.

◆ isRefData_

label isRefData_

protected

whether we find the reference data

Definition at line 65 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ timeDependentRefData_

label timeDependentRefData_

protected

whether the ref data is time dependent if yes we need data in all time folders otherwise get it from the 0 folder

Definition at line 68 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 71 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

◆ Cp_

scalar Cp_ = -9999.0

protected

Cp used in incompressible heatFlux calculation.

Definition at line 74 of file DAFunctionVariance.H.

Referenced by DAFunctionVariance::calcFunction(), and DAFunctionVariance::DAFunctionVariance().

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

dafoam/src/adjoint/DAFunction/DAFunctionVariance.H
dafoam/src/adjoint/DAFunction/DAFunctionVariance.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DAFunctionVariance()

◆ ~DAFunctionVariance()

Member Function Documentation

◆ TypeName()

◆ calcFunction()

Member Data Documentation

◆ varName_

◆ mode_

◆ varType_

◆ indices_

◆ probeCellIndex_

◆ probePointCoords_

◆ probePointMethod_

◆ surfaceNames_

◆ refValue_

◆ nRefPoints_

◆ varUpperBound_

◆ isRefData_

◆ timeDependentRefData_

◆ daTurb_

◆ Cp_