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

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