jointBody.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-2026 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::jointBody
26 
27 Description
28  ...
29 
30 SourceFiles
31  jointBodyI.H
32  jointBody.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef RBD_jointBody_H
37 #define RBD_jointBody_H
38 
39 #include "masslessBody.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace RBD
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class jointBody Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class jointBody
53 :
54  public masslessBody
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("jointBody");
61 
62 
63  // Constructors
64 
65  //- Construct a joint body
66  inline jointBody();
67 
68  //- Construct a named joint body
69  inline jointBody(const word& name);
70 
71  //- Construct from dictionary
72  inline jointBody
73  (
74  const word& name,
75  const dictionary& dict
76  );
77 
78  //- Return clone of this jointBody
79  virtual autoPtr<rigidBody> clone() const;
80 
81 
82  //- Destructor
83  virtual ~jointBody();
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace RBD
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #include "jointBodyI.H"
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
virtual ~jointBody()
Destructor.
Definition: jointBody.C:51
jointBody()
Construct a joint body.
Definition: jointBodyI.H:28
virtual autoPtr< rigidBody > clone() const
Return clone of this jointBody.
Definition: jointBody.C:43
TypeName("jointBody")
Runtime type information.
const word & name() const
Return name.
Definition: rigidBodyI.H:65
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
dictionary dict