oscillatingRotatingMotion.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-2013 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::oscillatingRotatingMotion
26 
27 Description
28  SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
29 
30 SourceFiles
31  oscillatingRotatingMotion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef oscillatingRotatingMotion_H
36 #define oscillatingRotatingMotion_H
37 
39 #include "primitiveFields.H"
40 #include "point.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace solidBodyMotionFunctions
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class oscillatingRotatingMotion Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
56 {
57  // Private data
58 
59  //- Centre of gravity
60  point origin_;
61 
62  //- Amplitude
63  vector amplitude_;
64 
65  //- Radial velocity
66  scalar omega_;
67 
68 
69  // Private Member Functions
70 
71  //- Disallow copy construct
73 
74  //- Disallow default bitwise assignment
75  void operator=(const oscillatingRotatingMotion&);
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("oscillatingRotatingMotion");
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 ~oscillatingRotatingMotion();
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 // ************************************************************************* //
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
TypeName("oscillatingRotatingMotion")
Runtime type information.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
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
Base class for defining solid-body motions.
Specialisations of Field<T> for scalar, vector and tensor.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Namespace for OpenFOAM.