Public Member Functions | |
| TypeName ("meshQualityKS") | |
| DAFunctionMeshQualityKS (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName) | |
| virtual | ~DAFunctionMeshQualityKS () |
| 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 | |
| scalar | coeffKS_ |
| coefficient for the KS function More... | |
| word | metric_ |
| which mesh quality metric to use More... | |
| label | includeProcPatches_ |
| whether to include the processor patches for mesh quality calculation More... | |
| labelList | includeFaceList_ |
| a list of included faces for the mesh quality 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 27 of file DAFunctionMeshQualityKS.H.
Constructor & Destructor Documentation
◆ DAFunctionMeshQualityKS()
| DAFunctionMeshQualityKS | ( | const fvMesh & | mesh, |
| const DAOption & | daOption, | ||
| const DAModel & | daModel, | ||
| const DAIndex & | daIndex, | ||
| const word | functionName | ||
| ) |
Definition at line 19 of file DAFunctionMeshQualityKS.C.
References DAFunctionMeshQualityKS::coeffKS_, forAll(), DAFunction::functionDict_, DAOption::getOption(), DAFunctionMeshQualityKS::includeFaceList_, DAFunctionMeshQualityKS::includeProcPatches_, mesh, DAFunction::mesh_, and DAFunctionMeshQualityKS::metric_.
◆ ~DAFunctionMeshQualityKS()
|
inlinevirtual |
Definition at line 57 of file DAFunctionMeshQualityKS.H.
Member Function Documentation
◆ TypeName()
| TypeName | ( | "meshQualityKS" | ) |
◆ calcFunction()
|
virtual |
calculate the value of objective function
Implements DAFunction.
Definition at line 70 of file DAFunctionMeshQualityKS.C.
References DAFunction::calcRefVar(), DAFunctionMeshQualityKS::coeffKS_, forAll(), DAFunctionMeshQualityKS::includeFaceList_, DAFunction::mesh_, and DAFunctionMeshQualityKS::metric_.
Member Data Documentation
◆ coeffKS_
|
protected |
coefficient for the KS function
Definition at line 33 of file DAFunctionMeshQualityKS.H.
Referenced by DAFunctionMeshQualityKS::calcFunction(), and DAFunctionMeshQualityKS::DAFunctionMeshQualityKS().
◆ metric_
|
protected |
which mesh quality metric to use
Definition at line 36 of file DAFunctionMeshQualityKS.H.
Referenced by DAFunctionMeshQualityKS::calcFunction(), and DAFunctionMeshQualityKS::DAFunctionMeshQualityKS().
◆ includeProcPatches_
|
protected |
whether to include the processor patches for mesh quality calculation
Definition at line 39 of file DAFunctionMeshQualityKS.H.
Referenced by DAFunctionMeshQualityKS::DAFunctionMeshQualityKS().
◆ includeFaceList_
|
protected |
a list of included faces for the mesh quality calculation
Definition at line 42 of file DAFunctionMeshQualityKS.H.
Referenced by DAFunctionMeshQualityKS::calcFunction(), and DAFunctionMeshQualityKS::DAFunctionMeshQualityKS().
The documentation for this class was generated from the following files:
- dafoam/src/adjoint/DAFunction/DAFunctionMeshQualityKS.H
- dafoam/src/adjoint/DAFunction/DAFunctionMeshQualityKS.C
