Merge remote-tracking branch 'origin/nr/multiSolverFix' into nextRelease
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / solidBodyMotion / linearOscillation / linearOscillation.C
blob405d09ed3eab4f9bacadbf479de15d19fc6dab80
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 \*---------------------------------------------------------------------------*/
27 #include "linearOscillation.H"
28 #include "addToRunTimeSelectionTable.H"
29 #include "mathematicalConstants.H"
31 using namespace Foam::mathematicalConstant;
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 namespace Foam
37 namespace solidBodyMotionFunctions
39     defineTypeNameAndDebug(linearOscillation, 0);
40     addToRunTimeSelectionTable
41     (
42         solidBodyMotionFunction,
43         linearOscillation,
44         dictionary
45     );
50 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
52 Foam::vector
53 Foam::solidBodyMotionFunctions::linearOscillation::calcPosition
55     const scalar t
56 ) const
58     return amplitude_*sin(2*pi*t/period_);
62 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
64 Foam::solidBodyMotionFunctions::linearOscillation::linearOscillation
66     const dictionary& SBMFCoeffs,
67     const Time& runTime
70     solidBodyMotionFunction(SBMFCoeffs, runTime),
71     amplitude_(SBMFCoeffs_.lookup("amplitude")),
72     period_(readScalar(SBMFCoeffs_.lookup("period")))
76 // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * * //
78 Foam::solidBodyMotionFunctions::linearOscillation::~linearOscillation()
82 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
84 Foam::septernion
85 Foam::solidBodyMotionFunctions::linearOscillation::transformation() const
87     scalar t = time_.value();
89     septernion TR(calcPosition(t), quaternion::I);
91     Info<< "solidBodyMotionFunctions::linearOscillation::transformation(): "
92         << "Time = " << t << " transformation: " << TR << endl;
94     return TR;
98 Foam::septernion
99 Foam::solidBodyMotionFunctions::linearOscillation::velocity() const
101     scalar t = time_.value();
102     scalar dt = time_.deltaT().value();
104     septernion TV
105     (
106         (calcPosition(t + dt) - calcPosition(t))/dt,
107         quaternion::zero
108     );
110     return TV;
114 bool Foam::solidBodyMotionFunctions::linearOscillation::read
116     const dictionary& SBMFCoeffs
119     solidBodyMotionFunction::read(SBMFCoeffs);
121     SBMFCoeffs_.lookup("amplitude") >> amplitude_;
122     SBMFCoeffs_.lookup("amplitude") >> period_;
124     return true;
128 // ************************************************************************* //