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