jointBody.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\3
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 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::jointBody
28 
29 Group
30  grpRigidBodyDynamicsBodies
31 
32 Description
33 
34 SourceFiles
35  jointBodyI.H
36  jointBody.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef RBD_jointBody_H
41 #define RBD_jointBody_H
42 
43 #include "masslessBody.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace RBD
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class jointBody Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class jointBody
57 :
58  public masslessBody
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("jointBody");
65 
66 
67  // Constructors
68 
69  //- Construct a joint body
70  inline jointBody();
71 
72  //- Construct a named joint body
73  inline jointBody(const word& name);
74 
75  //- Construct from dictionary
76  inline jointBody
77  (
78  const word& name,
79  const dictionary& dict
80  );
81 
82  //- Return clone of this jointBody
83  virtual autoPtr<rigidBody> clone() const;
84 
85 
86  //- Destructor
87  virtual ~jointBody();
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace RBD
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #include "jointBodyI.H"
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::RBD::jointBody::clone
virtual autoPtr< rigidBody > clone() const
Return clone of this jointBody.
Definition: jointBody.C:51
Foam::RBD::masslessBody
Definition: masslessBody.H:55
Foam::RBD::jointBody::TypeName
TypeName("jointBody")
Runtime type information.
jointBodyI.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::RBD::rigidBody::name
const word & name() const
Return name.
Definition: rigidBodyI.H:67
Foam::RBD::jointBody::jointBody
jointBody()
Construct a joint body.
Definition: jointBodyI.H:30
Foam::RBD::jointBody
Definition: jointBody.H:55
Foam::RBD::jointBody::~jointBody
virtual ~jointBody()
Destructor.
Definition: jointBody.C:59
masslessBody.H