sphericalAngularSpring.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::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 
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 
55 :
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
80  (
81  const word& name,
82  const dictionary& sDoFRBMRDict
83  );
84 
85  //- Construct and return a clone
87  {
89  (
90  new sphericalAngularSpring(*this)
91  );
92  }
93 
94 
95  //- Destructor
96  virtual ~sphericalAngularSpring();
97 
98 
99  // Member Functions
100 
101  //- Calculate the restraint position, force and moment.
102  // Global reference frame vectors.
103  virtual void restrain
104  (
105  const sixDoFRigidBodyMotion& motion,
106  vector& restraintPosition,
107  vector& restraintForce,
108  vector& restraintMoment
109  ) const;
110 
111  //- Update properties from given dictionary
112  virtual bool read(const dictionary& sDoFRBMRCoeff);
113 
114  //- Write
115  virtual void write(Ostream&) const;
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace solidBodyMotionFunctions
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
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
Base class for defining restraints for sixDoF motions.
sixDoFRigidBodyMotionRestraints model. Spherical angular spring.
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
const word & name() const
Return the name.
virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone() const
Construct and return a clone.
sphericalAngularSpring(const word &name, const dictionary &sDoFRBMRDict)
Construct from components.
TypeName("sphericalAngularSpring")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Namespace for OpenFOAM.