axialAngularSpring.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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::axialAngularSpring
26 
27 Description
28  Axial angular spring with moment values obtained from a Function1 and
29  linear damping.
30 
31 SourceFiles
32  axialAngularSpring.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef axialAngularSpring_H
37 #define axialAngularSpring_H
38 
40 #include "point.H"
41 #include "tensor.H"
42 #include "Table.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 namespace sixDoFRigidBodyMotionRestraints
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class axialAngularSpring 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 as a function of angle
70 
71  //- Boolean stating whether the angle around the axis needs to
72  // be converted to degrees before evaluating the moment function
73  bool convertToDegrees_;
74 
75  //- Damping coefficient (Nms/rad)
76  scalar damping_;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("axialAngularSpring");
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const word& name,
91  const dictionary& sDoFRBMRDict
92  );
93 
94  //- Construct and return a clone
96  {
98  (
99  new axialAngularSpring(*this)
100  );
101  }
102 
103 
104  //- Destructor
105  virtual ~axialAngularSpring();
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 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual bool read(const dictionary &sDoFRBMRCoeff)
Update properties from given dictionary.
Base class for defining restraints for sixDoF motions.
axialAngularSpring(const word &name, const dictionary &sDoFRBMRDict)
Construct from components.
virtual void restrain(const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const
Calculate the restraint position, force and moment.
Axial angular spring with moment values obtained from a Function1 and linear damping.
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
TypeName("axialAngularSpring")
Runtime type information.
const word & name() const
Return the name.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone() const
Construct and return a clone.
Namespace for OpenFOAM.