Forward compatibility: flex
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / solidBodyMotion / rotatingOscillation / rotatingOscillation.H
blob16decb950a210abf812e02a3c0208d0b7fe9a946
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::solidBodyMotionFunctions::rotatingOscillation
27 Description
28     Rotating oscillation motion function
30 SourceFiles
31     rotatingOscillation.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef rotatingOscillation_H
36 #define rotatingOscillation_H
38 #include "solidBodyMotionFunction.H"
39 #include "primitiveFields.H"
40 #include "point.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace solidBodyMotionFunctions
49 /*---------------------------------------------------------------------------*\
50                           Class rotatingOscillation Declaration
51 \*---------------------------------------------------------------------------*/
53 class rotatingOscillation
55     public solidBodyMotionFunction
57     // Private data
59         //- Centre of gravity
60         point origin_;
62         //- Amplitude
63         vector amplitude_;
65         //- Motion period
66         scalar period_;
69     // Private Member Functions
71         //- Disallow copy construct
72         rotatingOscillation(const rotatingOscillation&);
74         //- Disallow default bitwise assignment
75         void operator=(const rotatingOscillation&);
78         //- Calculate position
79         vector calcPosition(const scalar t) const;
81         //- Calculate tranformation
82         septernion calcTransformation(const scalar t) const;
85 public:
87     //- Runtime type information
88     TypeName("rotatingOscillation");
91     // Constructors
93         //- Construct from components
94         rotatingOscillation
95         (
96             const dictionary& SBMFCoeffs,
97             const Time& runTime
98         );
100  /*       //- Construct and return a clone
101         virtual autoPtr<solidBodyMotionFunction> clone() const
102         {
103             return autoPtr<solidBodyMotionFunction>
104             (
105                 new rotatingOscillation
106                 (
107                     SBMFCoeffs_,
108                     time_
109                 )
110             );
111         }
114     //- Destructor
115     virtual ~rotatingOscillation();
118     // Member Functions
120         //- Return the solid-body motion transformation septernion
121         virtual septernion transformation() const;
123         //- Return the solid-body motion velocity
124         virtual septernion velocity() const;
126         //- Update properties from given dictionary
127         virtual bool read(const dictionary& SBMFCoeffs);
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 } // End namespace solidBodyMotionFunctions
134 } // End namespace Foam
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 #endif
140 // ************************************************************************* //