Forward compatibility: flex
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / solidBodyMotion / translation / translation.C
blob132453536c692cb61a9a7621d1649b52f6367df2
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 \*---------------------------------------------------------------------------*/
26 #include "translation.H"
27 #include "addToRunTimeSelectionTable.H"
28 #include "mathematicalConstants.H"
30 using namespace Foam::mathematicalConstant;
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 namespace Foam
36 namespace solidBodyMotionFunctions
38     defineTypeNameAndDebug(translation, 0);
39     addToRunTimeSelectionTable
40     (
41         solidBodyMotionFunction,
42         translation,
43         dictionary
44     );
49 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
51 Foam::scalar
52 Foam::solidBodyMotionFunctions::translation::rampFactor() const
54     const scalar t = time_.value();
56     if (t < rampTime_)
57     {
58         // Ramping region
59         return sin(pi/(2*rampTime_)*t);
60     }
61     else
62     {
63         // Past ramping region
64         return 1;
65     }
69 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
71 Foam::solidBodyMotionFunctions::translation::translation
73     const dictionary& SBMFCoeffs,
74     const Time& runTime
77     solidBodyMotionFunction(SBMFCoeffs, runTime),
78     velocity_(SBMFCoeffs_.lookup("velocity")),
79     rampTime_(readScalar(SBMFCoeffs_.lookup("rampTime")))
81     if (rampTime_ < 0)
82     {
83         FatalIOErrorIn
84         (
85             "solidBodyMotionFunctions::translation::translation",
86             SBMFCoeffs_
87         )   << "Negative rampTime not allowed."
88             << abort(FatalIOError);
89     }
93 // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * * //
95 Foam::solidBodyMotionFunctions::translation::~translation()
99 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
101 Foam::septernion
102 Foam::solidBodyMotionFunctions::translation::transformation() const
104     const scalar t = time_.value();
106     septernion TR;
108     if (t < rampTime_)
109     {
110         // Ramping region
111         // Account for ramping using analytical integration from ramped velocity
112         // distribution in this region
113         TR = septernion
114         (
115             velocity_*2*rampTime_/pi*(1 - cos(pi/(2*rampTime_)*t)),
116             quaternion::I
117         );
118     }
119     else
120     {
121         // Past ramping region
122         TR = septernion
123         (
124             velocity_*
125             (
126                 // Displacement during the ramping region
127                 2*rampTime_/pi
128                 // Displacement during constant velocity after ramping region
129               + (t - rampTime_)
130             ),
131             quaternion::I
132         );
133     }
135     Info<< "solidBodyMotionFunctions::translation::transformation(): "
136         << "Time = " << t << " velocity = " << rampFactor()*velocity_
137         << " transformation = " << TR
138         << endl;
140     return TR;
144 Foam::septernion
145 Foam::solidBodyMotionFunctions::translation::velocity() const
147     septernion TV
148     (
149         rampFactor()*velocity_,
150         quaternion::I/time_.deltaT().value()
151     );
153     Info<< "solidBodyMotionFunctions::translation::transformation(): "
154         << "Time = " << time_.value() << " velocity: " << TV << endl;
156     return TV;
160 bool Foam::solidBodyMotionFunctions::translation::read
162     const dictionary& SBMFCoeffs
165     solidBodyMotionFunction::read(SBMFCoeffs);
167     rampTime_ = readScalar(SBMFCoeffs_.lookup("rampTime"));
169     return true;
173 // ************************************************************************* //