OpenFOAM
12
The OpenFOAM Foundation
nullJoint.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-2024 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::null
26
27
Description
28
Null joint for the root-body.
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
nullJoint.C
40
41
\*---------------------------------------------------------------------------*/
42
43
#ifndef nullJoint_H
44
#define nullJoint_H
45
46
#include "
joint.H
"
47
48
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49
50
namespace
Foam
51
{
52
namespace
RBD
53
{
54
55
class
rigidBodyModel;
56
57
namespace
joints
58
{
59
60
/*---------------------------------------------------------------------------*\
61
Class null Declaration
62
\*---------------------------------------------------------------------------*/
63
64
class
null
65
:
66
public
joint
67
{
68
69
public
:
70
71
//- Runtime type information
72
TypeName
(
"null"
);
73
74
75
// Constructors
76
77
//- Construct for given model
78
null
(
const
rigidBodyModel
& model);
79
80
//- Construct for given model from dictionary
81
null
(
const
rigidBodyModel
& model,
const
dictionary
&
dict
);
82
83
//- Clone this joint
84
virtual
autoPtr<joint>
clone
()
const
;
85
86
87
//- Destructor
88
virtual
~null
();
89
90
91
// Member Functions
92
93
//- Update the model state for this joint
94
virtual
void
jcalc
95
(
96
joint::XSvc
& J,
97
const
rigidBodyModelState
& state
98
)
const
;
99
};
100
101
102
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103
104
}
// End namespace joints
105
}
// End namespace RBD
106
}
// End namespace Foam
107
108
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110
#endif
111
112
// ************************************************************************* //
Foam::RBD::joint::XSvc
Joint state returned by jcalc.
Definition:
joint.H:124
Foam::RBD::joint
Abstract base-class for all rigid-body joints.
Definition:
joint.H:81
Foam::RBD::joints::null
Null joint for the root-body.
Definition:
nullJoint.H:66
Foam::RBD::joints::null::TypeName
TypeName("null")
Runtime type information.
Foam::RBD::joints::null::~null
virtual ~null()
Destructor.
Definition:
nullJoint.C:77
Foam::RBD::joints::null::clone
virtual autoPtr< joint > clone() const
Clone this joint.
Definition:
nullJoint.C:69
Foam::RBD::joints::null::jcalc
virtual void jcalc(joint::XSvc &J, const rigidBodyModelState &state) const
Update the model state for this joint.
Definition:
nullJoint.C:84
Foam::RBD::rigidBodyModelState
Holds the motion state of rigid-body model.
Definition:
rigidBodyModelState.H:66
Foam::RBD::rigidBodyModel
Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints.
Definition:
rigidBodyModel.H:77
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition:
autoPtr.H:51
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition:
dictionary.H:162
joint.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:214
dict
dictionary dict
Definition:
searchingEngine.H:14
src
rigidBodyMotion
rigidBodyDynamics
joints
null
nullJoint.H
Generated by
1.9.1