axisRotationMotion.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) 2012-2024 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::axisRotationMotion
26 
27 Description
28  Constant velocity rotation around CoG. Similar to rotatingMotion but
29  motion specified as an angular velocity vector.
30 
31 SourceFiles
32  axisRotationMotion.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef axisRotationMotion_H
37 #define axisRotationMotion_H
38 
40 #include "primitiveFields.H"
41 #include "point.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace solidBodyMotionFunctions
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class axisRotationMotion Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
57 {
58  // Private Data
59 
60  //- Origin
61  point origin_;
62 
63  //- Angular velocity
64  vector omega_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("axisRotationMotion");
71 
72 
73  // Constructors
74 
75  //- Construct from components
77  (
78  const dictionary& SBMFCoeffs,
79  const Time& runTime
80  );
81 
82  //- Disallow default bitwise copy construction
83  axisRotationMotion(const axisRotationMotion&) = delete;
84 
85  //- Construct and return a clone
87  {
89  (
91  (
93  time_
94  )
95  );
96  }
97 
98 
99  //- Destructor
100  virtual ~axisRotationMotion();
101 
102 
103  // Member Functions
104 
105  //- Return the solid-body motion transformation septernion
106  virtual septernion transformation() const;
107 
108  //- Update properties from given dictionary
109  virtual bool read(const dictionary& SBMFCoeffs);
110 
111 
112  // Member Operators
113 
114  //- Disallow default bitwise assignment
115  void operator=(const axisRotationMotion&) = delete;
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace solidBodyMotionFunctions
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
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 keyword definitions, which are a keyword followed by any number of values (e....
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.
Constant velocity rotation around CoG. Similar to rotatingMotion but motion specified as an angular v...
TypeName("axisRotationMotion")
Runtime type information.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
void operator=(const axisRotationMotion &)=delete
Disallow default bitwise assignment.
axisRotationMotion(const dictionary &SBMFCoeffs, const Time &runTime)
Construct from components.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.