Inheritance diagram for DAFunctionResidualNorm:

Collaboration diagram for DAFunctionResidualNorm:

Public Member Functions
	TypeName ("residualNorm")

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

virtual	~DAFunctionResidualNorm ()

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
HashTable< scalar >	resWeight_
	weights of the residuals More...

HashTable< wordList >	stateInfo_
	the stateInfo_ list from DAStateInfo object 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 27 of file DAFunctionResidualNorm.H.

Constructor & Destructor Documentation

◆ DAFunctionResidualNorm()

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

Definition at line 19 of file DAFunctionResidualNorm.C.

References forAll(), DAOption::getAllOptions(), DAOption::getOption(), mesh, DAStateInfo::New(), DAFunctionResidualNorm::resWeight_, solverName, and DAFunctionResidualNorm::stateInfo_.

Here is the call graph for this function:

◆ ~DAFunctionResidualNorm()

virtual ~DAFunctionResidualNorm ( )

inlinevirtual

Definition at line 51 of file DAFunctionResidualNorm.H.

Member Function Documentation

◆ TypeName()

TypeName ( "residualNorm" )

◆ calcFunction()

scalar calcFunction ( )

virtual

calculate the value of objective function

Implements DAFunction.

Definition at line 49 of file DAFunctionResidualNorm.C.

References DAFunction::calcRefVar(), DAModel::calcResiduals(), DAResidual::calcResiduals(), DAFunction::daIndex_, DAFunction::daModel_, forAll(), DAFunction::mesh_, DAIndex::nGlobalAdjointStates, DAFunctionResidualNorm::resWeight_, and DAFunctionResidualNorm::stateInfo_.

Here is the call graph for this function:

Member Data Documentation

◆ resWeight_

HashTable<scalar> resWeight_

protected

weights of the residuals

Definition at line 33 of file DAFunctionResidualNorm.H.

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

◆ stateInfo_

HashTable<wordList> stateInfo_

protected

the stateInfo_ list from DAStateInfo object

Definition at line 36 of file DAFunctionResidualNorm.H.