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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-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::oscillatingRotatingMotion
28 
29 Description
30  SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
31 
32 SourceFiles
33  oscillatingRotatingMotion.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef oscillatingRotatingMotion_H
38 #define oscillatingRotatingMotion_H
39 
41 #include "primitiveFields.H"
42 #include "point.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace solidBodyMotionFunctions
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class oscillatingRotatingMotion Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
58 {
59  // Private data
60 
61  //- Centre of gravity
62  point origin_;
63 
64  //- Amplitude
65  vector amplitude_;
66 
67  //- Radial velocity
68  scalar omega_;
69 
70 
71  // Private Member Functions
72 
73  //- No copy construct
75 
76  //- No copy assignment
77  void operator=(const oscillatingRotatingMotion&) = delete;
78 
79 
80 public:
81 
82  //- Runtime type information
83  TypeName("oscillatingRotatingMotion");
84 
85 
86  // Constructors
87 
88  //- Construct from components
90  (
91  const dictionary& SBMFCoeffs,
92  const Time& runTime
93  );
94 
95  //- Construct and return a clone
97  {
99  (
101  (
102  SBMFCoeffs_,
103  time_
104  )
105  );
106  }
107 
108 
109  //- Destructor
110  virtual ~oscillatingRotatingMotion();
111 
112 
113  // Member Functions
114 
115  //- Return the solid-body motion transformation septernion
116  virtual septernion transformation() const;
117 
118  //- Update properties from given dictionary
119  virtual bool read(const dictionary& SBMFCoeffs);
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace solidBodyMotionFunctions
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
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
Foam::solidBodyMotionFunctions::oscillatingRotatingMotion::clone
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
Definition: oscillatingRotatingMotion.H:95
point.H
Foam::solidBodyMotionFunctions::oscillatingRotatingMotion
SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
Definition: oscillatingRotatingMotion.H:54
primitiveFields.H
Specialisations of Field<T> for scalar, vector and tensor.
Foam::solidBodyMotionFunctions::oscillatingRotatingMotion::read
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: oscillatingRotatingMotion.C:95
Foam::solidBodyMotionFunction::SBMFCoeffs_
dictionary SBMFCoeffs_
Definition: solidBodyMotionFunction.H:68
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::oscillatingRotatingMotion::~oscillatingRotatingMotion
virtual ~oscillatingRotatingMotion()
Destructor.
Definition: oscillatingRotatingMotion.C:68
Foam::solidBodyMotionFunctions::oscillatingRotatingMotion::TypeName
TypeName("oscillatingRotatingMotion")
Runtime type information.
Foam::Vector< scalar >
Foam::solidBodyMotionFunction::time_
const Time & time_
Definition: solidBodyMotionFunction.H:69
Foam::solidBodyMotionFunctions::oscillatingRotatingMotion::transformation
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: oscillatingRotatingMotion.C:76