floatingJoint.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2016 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::floating
26 
27 Description
28  Prismatic joint for translation along the specified arbitrary axis.
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  floating.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef RBD_joints_floating_H
44 #define RBD_joints_floating_H
45 
46 #include "compositeJoint.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace RBD
53 {
54 namespace joints
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class floating Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 class floating
62 :
63  public composite
64 {
65  // Private member functions
66 
67  //- Return a list of joints needed to emulate a floating body
68  static autoPtr<composite> sixDoF();
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("floating");
75 
76 
77  // Constructors
78 
79  //- Construct
80  floating();
81 
82  //- Construct for given model from dictionary
83  floating(const dictionary& dict);
84 
85  //- Clone this joint
86  virtual autoPtr<joint> clone() const;
87 
88 
89  //- Destructor
90  virtual ~floating();
91 
92 
93  // Member Functions
94 
95  //- Write
96  virtual void write(Ostream&) const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace joints
103 } // End namespace RBD
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
Prismatic joint for translation along the specified arbitrary axis.
Definition: floatingJoint.H:60
TypeName("floating")
Runtime type information.
dictionary dict
virtual autoPtr< joint > clone() const
Clone this joint.
Definition: floatingJoint.C:88
virtual ~floating()
Destructor.
Definition: floatingJoint.C:96
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Prismatic joint for translation along the specified arbitrary axis.
virtual void write(Ostream &) const
Write.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.