src/ODE/translationODE/translationODE.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original authors
   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     translationODE
  27
  28 Description
  29     Ordinary differential equation for three degrees of freedom solid
  30     body translation
  31
  32 Author
  33     Hrvoje Jasak
  34     Dubravko Matijasevic
  35
  36 SourceFiles
  37     translationODEI.H
  38     translationODE.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef translationODE_H
  43 #define translationODE_H
  44
  45 #include "ODE.H"
  46 #include "IOdictionary.H"
  47 #include "dimensionedTypes.H"
  48 #include "dimensionedDiagTensor.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class translationODE Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class translationODE
  60 :
  61     public IOdictionary,
  62     public ODE
  63 {
  64     // Private data
  65
  66         // Body data
  67
  68             //- Mass
  69             dimensionedScalar mass_;
  70
  71
  72         // Platform variables
  73
  74             //- Spring equilibrium position for translation
  75             const dimensionedVector xEquilibrium_;
  76
  77             //- Linear spring coeffs
  78             const dimensionedDiagTensor linSpringCoeffs_;
  79
  80             //- Linear damping coeffs
  81             const dimensionedDiagTensor linDampingCoeffs_;
  82
  83
  84         // Body position and rotation variables
  85
  86             //- Displacement relative to spring equilibrium
  87             dimensionedVector Xrel_;
  88
  89             //- Velocity of mass centroid
  90             dimensionedVector U_;
  91
  92             //- Velocity of mass centroid at previous time-step
  93             dimensionedVector Uold_;
  94
  95
  96         // External forces
  97
  98             //- Force driving the motion
  99             dimensionedVector force_;
 100
 101
 102         //- ODE coefficients
 103         scalarField coeffs_;
 104
 105
 106     // Private Member Functions
 107
 108         //- Disallow default bitwise copy construct
 109         translationODE(const translationODE&);
 110
 111         //- Disallow default bitwise assignment
 112         void operator=(const translationODE&);
 113
 114
 115         //- Set ODE coefficients from position and rotation
 116         inline void setCoeffs();
 117
 118
 119         // Variables in relative coordinate system (solved for)
 120
 121             //- Return acceleration in relative coordinate system
 122             //  given current values of relative displacement and velocity
 123             dimensionedVector A
 124             (
 125                 const dimensionedVector& xR,
 126                 const dimensionedVector& uR
 127             ) const;
 128
 129
 130 public:
 131
 132 //     //- Runtime type information
 133 //     TypeName("translationODE");
 134
 135
 136     // Constructors
 137
 138         //- Construct from dictionary
 139         translationODE(const IOobject& io);
 140
 141
 142     // Destructor
 143
 144         virtual ~translationODE();
 145
 146
 147     // Member Functions
 148
 149         //- Return mass
 150         inline const dimensionedScalar& mass() const;
 151
 152
 153         // Variables in relative coordinate system (solved for)
 154
 155             //- Return displacement in relative coordinate system
 156             inline const dimensionedVector& Xrel() const;
 157
 158
 159         // Displacement and rotation in the absolute coordinate system
 160
 161             //- Return position of origin in absolute coordinate system
 162             inline dimensionedVector X() const;
 163
 164             //- Return velocity of origin
 165             inline const dimensionedVector& U() const;
 166
 167             //- Return velocity of origin for the previous time-step
 168             inline const dimensionedVector& Uold() const;
 169
 170             //- Return acceleration of origin
 171             inline dimensionedVector A() const;
 172
 173
 174         // Average motion per time-step
 175
 176             //- Return average velocity of origin
 177             inline dimensionedVector Uaverage() const;
 178
 179
 180         // Force
 181
 182             //- Return force
 183             inline const dimensionedVector& force() const;
 184
 185             //- Return access to force
 186             inline dimensionedVector& force();
 187
 188
 189         // ODE parameters
 190
 191             //- Return number of equations
 192             virtual label nEqns() const
 193             {
 194                 return 6;
 195             }
 196
 197             //- Return reference to interpolation coefficients
 198             virtual scalarField& coeffs()
 199             {
 200                 return coeffs_;
 201             }
 202
 203             //- Return reference to interpolation coefficients
 204             virtual const scalarField& coeffs() const
 205             {
 206                 return coeffs_;
 207             }
 208
 209             //- Return derivatives
 210             virtual void derivatives
 211             (
 212                 const scalar x,
 213                 const scalarField& y,
 214                 scalarField& dydx
 215             ) const;
 216
 217             //- Return Jacobian
 218             virtual void jacobian
 219             (
 220                 const scalar x,
 221                 const scalarField& y,
 222                 scalarField& dfdx,
 223                 scalarSquareMatrix& dfdy
 224             ) const;
 225
 226             //- Update ODE after the solution, advancing by delta
 227             virtual void update(const scalar delta);
 228
 229
 230         //- WriteData member function required by regIOobject
 231         bool writeData(Ostream&) const;
 232
 233
 234     // Ostream operator
 235
 236         friend Ostream& operator<<(Ostream&, const translationODE&);
 237 };
 238
 239
 240 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 241
 242 } // End namespace Foam
 243
 244 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 245
 246 #include "translationODEI.H"
 247
 248 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 249
 250 #endif
 251
 252 // ************************************************************************* //