rotatingMotion.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2026 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  Time varying angular velocity rotation around given axis through given
29  origin.
30 
31 SourceFiles
32  rotatingMotion.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef rotatingMotion_H
37 #define rotatingMotion_H
38 
40 #include "primitiveFields.H"
41 #include "omega1.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace solidBodyMotionFunctions
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class rotatingMotion Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class rotatingMotion
55 :
57 {
58  // Private Data
59 
60  //- Origin of the axis
61  const vector origin_;
62 
63  //- Axis vector
64  const vector axis_;
65 
66  //- Angular velocity
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("rotatingMotion");
74 
75 
76  // Constructors
77 
78  //- Construct from components
80  (
81  const word& name,
82  const dictionary& SBMFCoeffs,
83  const Time& runTime
84  );
85 
86  //- Disallow default bitwise copy construction
87  rotatingMotion(const rotatingMotion&) = delete;
88 
89 
90  //- Construct and return a clone
92  {
94  (
95  new rotatingMotion
96  (
97  name_,
99  time_
100  )
101  );
102  }
103 
104 
105  //- Destructor
106  virtual ~rotatingMotion();
107 
108 
109  // Member Functions
110 
111  //- Return the solid-body motion transformation septernion
112  virtual septernion transformation() const;
113 
114  //- Update properties from given dictionary
115  virtual bool read(const dictionary& SBMFCoeffs);
116 
117 
118  // Member Operators
119 
120  //- Disallow default bitwise assignment
121  void operator=(const rotatingMotion&) = delete;
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace solidBodyMotionFunctions
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
Base class for defining solid-body motions.
Time varying angular velocity rotation around given axis through given origin.
TypeName("rotatingMotion")
Runtime type information.
rotatingMotion(const word &name, const dictionary &SBMFCoeffs, const Time &runTime)
Construct from components.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
void operator=(const rotatingMotion &)=delete
Disallow default bitwise assignment.
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.