Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
DAFunction Class Referenceabstract
Inheritance diagram for DAFunction:
Inheritance graph
[legend]
Collaboration diagram for DAFunction:
Collaboration graph
[legend]

Public Member Functions

 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...
 
virtual scalar calcFunction ()=0
 calculate the value of objective function 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...
 

Static Public Member Functions

static autoPtr< DAFunction > New (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
 

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

Detailed Description

Definition at line 31 of file DAFunction.H.

Constructor & Destructor Documentation

◆ DAFunction()

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

Definition at line 22 of file DAFunction.C.

References DAFunction::calcFunctionSources(), DAFunction::calcRefVar_, DAFunction::functionDict_, DAFunction::functionType_, DAOption::getAllOptions(), DAFunction::ref_, DAFunction::scale_, and DAFunction::timeOp_.

Here is the call graph for this function:

◆ ~DAFunction()

virtual ~DAFunction ( )
inlinevirtual

Definition at line 124 of file DAFunction.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DAFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

autoPtr< DAFunction > New ( const fvMesh &  mesh,
const DAOption &  daOption,
const DAModel &  daModel,
const DAIndex &  daIndex,
const word  functionName 
)
static

Definition at line 54 of file DAFunction.C.

References DAOption::getAllOptions(), and mesh.

Referenced by DASolver::setDAFunctionList().

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 129 of file DAFunction.H.

References DAFunction::cellSources_, and DAFunction::faceSources_.

◆ calcFunctionSources()

void calcFunctionSources ( )

calculate DAFunction::faceSources_ and DAFunction::cellSources_

Definition at line 107 of file DAFunction.C.

References DAFunction::cellSources_, DAFunction::faceSources_, forAll(), DAFunction::functionDict_, and DAFunction::mesh_.

Referenced by DAFunction::DAFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ calcFunction()

virtual scalar calcFunction ( )
pure virtual

calculate the value of objective function

Implemented in DAFunctionVariance, DAFunctionLocation, DAFunctionVariableVolSum, DAFunctionWallHeatFlux, DAFunctionForce, DAFunctionTotalPressureRatio, DAFunctionTotalTemperatureRatio, DAFunctionMeshQualityKS, DAFunctionPatchMean, DAFunctionMoment, DAFunctionTotalPressure, DAFunctionResidualNorm, DAFunctionMassFlowRate, and DAFunctionVonMisesStressKS.

Referenced by DASolver::calcAllFunctions(), and DAOutputFunction::run().

Here is the caller graph for this function:

◆ getFunctionName()

word getFunctionName ( )
inline

return the name of objective function

Definition at line 142 of file DAFunction.H.

References DAFunction::functionName_.

Referenced by DASolver::calcAllFunctions(), DASolver::getdFScaling(), DAOutputFunction::getFunctionListIndex(), DASolver::getFunctionListIndex(), and DASolver::getTimeOpFuncVal().

Here is the caller graph for this function:

◆ getFunctionType()

word getFunctionType ( )
inline

return the part of objective function

Definition at line 148 of file DAFunction.H.

References DAFunction::functionType_.

◆ getFunctionTimeOp()

word getFunctionTimeOp ( )
inline

return the time operator such as final, sum, average, variance

Definition at line 154 of file DAFunction.H.

References DAFunction::timeOp_.

Referenced by DASolver::calcAllFunctions().

Here is the caller graph for this function:

◆ getFaceSources()

const labelList& getFaceSources ( ) const
inline

return DAFunction::faceSources_

Definition at line 160 of file DAFunction.H.

References DAFunction::faceSources_.

◆ getCellSources()

const labelList& getCellSources ( ) const
inline

return DAFunction::cellSources_

Definition at line 166 of file DAFunction.H.

References DAFunction::cellSources_.

◆ calcRefVar()

void calcRefVar ( scalar &  functionValue)

calculate (var-ref)^2

Definition at line 216 of file DAFunction.C.

References DAFunction::calcRefVar_, DAFunction::mesh_, and DAFunction::ref_.

Referenced by DAFunctionMassFlowRate::calcFunction(), DAFunctionVonMisesStressKS::calcFunction(), DAFunctionResidualNorm::calcFunction(), DAFunctionMoment::calcFunction(), DAFunctionTotalPressure::calcFunction(), DAFunctionPatchMean::calcFunction(), DAFunctionMeshQualityKS::calcFunction(), DAFunctionTotalPressureRatio::calcFunction(), DAFunctionTotalTemperatureRatio::calcFunction(), DAFunctionForce::calcFunction(), DAFunctionVariableVolSum::calcFunction(), DAFunctionWallHeatFlux::calcFunction(), and DAFunctionLocation::calcFunction().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

fvMesh

Definition at line 43 of file DAFunction.H.

Referenced by DAFunctionMassFlowRate::calcFunction(), DAFunctionVonMisesStressKS::calcFunction(), DAFunctionResidualNorm::calcFunction(), DAFunctionMoment::calcFunction(), DAFunctionTotalPressure::calcFunction(), DAFunctionPatchMean::calcFunction(), DAFunctionMeshQualityKS::calcFunction(), DAFunctionTotalTemperatureRatio::calcFunction(), DAFunctionTotalPressureRatio::calcFunction(), DAFunctionForce::calcFunction(), DAFunctionVariableVolSum::calcFunction(), DAFunctionWallHeatFlux::calcFunction(), DAFunctionLocation::calcFunction(), DAFunctionVariance::calcFunction(), DAFunction::calcFunctionSources(), DAFunction::calcRefVar(), DAFunctionLocation::DAFunctionLocation(), DAFunctionMeshQualityKS::DAFunctionMeshQualityKS(), DAFunctionTotalPressureRatio::DAFunctionTotalPressureRatio(), DAFunctionTotalTemperatureRatio::DAFunctionTotalTemperatureRatio(), DAFunctionVariance::DAFunctionVariance(), DAFunctionWallHeatFlux::DAFunctionWallHeatFlux(), and DAFunctionLocation::findGlobalSnappedCenter().

◆ daOption_

const DAOption& daOption_
protected

DAOption object.

Definition at line 46 of file DAFunction.H.

Referenced by DAFunctionForce::DAFunctionForce(), DAFunctionTotalPressureRatio::DAFunctionTotalPressureRatio(), DAFunctionTotalTemperatureRatio::DAFunctionTotalTemperatureRatio(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ daModel_

const DAModel& daModel_
protected

DAModel object.

Definition at line 49 of file DAFunction.H.

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

◆ daIndex_

const DAIndex& daIndex_
protected

DAIndex object.

Definition at line 52 of file DAFunction.H.

Referenced by DAFunctionMassFlowRate::calcFunction(), DAFunctionResidualNorm::calcFunction(), DAFunctionMoment::calcFunction(), DAFunctionTotalPressure::calcFunction(), DAFunctionPatchMean::calcFunction(), DAFunctionTotalPressureRatio::calcFunction(), DAFunctionTotalTemperatureRatio::calcFunction(), DAFunctionForce::calcFunction(), DAFunctionWallHeatFlux::calcFunction(), DAFunctionLocation::calcFunction(), DAFunctionVariance::calcFunction(), DAFunctionLocation::DAFunctionLocation(), and DAFunctionVariance::DAFunctionVariance().

◆ functionName_

word functionName_
protected

the name of the objective function

Definition at line 55 of file DAFunction.H.

Referenced by DAFunction::getFunctionName().

◆ functionType_

word functionType_
protected

the type of the objective function

Definition at line 58 of file DAFunction.H.

Referenced by DAFunction::DAFunction(), and DAFunction::getFunctionType().

◆ timeOp_

word timeOp_
protected

time operator such as final, sum, or average

Definition at line 61 of file DAFunction.H.

Referenced by DAFunction::DAFunction(), and DAFunction::getFunctionTimeOp().

◆ functionDict_

dictionary functionDict_
protected

dictionary containing the information for the objective function

Definition at line 64 of file DAFunction.H.

Referenced by DAFunction::calcFunctionSources(), DAFunction::DAFunction(), DAFunctionForce::DAFunctionForce(), DAFunctionLocation::DAFunctionLocation(), DAFunctionMeshQualityKS::DAFunctionMeshQualityKS(), DAFunctionMoment::DAFunctionMoment(), DAFunctionPatchMean::DAFunctionPatchMean(), DAFunctionTotalPressureRatio::DAFunctionTotalPressureRatio(), DAFunctionTotalTemperatureRatio::DAFunctionTotalTemperatureRatio(), DAFunctionVariableVolSum::DAFunctionVariableVolSum(), DAFunctionVariance::DAFunctionVariance(), DAFunctionVonMisesStressKS::DAFunctionVonMisesStressKS(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ faceSources_

labelList faceSources_
protected

a sorted list of all face sources for the objective function

Definition at line 67 of file DAFunction.H.

Referenced by DAFunctionMassFlowRate::calcFunction(), DAFunctionMoment::calcFunction(), DAFunctionTotalPressure::calcFunction(), DAFunctionPatchMean::calcFunction(), DAFunctionTotalPressureRatio::calcFunction(), DAFunctionTotalTemperatureRatio::calcFunction(), DAFunctionForce::calcFunction(), DAFunctionWallHeatFlux::calcFunction(), DAFunctionLocation::calcFunction(), DAFunctionVariance::calcFunction(), DAFunction::calcFunctionSources(), DAFunction::clear(), DAFunctionLocation::DAFunctionLocation(), DAFunctionVariance::DAFunctionVariance(), and DAFunction::getFaceSources().

◆ cellSources_

labelList cellSources_
protected

a sorted list of all cell sources for the objective function

Definition at line 70 of file DAFunction.H.

Referenced by DAFunctionVonMisesStressKS::calcFunction(), DAFunctionVariableVolSum::calcFunction(), DAFunctionVariance::calcFunction(), DAFunction::calcFunctionSources(), DAFunction::clear(), DAFunctionVariance::DAFunctionVariance(), and DAFunction::getCellSources().

◆ scale_

scalar scale_
protected

scale of the objective function

Definition at line 73 of file DAFunction.H.

Referenced by DAFunctionMassFlowRate::calcFunction(), DAFunctionVonMisesStressKS::calcFunction(), DAFunctionMoment::calcFunction(), DAFunctionTotalPressure::calcFunction(), DAFunctionPatchMean::calcFunction(), DAFunctionForce::calcFunction(), DAFunctionVariableVolSum::calcFunction(), DAFunctionWallHeatFlux::calcFunction(), DAFunctionVariance::calcFunction(), and DAFunction::DAFunction().

◆ calcRefVar_

label calcRefVar_
protected

whether to calculate (obj-ref)^2

Definition at line 76 of file DAFunction.H.

Referenced by DAFunction::calcRefVar(), and DAFunction::DAFunction().

◆ ref_

scalarList ref_
protected

if calcRefVar_ is True, set the reference value list

Definition at line 79 of file DAFunction.H.

Referenced by DAFunction::calcRefVar(), and DAFunction::DAFunction().

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

Generated by   doxygen 1.8.17