Public Member Functions | |
| TypeName ("variableVolSum") | |
| DAFunctionVariableVolSum (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName) | |
| virtual | ~DAFunctionVariableVolSum () |
| 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 | varType_ |
| type of the variable either vector or scalar More... | |
| label | index_ |
| if vector which element/index? More... | |
| label | isSquare_ |
| whether to take a square of the variable More... | |
| label | divByTotalVol_ |
| whether to normalize the volume sum with the total volume More... | |
| label | multiplyVol_ |
| whether to multiply the variable by the volume 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 DAFunctionVariableVolSum.H.
Constructor & Destructor Documentation
◆ DAFunctionVariableVolSum()
| DAFunctionVariableVolSum | ( | const fvMesh & | mesh, |
| const DAOption & | daOption, | ||
| const DAModel & | daModel, | ||
| const DAIndex & | daIndex, | ||
| const word | functionName | ||
| ) |
Definition at line 19 of file DAFunctionVariableVolSum.C.
References DAFunctionVariableVolSum::divByTotalVol_, DAFunction::functionDict_, DAFunctionVariableVolSum::index_, DAFunctionVariableVolSum::isSquare_, DAFunctionVariableVolSum::multiplyVol_, DAFunctionVariableVolSum::varName_, and DAFunctionVariableVolSum::varType_.
◆ ~DAFunctionVariableVolSum()
|
inlinevirtual |
Definition at line 62 of file DAFunctionVariableVolSum.H.
Member Function Documentation
◆ TypeName()
| TypeName | ( | "variableVolSum" | ) |
◆ calcFunction()
|
virtual |
calculate the value of objective function
Implements DAFunction.
Definition at line 47 of file DAFunctionVariableVolSum.C.
References DAFunction::calcRefVar(), DAFunction::cellSources_, DAFunctionVariableVolSum::divByTotalVol_, forAll(), DAFunctionVariableVolSum::index_, DAFunctionVariableVolSum::isSquare_, DAFunction::mesh_, DAFunctionVariableVolSum::multiplyVol_, DAFunction::scale_, DAFunctionVariableVolSum::varName_, and DAFunctionVariableVolSum::varType_.
Member Data Documentation
◆ varName_
|
protected |
name of the variable
Definition at line 32 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
◆ varType_
|
protected |
type of the variable either vector or scalar
Definition at line 35 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
◆ index_
|
protected |
if vector which element/index?
Definition at line 38 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
◆ isSquare_
|
protected |
whether to take a square of the variable
Definition at line 41 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
◆ divByTotalVol_
|
protected |
whether to normalize the volume sum with the total volume
Definition at line 44 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
◆ multiplyVol_
|
protected |
whether to multiply the variable by the volume
Definition at line 47 of file DAFunctionVariableVolSum.H.
Referenced by DAFunctionVariableVolSum::calcFunction(), and DAFunctionVariableVolSum::DAFunctionVariableVolSum().
The documentation for this class was generated from the following files:
- dafoam/src/adjoint/DAFunction/DAFunctionVariableVolSum.H
- dafoam/src/adjoint/DAFunction/DAFunctionVariableVolSum.C
