linearAxialAngularSpring.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::linearAxialAngularSpring
26 
27 Description
28  sixDoFRigidBodyMotionRestraints model. Linear axial angular spring.
29 
30 SourceFiles
31  linearAxialAngularSpring.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef linearAxialAngularSpring_H
36 #define linearAxialAngularSpring_H
37 
39 #include "point.H"
40 #include "tensor.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 namespace sixDoFRigidBodyMotionRestraints
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class linearAxialAngularSpring Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
57 {
58  // Private data
59 
60  //- Reference orientation where there is no moment
61  tensor refQ_;
62 
63  //- Global unit axis around which the motion is sprung
64  vector axis_;
65 
66  //- Spring stiffness coefficient (Nm/rad)
67  scalar stiffness_;
68 
69  //- Damping coefficient (Nms/rad)
70  scalar damping_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("linearAxialAngularSpring");
77 
78 
79  // Constructors
80 
81  //- Construct from components
83  (
84  const word& name,
85  const dictionary& sDoFRBMRDict
86  );
87 
88  //- Construct and return a clone
90  {
92  (
93  new linearAxialAngularSpring(*this)
94  );
95  }
96 
97 
98  //- Destructor
99  virtual ~linearAxialAngularSpring();
100 
101 
102  // Member Functions
103 
104  //- Calculate the restraint position, force and moment.
105  // Global reference frame vectors.
106  virtual void restrain
107  (
108  const sixDoFRigidBodyMotion& motion,
109  vector& restraintPosition,
110  vector& restraintForce,
111  vector& restraintMoment
112  ) const;
113 
114  //- Update properties from given dictionary
115  virtual bool read(const dictionary& sDoFRBMRCoeff);
116 
117  //- Write
118  virtual void write(Ostream&) const;
119 };
120 
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 } // End namespace solidBodyMotionFunctions
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
virtual void restrain(const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const
Calculate the restraint position, force and moment.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
sixDoFRigidBodyMotionRestraints model. Linear axial angular spring.
Base class for defining restraints for sixDoF motions.
virtual bool read(const dictionary &sDoFRBMRCoeff)
Update properties from given dictionary.
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:53
TypeName("linearAxialAngularSpring")
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.
linearAxialAngularSpring(const word &name, const dictionary &sDoFRBMRDict)
Construct from components.
Namespace for OpenFOAM.