src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/tabulatedAxialAngularSpring/tabulatedAxialAngularSpring.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 Class
  25     Foam::sixDoFRigidBodyMotionRestraints::tabulatedAxialAngularSpring
  26
  27 Description
  28     sixDoFRigidBodyMotionRestraints model.  Axial angular spring with moment
  29     values drawn from an interpolation table.  Linear damping.
  30
  31 SourceFiles
  32     tabulatedAxialAngularSpring.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef tabulatedAxialAngularSpring_H
  37 #define tabulatedAxialAngularSpring_H
  38
  39 #include "sixDoFRigidBodyMotionRestraint.H"
  40 #include "point.H"
  41 #include "tensor.H"
  42 #include "interpolationTable.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 namespace sixDoFRigidBodyMotionRestraints
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                   Class tabulatedAxialAngularSpring Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class tabulatedAxialAngularSpring
  57 :
  58     public sixDoFRigidBodyMotionRestraint
  59 {
  60     // Private data
  61
  62         //- Reference orientation where there is no moment
  63         tensor refQ_;
  64
  65         //- Global unit axis around which the motion is sprung
  66         vector axis_;
  67
  68         //- Spring moment interpolation table, depending on angleFormat
  69         interpolationTable<scalar> moment_;
  70
  71         //- Boolean stating whether the angle around the axis needs to
  72         //  be converted to degrees before asking the
  73         //  interpolationTable for a moment value
  74         bool convertToDegrees_;
  75
  76         //- Damping coefficient (Nms/rad)
  77         scalar damping_;
  78
  79
  80 public:
  81
  82     //- Runtime type information
  83     TypeName("tabulatedAxialAngularSpring");
  84
  85
  86     // Constructors
  87
  88         //- Construct from components
  89         tabulatedAxialAngularSpring
  90         (
  91             const dictionary& sDoFRBMRDict
  92         );
  93
  94         //- Construct and return a clone
  95         virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone() const
  96         {
  97             return autoPtr<sixDoFRigidBodyMotionRestraint>
  98             (
  99                 new tabulatedAxialAngularSpring(*this)
 100             );
 101         }
 102
 103
 104     //- Destructor
 105     virtual ~tabulatedAxialAngularSpring();
 106
 107
 108     // Member Functions
 109
 110         //- Calculate the restraint position, force and moment.
 111         //  Global reference frame vectors.
 112         virtual void restrain
 113         (
 114             const sixDoFRigidBodyMotion& motion,
 115             vector& restraintPosition,
 116             vector& restraintForce,
 117             vector& restraintMoment
 118         ) const;
 119
 120         //- Update properties from given dictionary
 121         virtual bool read(const dictionary& sDoFRBMRCoeff);
 122
 123         //- Write
 124         virtual void write(Ostream&) const;
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace solidBodyMotionFunctions
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //