DAFunctionMeshQualityKS.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v4
5 
6  Description:
7  Child class for mesh quality with KS function
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAFunctionMeshQualityKS_H
12 #define DAFunctionMeshQualityKS_H
13 
14 #include "DAFunction.H"
15 #include "polyMeshTools.H"
16 #include "addToRunTimeSelectionTable.H"
17 
18 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
19 
20 namespace Foam
21 {
22 
23 /*---------------------------------------------------------------------------*\
24  Class DAFunctionMeshQualityKS Declaration
25 \*---------------------------------------------------------------------------*/
26 
28  : public DAFunction
29 {
30 
31 protected:
33  scalar coeffKS_;
34 
36  word metric_;
37 
40 
42  labelList includeFaceList_;
43 
44 public:
45  TypeName("meshQualityKS");
46  // Constructors
47 
48  //- Construct from components
50  const fvMesh& mesh,
51  const DAOption& daOption,
52  const DAModel& daModel,
53  const DAIndex& daIndex,
54  const word functionName);
55 
56  //- Destructor
58  {
59  }
60 
62  virtual scalar calcFunction();
63 };
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 } // End namespace Foam
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 #endif
72 
73 // ************************************************************************* //
Foam::DAFunctionMeshQualityKS::includeProcPatches_
label includeProcPatches_
whether to include the processor patches for mesh quality calculation
Definition: DAFunctionMeshQualityKS.H:39
Foam::DAFunctionMeshQualityKS::metric_
word metric_
which mesh quality metric to use
Definition: DAFunctionMeshQualityKS.H:36
Foam::DAOption
Definition: DAOption.H:29
DAFunction.H
Foam::DAFunctionMeshQualityKS::calcFunction
virtual scalar calcFunction()
calculate the value of objective function
Definition: DAFunctionMeshQualityKS.C:70
Foam::DAFunctionMeshQualityKS::coeffKS_
scalar coeffKS_
coefficient for the KS function
Definition: DAFunctionMeshQualityKS.H:33
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAFunctionMeshQualityKS
Definition: DAFunctionMeshQualityKS.H:27
Foam::DAModel
Definition: DAModel.H:57
Foam::DAFunction
Definition: DAFunction.H:31
Foam
Definition: checkGeometry.C:32
Foam::DAFunctionMeshQualityKS::includeFaceList_
labelList includeFaceList_
a list of included faces for the mesh quality calculation
Definition: DAFunctionMeshQualityKS.H:42
Foam::DAFunctionMeshQualityKS::DAFunctionMeshQualityKS
DAFunctionMeshQualityKS(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
Definition: DAFunctionMeshQualityKS.C:19
Foam::DAFunctionMeshQualityKS::~DAFunctionMeshQualityKS
virtual ~DAFunctionMeshQualityKS()
Definition: DAFunctionMeshQualityKS.H:57
Foam::DAFunctionMeshQualityKS::TypeName
TypeName("meshQualityKS")