DAObjFuncMoment.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 moment
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAObjFuncMoment_H
12 #define DAObjFuncMoment_H
13 
14 #include "DAObjFunc.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DAObjFuncMoment Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DAObjFunc
28 {
29 
30 protected:
32  vector momentDir_;
33 
35  vector momentCenter_;
36 
39 
40 public:
41  TypeName("moment");
42  // Constructors
43 
44  //- Construct from components
46  const fvMesh& mesh,
47  const DAOption& daOption,
48  const DAModel& daModel,
49  const DAIndex& daIndex,
50  const DAResidual& daResidual,
51  const word objFuncName,
52  const word objFuncPart,
53  const dictionary& objFuncDict);
54 
55  //- Destructor
56  virtual ~DAObjFuncMoment()
57  {
58  }
59 
61  virtual void calcObjFunc(
62  const labelList& objFuncFaceSources,
63  const labelList& objFuncCellSources,
64  scalarList& objFuncFaceValues,
65  scalarList& objFuncCellValues,
66  scalar& objFuncValue);
67 };
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 } // End namespace Foam
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 #endif
76 
77 // ************************************************************************* //
Foam::DAObjFuncMoment::daTurb_
const DATurbulenceModel & daTurb_
DATurbulenceModel object.
Definition: DAObjFuncMoment.H:38
Foam::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DAObjFuncMoment::momentDir_
vector momentDir_
the direction of the moment
Definition: DAObjFuncMoment.H:32
Foam::DAObjFuncMoment::TypeName
TypeName("moment")
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAObjFuncMoment::DAObjFuncMoment
DAObjFuncMoment(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: DAObjFuncMoment.C:19
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAModel
Definition: DAModel.H:59
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DAObjFuncMoment::~DAObjFuncMoment
virtual ~DAObjFuncMoment()
Definition: DAObjFuncMoment.H:56
Foam::DAObjFuncMoment
Definition: DAObjFuncMoment.H:26
Foam::DAResidual
Definition: DAResidual.H:35
Foam::DATurbulenceModel
Definition: DATurbulenceModel.H:61
Foam::DAObjFuncMoment::momentCenter_
vector momentCenter_
the center of rotation for moment
Definition: DAObjFuncMoment.H:35
daModel
DAModel daModel(mesh, daOption)
daIndex
DAIndex daIndex(mesh, daOption, daModel)
DAObjFunc.H
Foam::DAObjFuncMoment::calcObjFunc
virtual void calcObjFunc(const labelList &objFuncFaceSources, const labelList &objFuncCellSources, scalarList &objFuncFaceValues, scalarList &objFuncCellValues, scalar &objFuncValue)
calculate the value of objective function
Definition: DAObjFuncMoment.C:96
Foam::DAObjFunc
Definition: DAObjFunc.H:33