All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
nullJoint.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "nullJoint.H"
27 #include "rigidBodyModel.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace RBD
35 {
36 namespace joints
37 {
38  defineTypeNameAndDebug(null, 0);
39 
41  (
42  joint,
43  null,
44  dictionary
45  );
46 }
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
54 :
55  joint(model, 0)
56 {}
57 
58 
60 (
61  const rigidBodyModel& model,
62  const dictionary& dict
63 )
64 :
65  joint(model, 0)
66 {}
67 
68 
70 {
71  return autoPtr<joint>(new null(*this));
72 }
73 
74 
75 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
76 
78 {}
79 
80 
81 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
82 
84 (
85  joint::XSvc& J,
86  const rigidBodyModelState& state
87 ) const
88 {
90  << "Cannot calculate the state of a null-joint"
91  << abort(FatalError);
92 }
93 
94 
95 // ************************************************************************* //
Abstract base-class for all rigid-body joints.
Definition: joint.H:80
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
defineTypeNameAndDebug(composite, 0)
addToRunTimeSelectionTable(joint, composite, dictionary)
virtual ~null()
Destructor.
Definition: nullJoint.C:77
null(const rigidBodyModel &model)
Construct for given model.
Definition: nullJoint.C:53
Macros for easy insertion into run-time selection tables.
virtual autoPtr< joint > clone() const
Clone this joint.
Definition: nullJoint.C:69
Holds the motion state of rigid-body model.
Joint state returned by jcalc.
Definition: joint.H:123
errorManip< error > abort(error &err)
Definition: errorManip.H:131
joint(const rigidBodyModel &model, const label nDoF)
Construct joint setting the size of the motion sub-space.
Definition: jointI.H:28
virtual void jcalc(joint::XSvc &J, const rigidBodyModelState &state) const
Update the model state for this joint.
Definition: nullJoint.C:84
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...
Namespace for OpenFOAM.