OpenFOAM: API Guide
v2112
The open source CFD toolbox
sphere.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::sphere
28
29
Group
30
grpRigidBodyDynamicsBodies
31
32
Description
33
Specialization of rigidBody to construct a sphere given the mass and radius.
34
35
SourceFiles
36
sphereI.H
37
sphere.C
38
39
\*---------------------------------------------------------------------------*/
40
41
#ifndef RBD_sphere_H
42
#define RBD_sphere_H
43
44
#include "
rigidBody.H
"
45
46
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48
namespace
Foam
49
{
50
namespace
RBD
51
{
52
53
/*---------------------------------------------------------------------------*\
54
Class sphere Declaration
55
\*---------------------------------------------------------------------------*/
56
57
class
sphere
58
:
59
public
rigidBody
60
{
61
// Private member data
62
63
//- Radius
64
scalar r_;
65
66
67
// Private member functions
68
69
// Calculate and return the inertia tensor
70
inline
symmTensor
I
(
const
scalar
m
,
const
scalar
r
)
const
;
71
72
73
public
:
74
75
//- Runtime type information
76
TypeName
(
"sphere"
);
77
78
79
// Constructors
80
81
//- Construct from name, mass, centre of mass and radius
82
inline
sphere
83
(
84
const
word
&
name
,
85
const
scalar
m
,
86
const
vector
&
c
,
87
const
scalar
r
88
);
89
90
//- Construct from dictionary
91
inline
sphere
92
(
93
const
word
&
name
,
94
const
dictionary
&
dict
95
);
96
97
//- Return clone of this sphere
98
virtual
autoPtr<rigidBody>
clone
()
const
;
99
100
101
//- Destructor
102
virtual
~sphere
();
103
104
105
// Member Functions
106
107
//- Return the radius of the sphere
108
inline
scalar
r
()
const
;
109
110
//- Write
111
virtual
void
write
(
Ostream
&)
const
;
112
};
113
114
115
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116
117
}
// End namespace RBD
118
}
// End namespace Foam
119
120
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121
122
#include "
sphereI.H
"
123
124
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126
#endif
127
128
// ************************************************************************* //
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:62
Foam::RBD::rigidBodyInertia::c
const vector & c() const
Return the centre of mass of the rigid-body.
Definition:
rigidBodyInertiaI.H:99
Foam::RBD::rigidBodyInertia::m
scalar m() const
Return the mass of the rigid-body.
Definition:
rigidBodyInertiaI.H:94
Foam::RBD::rigidBody
Definition:
rigidBody.H:68
Foam::RBD::rigidBody::name
const word & name() const
Return name.
Definition:
rigidBodyI.H:67
Foam::RBD::sphere
Definition:
sphere.H:59
Foam::RBD::sphere::~sphere
virtual ~sphere()
Destructor.
Definition:
sphere.C:59
Foam::RBD::sphere::r
scalar r() const
Return the radius of the sphere.
Definition:
sphereI.H:72
Foam::RBD::sphere::TypeName
TypeName("sphere")
Runtime type information.
Foam::RBD::sphere::clone
virtual autoPtr< rigidBody > clone() const
Return clone of this sphere.
Definition:
sphere.C:51
Foam::SymmTensor< scalar >
Foam::Vector< scalar >
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition:
autoPtr.H:66
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:126
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:68
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
Foam::I
static const Identity< scalar > I
Definition:
Identity.H:94
write
runTime write()
rigidBody.H
dict
dictionary dict
Definition:
searchingEngine.H:14
sphereI.H
TypeName
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition:
typeInfo.H:73
src
rigidBodyDynamics
bodies
sphere
sphere.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.