sixDoFMotion.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 
26 #include "sixDoFMotion.H"
28 
29 using namespace Foam::constant::mathematical;
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace solidBodyMotionFunctions
36 {
39  (
43  );
44 }
45 }
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const word& name,
53  const dictionary& SBMFCoeffs,
54  const Time& runTime
55 )
56 :
57  solidBodyMotionFunction(name, SBMFCoeffs, runTime)
58 {
59  read(SBMFCoeffs);
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
70 
73 {
74  const scalar t = time_.value();
75 
76  const vector translation = translation_->value(t);
77  const vector rotation = rotation_->value(t);
78 
79  const quaternion R(quaternion::XYZ, rotation);
80  const septernion TR(septernion(-CofG_ - translation)*R*septernion(CofG_));
81 
82  DebugInFunction << "Time = " << t << " transformation: " << TR << endl;
83 
84  return TR;
85 }
86 
87 
89 (
90  const dictionary& SBMFCoeffs
91 )
92 {
94 
95  translation_.reset
96  (
98  (
99  "translation",
100  time_.userUnits(),
101  dimLength,
102  SBMFCoeffs_
103  ).ptr()
104  );
105 
106  rotation_.reset
107  (
109  (
110  "rotation",
111  time_.userUnits(),
113  SBMFCoeffs_
114  ).ptr()
115  );
116 
117  SBMFCoeffs_.lookup("CofG") >> CofG_;
118 
119  return true;
120 }
121 
122 
123 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Run-time selectable general function of one variable.
Definition: Function1.H:62
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.
Tabulated 6DoF motion function.
Definition: sixDoFMotion.H:60
sixDoFMotion(const word &name, const dictionary &SBMFCoeffs, const Time &runTime)
Construct from components.
Definition: sixDoFMotion.C:51
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: sixDoFMotion.C:72
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: sixDoFMotion.C:89
A class for handling words, derived from string.
Definition: word.H:63
#define DebugInFunction
Report an information message using Foam::Info.
mathematical constants.
const unitSet degrees
Namespace for OpenFOAM.
addToRunTimeSelectionTable(polyPatch, mergedCyclicPolyPatch, word)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:288
const dimensionSet & dimLength
Definition: dimensions.C:141
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.
defineTypeNameAndDebug(atmosphericBoundaryLayer, 0)