The open source CFD toolbox
nullJoint.C
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-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
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
26\*---------------------------------------------------------------------------*/
27
28#include "nullJoint.H"
29#include "rigidBodyModel.H"
31
32// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33
34namespace Foam
35{
36namespace RBD
37{
38namespace joints
39{
41
43 (
44 joint,
45 null,
47 );
48}
49}
50}
51
52
53// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
54
56:
57 joint(0)
58{}
59
60
62:
63 joint(0)
64{}
65
66
68{
69 return autoPtr<joint>(new null(*this));
70}
71
72
73// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
74
76{}
77
78
79// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
80
82(
83 joint::XSvc& J,
84 const scalarField& q,
85 const scalarField& qDot
86) const
87{
89 << "Cannot calculate the state of a null-joint"
90 << abort(FatalError);
91}
92
93
94// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Add to construction table with typeName as the key.
Joint state returned by jcalc.
Definition: joint.H:125
Abstract base-class for all rigid-body joints.
Definition: joint.H:85
Null joint for the root-body.
Definition: nullJoint.H:68
virtual ~null()
Destructor.
Definition: nullJoint.C:75
virtual autoPtr< joint > clone() const
Clone this joint.
Definition: nullJoint.C:67
virtual void jcalc(joint::XSvc &J, const scalarField &q, const scalarField &qDot) const
Update the model state for this joint.
Definition: nullJoint.C:82
null()
Construct for given model.
Definition: nullJoint.C:55
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
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Namespace for OpenFOAM.
errorManip< error > abort(error &err)
Definition: errorManip.H:144
error FatalError
dictionary dict