masslessBody.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-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::masslessBody
28
29Group
30 grpRigidBodyDynamicsBodies
31
32Description
33
34SourceFiles
35 masslessBodyI.H
36 masslessBody.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef RBD_masslessBody_H
41#define RBD_masslessBody_H
42
43#include "rigidBody.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49namespace RBD
50{
51
52/*---------------------------------------------------------------------------*\
53 Class masslessBody Declaration
54\*---------------------------------------------------------------------------*/
56class masslessBody
57:
58 public rigidBody
59{
60
61public:
62
63 //- Runtime type information
64 TypeName("masslessBody");
65
66
67 // Constructors
68
69 //- Construct a massless body
70 inline masslessBody();
71
72 //- Construct a named massless body
73 inline masslessBody(const word& name);
74
75 //- Construct from dictionary
76 inline masslessBody
77 (
78 const word& name,
79 const dictionary& dict
80 );
81
82 //- Return clone of this masslessBody
83 virtual autoPtr<rigidBody> clone() const;
84
85
86 //- Destructor
87 virtual ~masslessBody();
88
89
90 // Member Functions
91
92 //- Return true if this body is a massless component of a composite body
93 virtual bool massless() const;
94
95 //- Write
96 virtual void write(Ostream&) const;
97};
98
99
100// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102} // End namespace RBD
103} // End namespace Foam
104
105// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106
107#include "masslessBodyI.H"
108
109// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110
111#endif
112
113// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
virtual bool massless() const
Return true if this body is a massless component of a composite body.
Definition: masslessBody.C:65
virtual ~masslessBody()
Destructor.
Definition: masslessBody.C:59
virtual autoPtr< rigidBody > clone() const
Return clone of this masslessBody.
Definition: masslessBody.C:51
masslessBody()
Construct a massless body.
Definition: masslessBodyI.H:30
TypeName("masslessBody")
Runtime type information.
const word & name() const
Return name.
Definition: rigidBodyI.H:67
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
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
runTime write()
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73