DAFunctionTotalTemperatureRatio.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 total temperature ratio
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAFunctionTotalTemperatureRatio_H
12 #define DAFunctionTotalTemperatureRatio_H
13 
14 #include "DAFunction.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DAFunctionTotalTemperatureRatio Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DAFunction
28 {
29 
30 protected:
32  scalar areaSumInlet_ = -9999.0;
33 
35  scalar areaSumOutlet_ = -9999.0;
36 
38  wordList outletPatches_;
39 
41  wordList inletPatches_;
42 
43  scalar Cp_;
44 
45  scalar gamma_;
46 
47 public:
48  TypeName("totalTemperatureRatio");
49  // Constructors
50 
51  //- Construct from components
53  const fvMesh& mesh,
54  const DAOption& daOption,
55  const DAModel& daModel,
56  const DAIndex& daIndex,
57  const word functionName);
58 
59  //- Destructor
61  {
62  }
63 
65  virtual scalar calcFunction();
66 };
67 
68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
69 
70 } // End namespace Foam
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 #endif
75 
76 // ************************************************************************* //
Foam::DAFunctionTotalTemperatureRatio
Definition: DAFunctionTotalTemperatureRatio.H:26
Foam::DAFunctionTotalTemperatureRatio::areaSumInlet_
scalar areaSumInlet_
the area of all inlet patches
Definition: DAFunctionTotalTemperatureRatio.H:32
Foam::DAOption
Definition: DAOption.H:29
DAFunction.H
Foam::DAFunctionTotalTemperatureRatio::gamma_
scalar gamma_
Definition: DAFunctionTotalTemperatureRatio.H:45
Foam::DAFunctionTotalTemperatureRatio::calcFunction
virtual scalar calcFunction()
calculate the value of objective function
Definition: DAFunctionTotalTemperatureRatio.C:51
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAFunctionTotalTemperatureRatio::DAFunctionTotalTemperatureRatio
DAFunctionTotalTemperatureRatio(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
Definition: DAFunctionTotalTemperatureRatio.C:19
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAModel
Definition: DAModel.H:57
Foam::DAFunction
Definition: DAFunction.H:31
Foam
Definition: checkGeometry.C:32
Foam::DAFunctionTotalTemperatureRatio::inletPatches_
wordList inletPatches_
names of inlet patches
Definition: DAFunctionTotalTemperatureRatio.H:41
Foam::DAFunctionTotalTemperatureRatio::~DAFunctionTotalTemperatureRatio
virtual ~DAFunctionTotalTemperatureRatio()
Definition: DAFunctionTotalTemperatureRatio.H:60
Foam::DAFunctionTotalTemperatureRatio::TypeName
TypeName("totalTemperatureRatio")
Foam::DAFunctionTotalTemperatureRatio::Cp_
scalar Cp_
Definition: DAFunctionTotalTemperatureRatio.H:43
Foam::DAFunctionTotalTemperatureRatio::outletPatches_
wordList outletPatches_
names of outlet patches
Definition: DAFunctionTotalTemperatureRatio.H:38
Foam::DAFunctionTotalTemperatureRatio::areaSumOutlet_
scalar areaSumOutlet_
the area of all outlet patches
Definition: DAFunctionTotalTemperatureRatio.H:35