oscillatingLinearMotion.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
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.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace solidBodyMotionFunctions
34 {
37  (
41  );
42 }
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 (
50  const word& name,
51  const dictionary& SBMFCoeffs,
52  const Time& runTime
53 )
54 :
55  solidBodyMotionFunction(name, SBMFCoeffs, runTime)
56 {
57  read(SBMFCoeffs);
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
65 {}
66 
67 
68 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
69 
72 {
73  scalar t = time_.value();
74 
75  const vector displacement = amplitude_*sin(omega_*t);
76 
77  quaternion R(1);
78  septernion TR(septernion(-displacement)*R);
79 
80  DebugInFunction << "Time = " << t << " transformation: " << TR << endl;
81 
82  return TR;
83 }
84 
85 
87 (
88  const dictionary& SBMFCoeffs
89 )
90 {
92 
93  SBMFCoeffs_.lookup("amplitude") >> amplitude_;
94  SBMFCoeffs_.lookup("omega") >> omega_;
95 
96  return true;
97 }
98 
99 
100 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Quaternion class used to perform rotations in 3D space.
Definition: quaternion.H:61
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
Base class for defining solid-body motions.
virtual bool read(const dictionary &dict)=0
Update properties from given dictionary.
SolidBodyMotionFvMesh 6DoF motion function. Oscillating displacement.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
oscillatingLinearMotion(const word &name, const dictionary &SBMFCoeffs, const Time &runTime)
Construct from components.
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
A class for handling words, derived from string.
Definition: word.H:63
#define DebugInFunction
Report an information message using Foam::Info.
addToRunTimeSelectionTable(solidBodyMotionFunction, multiValveEnginePistonMotion, dictionary)
defineTypeNameAndDebug(multiValveEnginePistonMotion, 0)
Namespace for OpenFOAM.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:288
dimensionedScalar sin(const dimensionedScalar &ds)
static scalar R(const scalar a, const scalar x)
Definition: invIncGamma.C:102
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.