src/ODE/sixDOF/sixDOFqODE/sixDOFqODE.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     sixDOFqODE
  26
  27 Description
  28     6-DOF solver using quaternions
  29
  30 Author
  31     Dubravko Matijasevic, FSB Zagreb.  All rights reserved.
  32     Updated by Hrvoje Jasak.
  33
  34 SourceFiles
  35     sixDOFqODEI.H
  36     sixDOFqODE.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef sixDOFqODE_H
  41 #define sixDOFqODE_H
  42
  43 #include "ODE.H"
  44 #include "IOdictionary.H"
  45 #include "dimensionedTypes.H"
  46 #include "HamiltonRodriguezRot.H"
  47 #include "finiteRotation.H"
  48 #include "vectorField.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                          Class sixDOFqODE Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class sixDOFqODE
  60 :
  61     public IOdictionary,
  62     public ODE
  63 {
  64     // Private data
  65
  66         // Body data
  67
  68             //- Mass
  69             dimensionedScalar mass_;
  70
  71             //- Rotational moment of inertia around centre of mass
  72             //  in body (relative) coordinates - aligned with main axes
  73             dimensionedDiagTensor momentOfInertia_;
  74
  75
  76         // Platform variables
  77
  78             //- Spring equilibrium position for translation
  79             dimensionedVector Xequilibrium_;
  80
  81             //- Linear spring coeffs
  82             dimensionedDiagTensor linSpringCoeffs_;
  83
  84             //- Linear damping coeffs
  85             dimensionedDiagTensor linDampingCoeffs_;
  86
  87
  88         // Initial body state variables
  89
  90             //- Displacement relative to spring equilibrium
  91             dimensionedVector Xrel_;
  92
  93             //- Velocity of mass centroid
  94             dimensionedVector U_;
  95
  96             //- Average velocity of mass centroid at previous time-step
  97             dimensionedVector Uaverage_;
  98
  99             //- Finite rotation
 100             finiteRotation rotation_;
 101
 102             //- Rotational velocity about mass centroid
 103             dimensionedVector omega_;
 104
 105
 106         // Average variables that need to be stored
 107
 108             //- Average rotational velocity in relative coordinate system
 109             dimensionedVector omegaAverage_;
 110
 111             //- Average rotational velocity in absolute coordinate system
 112             dimensionedVector omegaAverageAbsolute_;
 113
 114
 115         // External forces
 116
 117             //- Force driving the motion in inertial coord. sys.
 118             dimensionedVector force_;
 119
 120             //- Moment driving the motion in inertial coord. sys.
 121             dimensionedVector moment_;
 122
 123             //- Force driving the motion in relative coord. sys.
 124             dimensionedVector forceRelative_;
 125
 126             //- Moment driving the motion in relative coord. sys.
 127             dimensionedVector momentRelative_;
 128
 129
 130         //- ODE coefficients
 131         scalarField coeffs_;
 132
 133
 134         //- Motion constraints (given as fixed motion components)
 135
 136             //- Fixed surge (x-translation)
 137             Switch fixedSurge_;
 138
 139             //- Fixed sway (y-translation)
 140             Switch fixedSway_;
 141
 142             //- Fixed heave (z-translation)
 143             Switch fixedHeave_;
 144
 145             //- Fixed roll (rotation around x)
 146             Switch fixedRoll_;
 147
 148             //- Fixed pitch (rotation around y)
 149             Switch fixedPitch_;
 150
 151             //- Fixed yaw (rotation around z)
 152             Switch fixedYaw_;
 153
 154             //- Restraints in referent coordinate system
 155             Switch referentMotionConstraints_;
 156
 157             //- Rotation of referent coordinate system
 158             HamiltonRodriguezRot referentRotation_;
 159
 160
 161     // Private Member Functions
 162
 163         //- Disallow default bitwise copy construct
 164         sixDOFqODE(const sixDOFqODE&);
 165
 166         //- Disallow default bitwise assignment
 167         void operator=(const sixDOFqODE&);
 168
 169
 170         //- Set ODE coefficients from position and rotation
 171         void setCoeffs();
 172
 173
 174         // Variables in relative coordinate system (solved for)
 175
 176             //- Return acceleration in relative coordinate system
 177             //  given current values of relative displacement and velocity
 178             dimensionedVector A
 179             (
 180                 const dimensionedVector& xR,
 181                 const dimensionedVector& uR,
 182                 const HamiltonRodriguezRot& rotation
 183             ) const;
 184
 185
 186             //- Return rotational acceleration in relative coordinate system
 187             //  given current values for relative rotational velocity
 188             dimensionedVector OmegaDot
 189             (
 190                 const HamiltonRodriguezRot& rotation,
 191                 const dimensionedVector& omega
 192             ) const;
 193
 194             //- Return the Euler part of moment equation
 195             dimensionedVector E
 196             (
 197                 const dimensionedVector& omega
 198             ) const;
 199
 200             //- Constrain rotation vector in referent or global coordinate
 201             //  system
 202             void constrainRotation(vector& vec) const;
 203
 204             //- Constrain translation vector in referent or global coordinate
 205             //  system
 206             void constrainTranslation(vector& vec) const;
 207
 208
 209 public:
 210
 211     // Constructors
 212
 213         //- Construct from dictionary
 214         sixDOFqODE(const IOobject& io);
 215
 216         //- Construct sixDOFqODE, changing name
 217         sixDOFqODE
 218         (
 219             const word& name,
 220             const sixDOFqODE& sd
 221         );
 222
 223
 224     // Destructor
 225
 226         virtual ~sixDOFqODE();
 227
 228
 229     // Member Functions
 230
 231         //- Return mass
 232         inline const dimensionedScalar& mass() const;
 233
 234         //- Return access to mass
 235         inline dimensionedScalar& mass();
 236
 237         //- Return moment of inertia
 238         inline const dimensionedDiagTensor& momentOfInertia() const;
 239
 240         //- Return access to moment of inertia
 241         inline dimensionedDiagTensor& momentOfInertia();
 242
 243         //- Return equilibrium position of origin
 244         inline const dimensionedVector& Xequilibrium() const;
 245
 246         //- Return access to equilibrium position of origin
 247         inline dimensionedVector& Xequilibrium();
 248
 249
 250         // Variables in relative coordinate system (solved for)
 251
 252             //- Return displacement in translated coordinate system
 253             //  relative to spring equilibrium
 254             inline const dimensionedVector& Xrel() const;
 255
 256             //- Return rotational velocity in relative coordinate system
 257             inline const dimensionedVector& omega() const;
 258
 259             //- Return rotational acceleration in relative coordinate system
 260             inline dimensionedVector omegaDot() const;
 261
 262
 263         // Displacement and rotation in the absolute coordinate system
 264
 265             //- Return position of origin in absolute coordinate system
 266             inline dimensionedVector X() const;
 267
 268             //- Return velocity of origin
 269             inline const dimensionedVector& U() const;
 270
 271             //- Return average velocity of origin for the previous time-step
 272             inline const dimensionedVector& Uaverage() const;
 273
 274             //- Return finite rotation
 275             inline const finiteRotation& rotation() const;
 276
 277             //- Return acceleration of origin
 278             inline dimensionedVector A() const;
 279
 280             //- Return rotational vector of body
 281             inline vector rotVector() const;
 282
 283             //- Return rotation angle of body
 284             inline dimensionedScalar rotAngle() const;
 285
 286
 287         // Non-constant access
 288
 289             //- Set position of origin
 290             inline void setXrel(const vector& x);
 291
 292             //- Set velocity of origin
 293             inline void setU(const vector& u);
 294
 295             //- Set rotational angle in relative
 296             //  coordinate system
 297             inline void setRotation(const HamiltonRodriguezRot& rot);
 298
 299             //- Set rotational velocity in relative
 300             //  coordinate system
 301             inline void setOmega(const vector& omega);
 302
 303             //- Set referent coordinate system to apply constraints
 304             inline void setReferentRotation(const HamiltonRodriguezRot& rot);
 305
 306
 307         // Average motion per time-step
 308
 309             //- Return average rotational vector of body
 310             inline vector rotVectorAverage() const;
 311
 312             //- Return average rotational velocity in
 313             //  relative coordinate system
 314             inline const dimensionedVector& omegaAverage() const;
 315
 316             //- Return average rotational velocity in
 317             //  absolute coordinate system
 318             inline const dimensionedVector& omegaAverageAbsolute() const;
 319
 320
 321         // Force and moment
 322
 323             //- Return force in inertial coord. sys.
 324             inline const dimensionedVector& force() const;
 325
 326             //- Return access to force in inertial coord. sys.
 327             inline dimensionedVector& force();
 328
 329             //- Return moment in inertial coord. sys.
 330             inline const dimensionedVector& moment() const;
 331
 332             //- Return access to moment in inertial coord. sys.
 333             inline dimensionedVector& moment();
 334
 335             //- Return force in relative coord. sys.
 336             inline const dimensionedVector& forceRelative() const;
 337
 338             //- Return access to force in relative coord. sys.
 339             inline dimensionedVector& forceRelative();
 340
 341             //- Return moment in relative coord. sys.
 342             inline const dimensionedVector& momentRelative() const;
 343
 344             //- Return access to moment in relative coord. sys.
 345             inline dimensionedVector& momentRelative();
 346
 347
 348             //- Return total force in inertial coord. sys.
 349             inline dimensionedVector forceTotal() const;
 350
 351             //- Return total moment in inertial coord. sys.
 352             inline dimensionedVector momentTotal() const;
 353
 354
 355         // Rotations
 356
 357             //- Return rotation tensor to relative coordinate system
 358             inline tensor toRelative() const;
 359
 360             //- Return rotation tensor to absolute coordinate system
 361             inline tensor toAbsolute() const;
 362
 363             //- Return transformation tensor between new and previous rotation
 364             inline const tensor& rotIncrementTensor() const;
 365
 366             //-  Set ODE parameters from another ODE
 367             void setState(const sixDOFqODE&);
 368
 369
 370         // ODE parameters
 371
 372             //- Return number of equations
 373             virtual label nEqns() const
 374             {
 375                 return 13;
 376             }
 377
 378             //- Return access to coefficients
 379             virtual scalarField& coeffs()
 380             {
 381                 return coeffs_;
 382             }
 383
 384             //- Return reference to coefficients
 385             virtual const scalarField& coeffs() const
 386             {
 387                 return coeffs_;
 388             }
 389
 390             //- Return derivatives
 391             virtual void derivatives
 392             (
 393                 const scalar x,
 394                 const scalarField& y,
 395                 scalarField& dydx
 396             ) const;
 397
 398             //- Return Jacobian
 399             virtual void jacobian
 400             (
 401                 const scalar x,
 402                 const scalarField& y,
 403                 scalarField& dfdx,
 404                 scalarSquareMatrix& dfdy
 405             ) const;
 406
 407             //- Update ODE after the solution, advancing by delta
 408             virtual void update(const scalar delta);
 409
 410
 411         //- WriteData member function required by regIOobject
 412         bool writeData(Ostream&) const;
 413
 414
 415     // Ostream operator
 416
 417         friend Ostream& operator<<(Ostream&, const sixDOFqODE&);
 418 };
 419
 420
 421 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 422
 423 } // End namespace Foam
 424
 425 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 426
 427 #include "sixDOFqODEI.H"
 428
 429 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 430
 431 #endif
 432
 433 // ************************************************************************* //