DAObjFuncMass.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v3
5 
6  Description:
7  Child class for mass
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAObjFuncMass_H
12 #define DAObjFuncMass_H
13 
14 #include "DAObjFunc.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DAObjFuncMass Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DAObjFunc
28 {
29 
30 public:
31  TypeName("mass");
32  // Constructors
33 
34  //- Construct from components
36  const fvMesh& mesh,
37  const DAOption& daOption,
38  const DAModel& daModel,
39  const DAIndex& daIndex,
40  const DAResidual& daResidual,
41  const word objFuncName,
42  const word objFuncPart,
43  const dictionary& objFuncDict);
44 
45  //- Destructor
46  virtual ~DAObjFuncMass()
47  {
48  }
49 
51  virtual void calcObjFunc(
52  const labelList& objFuncFaceSources,
53  const labelList& objFuncCellSources,
54  scalarList& objFuncFaceValues,
55  scalarList& objFuncCellValues,
56  scalar& objFuncValue);
57 };
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 } // End namespace Foam
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 #endif
66 
67 // ************************************************************************* //
Foam::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DAObjFuncMass::TypeName
TypeName("mass")
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAObjFuncMass
Definition: DAObjFuncMass.H:26
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAObjFuncMass::~DAObjFuncMass
virtual ~DAObjFuncMass()
Definition: DAObjFuncMass.H:46
Foam::DAModel
Definition: DAModel.H:59
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DAObjFuncMass::calcObjFunc
virtual void calcObjFunc(const labelList &objFuncFaceSources, const labelList &objFuncCellSources, scalarList &objFuncFaceValues, scalarList &objFuncCellValues, scalar &objFuncValue)
calculate the value of objective function
Definition: DAObjFuncMass.C:49
Foam::DAResidual
Definition: DAResidual.H:35
Foam::DAObjFuncMass::DAObjFuncMass
DAObjFuncMass(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)
Definition: DAObjFuncMass.C:19
daModel
DAModel daModel(mesh, daOption)
daIndex
DAIndex daIndex(mesh, daOption, daModel)
DAObjFunc.H
Foam::DAObjFunc
Definition: DAObjFunc.H:33