Rz.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) 2016-2018 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::RBD::joints::Rz
26 
27 Description
28  Revolute joint for rotation about the z-axis
29 
30  Reference:
31  \verbatim
32  Featherstone, R. (2008).
33  Rigid body dynamics algorithms.
34  Springer.
35  Chapter 4.
36  \endverbatim
37 
38 SourceFiles
39  Rz.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef RBD_joints_Rz_H
44 #define RBD_joints_Rz_H
45 
46 #include "joint.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace RBD
53 {
54 namespace joints
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class Rz Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 class Rz
62 :
63  public joint
64 {
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("Rz");
70 
71 
72  // Constructors
73 
74  //- Construct for given model
75  Rz(const rigidBodyModel& model);
76 
77  //- Construct for given model from dictionary
78  Rz(const rigidBodyModel& model, const dictionary& dict);
79 
80  //- Clone this joint
81  virtual autoPtr<joint> clone() const;
82 
83 
84  //- Destructor
85  virtual ~Rz();
86 
87 
88  // Member Functions
89 
90  //- Update the model state for this joint
91  virtual void jcalc
92  (
93  joint::XSvc& J,
94  const rigidBodyModelState& state
95  ) const;
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace joints
102 } // End namespace RBD
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Abstract base-class for all rigid-body joints.
Definition: joint.H:80
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
Revolute joint for rotation about the z-axis.
Definition: Rz.H:60
Holds the motion state of rigid-body model.
Joint state returned by jcalc.
Definition: joint.H:123
TypeName("Rz")
Runtime type information.
virtual ~Rz()
Destructor.
Definition: Rz.C:77
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints...
virtual void jcalc(joint::XSvc &J, const rigidBodyModelState &state) const
Update the model state for this joint.
Definition: Rz.C:84
Rz(const rigidBodyModel &model)
Construct for given model.
Definition: Rz.C:53
virtual autoPtr< joint > clone() const
Clone this joint.
Definition: Rz.C:69
Namespace for OpenFOAM.