oscillatingLinearMotion.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::solidBodyMotionFunctions::oscillatingLinearMotion
26 
27 Description
28  SolidBodyMotionFvMesh 6DoF motion function. Oscillating displacement.
29 
30 SourceFiles
31  oscillatingLinearMotion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef oscillatingLinearMotion_H
36 #define oscillatingLinearMotion_H
37 
39 #include "primitiveFields.H"
40 #include "point.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace solidBodyMotionFunctions
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class oscillatingLinearMotion Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
56 {
57  // Private data
58 
59  //- Amplitude
60  vector amplitude_;
61 
62  //- Radial velocity
63  scalar omega_;
64 
65 
66  // Private Member Functions
67 
68  //- Disallow copy construct
70 
71  //- Disallow default bitwise assignment
72  void operator=(const oscillatingLinearMotion&);
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("oscillatingLinearMotion");
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const dictionary& SBMFCoeffs,
87  const Time& runTime
88  );
89 
90  //- Construct and return a clone
92  {
94  (
96  (
98  time_
99  )
100  );
101  }
102 
103 
104  //- Destructor
105  virtual ~oscillatingLinearMotion();
106 
107 
108  // Member Functions
109 
110  //- Return the solid-body motion transformation septernion
111  virtual septernion transformation() const;
112 
113  //- Update properties from given dictionary
114  virtual bool read(const dictionary& SBMFCoeffs);
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace solidBodyMotionFunctions
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:65
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
TypeName("oscillatingLinearMotion")
Runtime type information.
Base class for defining solid-body motions.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Specialisations of Field<T> for scalar, vector and tensor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
SolidBodyMotionFvMesh 6DoF motion function. Oscillating displacement.
Namespace for OpenFOAM.