rigidBody.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  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "rigidBody.H"
30 #include "subBody.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace RBD
38 {
39  defineTypeNameAndDebug(rigidBody, 0);
40  defineRunTimeSelectionTable(rigidBody, dictionary);
41 
43  (
44  rigidBody,
45  rigidBody,
46  dictionary
47  );
48 }
49 }
50 
51 
52 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
53 
55 {
56  return autoPtr<rigidBody>::New(*this);
57 }
58 
59 
60 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
61 
63 (
64  const word& name,
65  const scalar& m,
66  const vector& c,
67  const symmTensor& Ic
68 )
69 {
70  return autoPtr<rigidBody>::New(name, m, c, Ic);
71 }
72 
73 
75 (
76  const word& name,
77  const dictionary& dict
78 )
79 {
80  const word bodyType(dict.get<word>("type"));
81 
82  auto* ctorPtr = dictionaryConstructorTable(bodyType);
83 
84  if (!ctorPtr)
85  {
87  (
88  dict,
89  "rigidBody",
90  bodyType,
91  *dictionaryConstructorTablePtr_
92  ) << exit(FatalIOError);
93  }
94 
95  return autoPtr<rigidBody>(ctorPtr(name, dict));
96 }
97 
98 
99 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
100 
102 {}
103 
104 
105 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
106 
108 {
109  return false;
110 }
111 
112 
114 {
115  *this = rigidBody
116  (
117  name(),
118  *this + transform(subBody.masterXT(), subBody.body())
119  );
120 }
121 
122 
124 {
125  os.writeEntry("type", type());
126  os.writeEntry("mass", m());
127  os.writeEntry("centreOfMass", c());
128  os.writeEntry("inertia", Ic());
129 }
130 
131 
132 // ************************************************************************* //
Foam::RBD::rigidBody
Definition: rigidBody.H:65
Foam::autoPtr::New
static autoPtr< T > New(Args &&... args)
Construct autoPtr of T with forwarding arguments.
subBody.H
Foam::SymmTensor< scalar >
Foam::RBD::subBody::body
const rigidBody & body() const
Return the original body from which this sub-body was constructed.
Definition: subBodyI.H:53
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::FatalIOError
IOerror FatalIOError
Foam::RBD::rigidBody::merge
void merge(const subBody &)
Merge a body into this parent body.
Definition: rigidBody.C:113
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::RBD::rigidBody::clone
virtual autoPtr< rigidBody > clone() const
Return clone of this rigidBody.
Definition: rigidBody.C:54
Foam::RBD::rigidBody::massless
virtual bool massless() const
Return false as this body is not massless.
Definition: rigidBody.C:107
Foam::RBD::subBody
Definition: subBody.H:57
Foam::RBD::defineTypeNameAndDebug
defineTypeNameAndDebug(cuboid, 0)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
rigidBody.H
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::RBD::rigidBody::~rigidBody
virtual ~rigidBody()
Destructor.
Definition: rigidBody.C:101
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::autoPtr< Foam::RBD::rigidBody >
Foam::RBD::rigidBody::write
virtual void write(Ostream &) const
Write.
Definition: rigidBody.C:123
Foam::Vector< scalar >
Foam::RBD::transform
rigidBodyInertia transform(const spatialTransform &X, const rigidBodyInertia &I)
Return (^BX_A)^* I ^AX_B.
Definition: rigidBodyInertiaI.H:211
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:590
Foam::RBD::defineRunTimeSelectionTable
defineRunTimeSelectionTable(rigidBody, dictionary)
Foam::constant::universal::c
const dimensionedScalar c
Speed of light in a vacuum.
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::RBD::subBody::masterXT
const spatialTransform & masterXT() const
Return the transform with respect to the master body.
Definition: subBodyI.H:77
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::RBD::addToRunTimeSelectionTable
addToRunTimeSelectionTable(rigidBody, cuboid, dictionary)
Foam::RBD::rigidBody::New
static autoPtr< rigidBody > New(const word &name, const scalar &m, const vector &c, const symmTensor &Ic)
Select constructed from components.
Definition: rigidBody.C:63