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 Copyright (C) 2020 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::solidBodyMotionFunctions::oscillatingRotatingMotion
29
30Description
31 SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
32
33SourceFiles
34 oscillatingRotatingMotion.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef oscillatingRotatingMotion_H
39#define oscillatingRotatingMotion_H
40
42#include "primitiveFields.H"
43#include "point.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49namespace solidBodyMotionFunctions
50{
51
52/*---------------------------------------------------------------------------*\
53 Class oscillatingRotatingMotion Declaration
54\*---------------------------------------------------------------------------*/
57:
59{
60 // Private Data
61
62 //- Centre of gravity
63 point origin_;
64
65 //- Amplitude
66 vector amplitude_;
67
68 //- Radial velocity
69 scalar omega_;
70
71
72 // Private Member Functions
73
74 //- No copy construct
76
77 //- No copy assignment
78 void operator=(const oscillatingRotatingMotion&) = delete;
79
80
81public:
82
83 //- Runtime type information
84 TypeName("oscillatingRotatingMotion");
85
86
87 // Constructors
88
89 //- Construct from components
91 (
92 const dictionary& SBMFCoeffs,
93 const Time& runTime
94 );
95
96 //- Construct and return a clone
98 {
100 (
102 (
104 time_
105 )
106 );
107 }
108
109
110 //- Destructor
111 virtual ~oscillatingRotatingMotion() = default;
112
113
114 // Member Functions
115
116 //- Return the solid-body motion transformation septernion
117 virtual septernion transformation() const;
118
119 //- Update properties from given dictionary
120 virtual bool read(const dictionary& SBMFCoeffs);
121};
122
123
124// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126} // End namespace solidBodyMotionFunctions
127} // End namespace Foam
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131#endif
132
133// ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:67
Base class for defining solid-body motions.
SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation.
TypeName("oscillatingRotatingMotion")
Runtime type information.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
engineTime & runTime
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73