src/dynamicMesh/meshMotion/solidBodyMotion/graphVelocity/graphVelocity.H

   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.
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::solidBodyMotionFunction::graphVelocity
  27
  28 Description
  29     Prescribed translational and rotational velocity given graphs for surge,
  30     sway, heave, roll, pitch and yaw. Hence, the velocity is given in graphs,
  31     not the motion (trajectory).
  32
  33 SourceFiles
  34     graphVelocity.C
  35
  36 Author
  37     Vuko Vukcevic, FMENA Zagreb.  All rights reserved.
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef graphVelocity_H
  42 #define graphVelocity_H
  43
  44 #include "solidBodyMotionFunction.H"
  45 #include "graph.H"
  46 #include "primitiveFields.H"
  47 #include "point.H"
  48
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54 namespace solidBodyMotionFunctions
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                          Class graphVelocity Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class graphVelocity
  62 :
  63     public solidBodyMotionFunction
  64 {
  65     // Private data
  66
  67         //- Centre of gravity
  68         point origin_;
  69
  70         //- Integrated translation
  71         mutable vector translation_;
  72
  73         //- Integrated rotation
  74         mutable vector rotation_;
  75
  76         //- Integrated old translation
  77         mutable vector translationOld_;
  78
  79         //- Integrated old rotation
  80         mutable vector rotationOld_;
  81
  82         //- Time index, avoid integrating more than once per time step
  83         mutable label localTimeIndex_;
  84
  85
  86         // Prescribed translation members
  87
  88             // - Graph for surge translational velocity (x-translation)
  89             graph surge_;
  90
  91             // - Graph for sway translational velocity (y-translation)
  92             graph sway_;
  93
  94             // - Graph for heave translational motion (z-translation)
  95             graph heave_;
  96
  97
  98         // Prescribed rotation members
  99
 100             // - Graph for roll rotational velocity (x-rotation)
 101             graph roll_;
 102
 103             // - Graph for pitch rotational velocity (y-rotation)
 104             graph pitch_;
 105
 106             // - Graph for yaw rotational velocity (z-rotation)
 107             graph yaw_;
 108
 109             //- Is the rotational velocity given in degrees/sec
 110             Switch inDegrees_;
 111
 112
 113         //- Member functions
 114
 115             //- Return translational velocity vector
 116             vector translationalVelocity() const;
 117
 118             // -Return rotational velocity vector
 119             vector rotationalVelocity() const;
 120
 121             //- Calculate transformation septernion
 122             septernion calcTransformation() const;
 123
 124
 125 public:
 126
 127     //- Runtime type information
 128     TypeName("graphVelocity");
 129
 130
 131     // Constructors
 132
 133         //- Construct from components
 134         graphVelocity
 135         (
 136             const dictionary& SBMFCoeffs,
 137             const Time& runTime
 138         );
 139
 140
 141     //- Destructor
 142     virtual ~graphVelocity()
 143     {}
 144
 145
 146     // Member Functions
 147
 148         //- Return the solid-body motion transformation septernion
 149         virtual septernion transformation() const;
 150
 151             //- Return the solid-body motion velocity
 152         virtual septernion velocity() const;
 153
 154         //- Update properties from given dictionary
 155         virtual bool read(const dictionary& SBMFCoeffs);
 156 };
 157
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 } // End namespace solidBodyMotionFunctions
 162 } // End namespace Foam
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //