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