drivenLinearMotion.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2019-2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "drivenLinearMotion.H"
30 #include "dimensionedVector.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace solidBodyMotionFunctions
37 {
38  defineTypeNameAndDebug(drivenLinearMotion, 0);
40  (
41  solidBodyMotionFunction,
42  drivenLinearMotion,
43  dictionary
44  );
45 }
46 }
47 
48 
49 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
50 
51 Foam::solidBodyMotionFunctions::drivenLinearMotion::drivenLinearMotion
52 (
53  const dictionary& SBMFCoeffs,
54  const Time& runTime
55 )
56 :
57  solidBodyMotionFunction(SBMFCoeffs, runTime),
58  cOfGdisplacement_(SBMFCoeffs.get<word>("cOfGdisplacement")),
59  CofGdisp_
60  (
61  IOobject
62  (
63  cOfGdisplacement_,
64  time_.timeName(),
65  "uniform",
66  time_,
67  IOobject::READ_IF_PRESENT,
68  IOobject::AUTO_WRITE
69  ),
71  )
72 {
73  read(SBMFCoeffs);
74 }
75 
76 
77 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
78 
81 {
82 
83  DebugInFunction << "displacement :" << CofGdisp_.value() << endl;
84  quaternion R(1);
85  septernion TR(septernion(-CofGdisp_.value())*R);
86 
87  DebugInFunction << "Time = " << time_.value()
88  << " transformation: " << TR << endl;
89 
90  return TR;
91 }
92 
93 
95 (
96  const dictionary& SBMFCoeffs
97 )
98 {
100 
101  return true;
102 }
103 
104 
105 // ************************************************************************* //
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
List of values generated by applying the access operation to each list item.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
engineTime & runTime
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
const dimensionSet dimless
Dimensionless.
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:62
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
Macros for easy insertion into run-time selection tables.
defineTypeNameAndDebug(axisRotationMotion, 0)
word timeName
Definition: getTimeIndex.H:3
Base class for defining solid-body motions.
A class for handling words, derived from Foam::string.
Definition: word.H:63
#define DebugInFunction
Report an information message using Foam::Info.
virtual bool read(const dictionary &SBMFCoeffs)=0
Update properties from given dictionary.
Quaternion class used to perform rotations in 3D space.
Definition: quaternion.H:53
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
#define R(A, B, C, D, E, F, K, M)
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
addToRunTimeSelectionTable(solidBodyMotionFunction, axisRotationMotion, dictionary)
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
Namespace for OpenFOAM.
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:127