DAMotionTranslation.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 translation oscillation motion
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAMotionTranslation_H
12 #define DAMotionTranslation_H
13 
14 #include "DAMotion.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DAMotionTranslation Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DAMotion
28 {
29 
30 protected:
32  scalar amplitude_;
33 
35  scalar frequency_;
36 
38  scalar phase_;
39 
41  vector direction_ = vector::zero;
42 
43 public:
44  TypeName("translation");
45  // Constructors
46 
47  //- Construct from components
49  const dynamicFvMesh& mesh,
50  const DAOption& daOption);
51 
52  //- Destructor
54  {
55  }
56 
58  virtual void correct();
59 };
60 
61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63 } // End namespace Foam
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 #endif
68 
69 // ************************************************************************* //
Foam::DAMotionTranslation::phase_
scalar phase_
phase of the translation oscillation
Definition: DAMotionTranslation.H:38
Foam::DAMotionTranslation::amplitude_
scalar amplitude_
amplitude of the translation oscillation
Definition: DAMotionTranslation.H:32
Foam::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DAMotionTranslation::frequency_
scalar frequency_
frequency of the translation oscillation
Definition: DAMotionTranslation.H:35
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
DAMotion.H
Foam::DAMotion
Definition: DAMotion.H:29
Foam::DAMotionTranslation::TypeName
TypeName("translation")
Foam::DAMotionTranslation::~DAMotionTranslation
virtual ~DAMotionTranslation()
Definition: DAMotionTranslation.H:53
Foam::DAMotionTranslation::direction_
vector direction_
direction of the translation oscillation
Definition: DAMotionTranslation.H:41
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DAMotionTranslation::correct
virtual void correct()
update the cell displacement
Definition: DAMotionTranslation.C:37
Foam::DAMotionTranslation
Definition: DAMotionTranslation.H:26
Foam::DAMotionTranslation::DAMotionTranslation
DAMotionTranslation(const dynamicFvMesh &mesh, const DAOption &daOption)
Definition: DAMotionTranslation.C:19