subBodyI.H
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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
31 (
32  const autoPtr<rigidBody>& bodyPtr,
33  const word& masterName,
34  const label masterID,
35  const spatialTransform& masterXT
36 )
37 :
38  body_(bodyPtr),
39  masterName_(masterName),
40  masterID_(masterID),
41  masterXT_(masterXT)
42 {}
43 
44 
46 {
47  return autoPtr<subBody>::New(*this);
48 }
49 
50 
51 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
52 
54 {
55  return *body_;
56 }
57 
58 
59 inline const Foam::word& Foam::RBD::subBody::name() const
60 {
61  return body_->name();
62 }
63 
64 
66 {
67  return masterName_;
68 }
69 
70 
71 inline Foam::label Foam::RBD::subBody::masterID() const
72 {
73  return masterID_;
74 }
75 
76 
78 {
79  return masterXT_;
80 }
81 
82 
83 // ************************************************************************* //
Foam::RBD::rigidBody
Definition: rigidBody.H:65
Foam::autoPtr::New
static autoPtr< T > New(Args &&... args)
Construct autoPtr of T with forwarding arguments.
Foam::RBD::subBody::body
const rigidBody & body() const
Return the original body from which this sub-body was constructed.
Definition: subBodyI.H:53
Foam::RBD::subBody::subBody
subBody(const autoPtr< rigidBody > &bodyPtr, const word &masterName, const label masterID, const spatialTransform &masterXT)
Construct a merged version of the given rigidBody.
Definition: subBodyI.H:31
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::spatialTransform
Compact representation of the Pl├╝cker spatial transformation tensor in terms of the rotation tensor E...
Definition: spatialTransform.H:70
Foam::RBD::subBody::masterID
label masterID() const
Return the master body Id.
Definition: subBodyI.H:71
Foam::RBD::subBody::masterName
const word & masterName() const
Return the master body name.
Definition: subBodyI.H:65
Foam::RBD::subBody::clone
autoPtr< subBody > clone() const
Return clone of this subBody.
Definition: subBodyI.H:45
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::RBD::subBody::masterXT
const spatialTransform & masterXT() const
Return the transform with respect to the master body.
Definition: subBodyI.H:77
Foam::RBD::subBody::name
const word & name() const
Return the body name.
Definition: subBodyI.H:59