tabulatedAxialAngularSpring.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2013 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 
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 
57 :
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
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
90  (
91  const word& name,
92  const dictionary& sDoFRBMRDict
93  );
94 
95  //- Construct and return a clone
97  {
99  (
100  new tabulatedAxialAngularSpring(*this)
101  );
102  }
103 
104 
105  //- Destructor
107 
108 
109  // Member Functions
110 
111  //- Calculate the restraint position, force and moment.
112  // Global reference frame vectors.
113  virtual void restrain
114  (
115  const sixDoFRigidBodyMotion& motion,
116  vector& restraintPosition,
117  vector& restraintForce,
118  vector& restraintMoment
119  ) const;
120 
121  //- Update properties from given dictionary
122  virtual bool read(const dictionary& sDoFRBMRCoeff);
123 
124  //- Write
125  virtual void write(Ostream&) const;
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace solidBodyMotionFunctions
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
A class for handling words, derived from string.
Definition: word.H:59
Base class for defining restraints for sixDoF motions.
sixDoFRigidBodyMotionRestraints model. Axial angular spring with moment values drawn from an interpol...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
tabulatedAxialAngularSpring(const word &name, const dictionary &sDoFRBMRDict)
Construct from components.
TypeName("tabulatedAxialAngularSpring")
Runtime type information.
virtual void restrain(const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const
Calculate the restraint position, force and moment.
virtual bool read(const dictionary &sDoFRBMRCoeff)
Update properties from given dictionary.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Six degree of freedom motion for a rigid body.
const word & name() const
Return the name.
virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone() const
Construct and return a clone.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117