rotatingMotion.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::rotatingMotion
26 
27 Description
28  SolidBodyMotionFvMesh 6DoF motion function.
29 
30  The rotation is defined by an origin and axis of rotation and an angular
31  speed.
32 
33 SourceFiles
34  rotatingMotion.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef rotatingMotion_H
39 #define rotatingMotion_H
40 
42 #include "primitiveFields.H"
43 #include "point.H"
44 #include "Function1.H"
45 #include "autoPtr.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 namespace solidBodyMotionFunctions
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class rotatingMotion Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class rotatingMotion
59 :
61 {
62  // Private data
63 
64  //- Origin of the axis
65  const vector origin_;
66 
67  //- Axis vector
68  const vector axis_;
69 
70  //- Angular velocty (rad/sec)
72 
73 
74  // Private Member Functions
75 
76  //- Disallow copy construct
78 
79  //- Disallow default bitwise assignment
80  void operator=(const rotatingMotion&);
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("rotatingMotion");
87 
88 
89  // Constructors
90 
91  //- Construct from components
93  (
94  const dictionary& SBMFCoeffs,
95  const Time& runTime
96  );
97 
98  //- Construct and return a clone
100  {
102  (
103  new rotatingMotion
104  (
105  SBMFCoeffs_,
106  time_
107  )
108  );
109  }
110 
111 
112  //- Destructor
113  virtual ~rotatingMotion();
114 
115 
116  // Member Functions
117 
118  //- Return the solid-body motion transformation septernion
119  virtual septernion transformation() const;
120 
121  //- Update properties from given dictionary
122  virtual bool read(const dictionary& SBMFCoeffs);
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace solidBodyMotionFunctions
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
SolidBodyMotionFvMesh 6DoF motion function.
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 bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Base class for defining solid-body motions.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
TypeName("rotatingMotion")
Runtime type information.
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:53
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Namespace for OpenFOAM.