Rzyx.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::RBD::joints::Rzyx
28
29Group
30 grpRigidBodyDynamicsJoints
31
32Description
33 Spherical joint for rotation about the x/y/z-axes using Euler-angles
34 in the order z, y, x.
35
36 Reference:
37 \verbatim
38 Featherstone, R. (2008).
39 Rigid body dynamics algorithms.
40 Springer.
41 Chapter 4.
42 \endverbatim
43
44SourceFiles
45 Rzyx.C
46
47\*---------------------------------------------------------------------------*/
48
49#ifndef RBD_joints_Rzyx_H
50#define RBD_joints_Rzyx_H
51
52#include "joint.H"
53
54// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55
56namespace Foam
57{
58namespace RBD
59{
60namespace joints
61{
62
63/*---------------------------------------------------------------------------*\
64 Class Rzyx Declaration
65\*---------------------------------------------------------------------------*/
67class Rzyx
68:
69 public joint
70{
71
72public:
73
74 //- Runtime type information
75 TypeName("Rzyx");
76
77
78 // Constructors
79
80 //- Construct for given model
81 Rzyx();
82
83 //- Construct for given model from dictionary
84 Rzyx(const dictionary& dict);
85
86 //- Clone this joint
87 virtual autoPtr<joint> clone() const;
88
89
90 //- Destructor
91 virtual ~Rzyx();
92
93
94 // Member Functions
95
96 //- Update the model state for this joint
97 virtual void jcalc
98 (
99 joint::XSvc& J,
100 const scalarField& q,
101 const scalarField& qDot
102 ) const;
103};
104
105
106// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108} // End namespace joints
109} // End namespace RBD
110} // End namespace Foam
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114#endif
115
116// ************************************************************************* //
Joint state returned by jcalc.
Definition: joint.H:125
Abstract base-class for all rigid-body joints.
Definition: joint.H:85
Spherical joint for rotation about the x/y/z-axes using Euler-angles in the order z,...
Definition: Rzyx.H:69
virtual autoPtr< joint > clone() const
Clone this joint.
Definition: Rzyx.C:75
TypeName("Rzyx")
Runtime type information.
virtual void jcalc(joint::XSvc &J, const scalarField &q, const scalarField &qDot) const
Update the model state for this joint.
Definition: Rzyx.C:90
Rzyx()
Construct for given model.
Definition: Rzyx.C:55
virtual ~Rzyx()
Destructor.
Definition: Rzyx.C:83
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73