OpenFOAM: API Guide
v2112
The open source CFD toolbox
rigidBodyRestraint.C
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------* \
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
\*---------------------------------------------------------------------------*/
27
28
#include "
rigidBodyRestraint.H
"
29
#include "
rigidBodyModel.H
"
30
31
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32
33
namespace
Foam
34
{
35
namespace
RBD
36
{
37
defineTypeNameAndDebug
(
restraint
, 0);
38
defineRunTimeSelectionTable
(
restraint
,
dictionary
);
39
}
40
}
41
42
43
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44
45
Foam::RBD::restraint::restraint
46
(
47
const
word
& name,
48
const
dictionary
&
dict
,
49
const
rigidBodyModel
& model
50
)
51
:
52
name_(
name
),
53
bodyID_(model.bodyID(
dict
.get<
word
>(
"body"
))),
54
bodyIndex_(model.master(bodyID_)),
55
coeffs_(
dict
),
56
model_(model)
57
{}
58
59
60
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
61
62
Foam::RBD::restraint::~restraint
()
63
{}
64
65
66
// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
67
68
const
Foam::dictionary
&
Foam::RBD::restraint::coeffDict
()
const
69
{
70
return
coeffs_;
71
}
72
73
74
bool
Foam::RBD::restraint::read
(
const
dictionary
&
dict
)
75
{
76
coeffs_ =
dict
;
77
return
true
;
78
}
79
80
81
void
Foam::RBD::restraint::write
(
Ostream
&
os
)
const
82
{
83
os
.writeEntry(
"type"
,
type
());
84
os
.writeEntry(
"body"
, model_.name(bodyID_));
85
}
86
87
88
// ************************************************************************* //
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:62
Foam::RASModels::kEpsilonLopesdaCosta::read
virtual bool read()
Re-read model coefficients if they have changed.
Definition:
kEpsilonLopesdaCosta.C:380
Foam::RBD::restraint
Base class for defining restraints for rigid-body dynamics.
Definition:
rigidBodyRestraint.H:69
Foam::RBD::restraint::~restraint
virtual ~restraint()
Destructor.
Definition:
rigidBodyRestraint.C:62
Foam::RBD::restraint::coeffDict
const dictionary & coeffDict() const
Return access to coeffs.
Definition:
rigidBodyRestraint.C:68
Foam::RBD::rigidBodyModel
Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints.
Definition:
rigidBodyModel.H:84
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:126
Foam::functionObjects::ObukhovLength::write
virtual bool write()
Write the output fields.
Definition:
ObukhovLength.C:222
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:68
defineTypeNameAndDebug
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition:
className.H:121
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition:
MSwindows.C:598
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition:
exprTraits.C:59
rigidBodyModel.H
rigidBodyRestraint.H
defineRunTimeSelectionTable
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
Definition:
runTimeSelectionTables.H:374
dict
dictionary dict
Definition:
searchingEngine.H:14
src
rigidBodyDynamics
restraints
restraint
rigidBodyRestraint.C
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.