axisRotationMotion.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2016 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::solidBodyMotionFunctions::axisRotationMotion
29 
30 Description
31  Constant velocity rotation around CoG. Similar to rotatingMotion but
32  motion specified as rotation vector.
33 
34 SourceFiles
35  axisRotationMotion.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef axisRotationMotion_H
40 #define axisRotationMotion_H
41 
43 #include "primitiveFields.H"
44 #include "point.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace solidBodyMotionFunctions
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class axisRotationMotion Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
60 {
61  // Private Data
62 
63  //- Origin
64  point origin_;
65 
66  //- Rotational velocity (deg/s)
67  vector radialVelocity_;
68 
69 
70  // Private Member Functions
71 
72  //- No copy construct
73  axisRotationMotion(const axisRotationMotion&) = delete;
74 
75  //- No copy assignment
76  void operator=(const axisRotationMotion&) = delete;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("axisRotationMotion");
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const dictionary& SBMFCoeffs,
91  const Time& runTime
92  );
93 
94  //- Construct and return a clone
96  {
98  (
100  (
101  SBMFCoeffs_,
102  time_
103  )
104  );
105  }
106 
107 
108  //- Destructor
109  virtual ~axisRotationMotion() = default;
110 
111 
112  // Member Functions
113 
114  //- Return the solid-body motion transformation septernion
115  virtual septernion transformation() const;
116 
117  //- Update properties from given dictionary
118  virtual bool read(const dictionary& SBMFCoeffs);
119 };
120 
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 } // End namespace solidBodyMotionFunctions
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
solidBodyMotionFunction.H
Foam::septernion
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
point.H
Foam::solidBodyMotionFunctions::axisRotationMotion::TypeName
TypeName("axisRotationMotion")
Runtime type information.
primitiveFields.H
Specialisations of Field<T> for scalar, vector and tensor.
Foam::solidBodyMotionFunctions::axisRotationMotion::read
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: axisRotationMotion.C:91
Foam::solidBodyMotionFunctions::axisRotationMotion
Constant velocity rotation around CoG. Similar to rotatingMotion but motion specified as rotation vec...
Definition: axisRotationMotion.H:56
Foam::solidBodyMotionFunctions::axisRotationMotion::clone
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
Definition: axisRotationMotion.H:94
Foam::solidBodyMotionFunction::SBMFCoeffs_
dictionary SBMFCoeffs_
Definition: solidBodyMotionFunction.H:69
Foam::solidBodyMotionFunctions::axisRotationMotion::transformation
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: axisRotationMotion.C:68
Foam::solidBodyMotionFunction
Base class for defining solid-body motions.
Definition: solidBodyMotionFunction.H:63
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::solidBodyMotionFunctions::axisRotationMotion::~axisRotationMotion
virtual ~axisRotationMotion()=default
Destructor.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::Vector< scalar >
Foam::solidBodyMotionFunction::time_
const Time & time_
Definition: solidBodyMotionFunction.H:71