sixDoFRigidBodyMotionLineConstraint.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
28 #include "sixDoFRigidBodyMotion.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace sixDoFRigidBodyMotionConstraints
35 {
37 
39  (
41  line,
43  );
44 }
45 }
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const word& name,
53  const dictionary& sDoFRBMCDict,
54  const sixDoFRigidBodyMotion& motion
55 )
56 :
57  sixDoFRigidBodyMotionConstraint(name, sDoFRBMCDict, motion)
58 {
59  read(sDoFRBMCDict);
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
70 
72 (
73  point& CofR
74 ) const
75 {
76  CofR = centreOfRotation_;
77 }
78 
79 
81 (
82  pointConstraint& pc
83 ) const
84 {
85  pc.combine(pointConstraint(Tuple2<label, vector>(2, direction_)));
86 }
87 
88 
90 (
91  pointConstraint& pc
92 ) const
93 {}
94 
95 
97 (
98  const dictionary& sDoFRBMCDict
99 )
100 {
102 
103  centreOfRotation_ = sDoFRBMCCoeffs_.lookupOrDefault
104  (
105  "centreOfRotation",
106  motion_.initialCentreOfMass()
107  );
108 
109  sDoFRBMCCoeffs_.lookup("direction") >> direction_;
110 
111  scalar magDir(mag(direction_));
112 
113  if (magDir > vSmall)
114  {
115  direction_ /= magDir;
116  }
117  else
118  {
120  << "line direction has zero length"
121  << abort(FatalError);
122  }
123 
124  return true;
125 }
126 
127 
129 (
130  Ostream& os
131 ) const
132 {
133  writeEntry(os, "centreOfRotation", centreOfRotation_);
134  writeEntry(os, "direction", direction_);
135 }
136 
137 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Accumulates point constraints through successive applications of the applyConstraint function.
void combine(const pointConstraint &)
Combine constraints.
Base class for defining constraints for sixDoF motions.
virtual bool read(const dictionary &sDoFRBMCDict)
Update properties from given dictionary.
Translation constraint on the centre of rotation: may only move along a line.
virtual void setCentreOfRotation(point &) const
Set the centre of rotation to the projection of the.
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
line(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
Translation constraint on the centre of rotation: fixed in space.
Six degree of freedom motion for a rigid body.
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
addToRunTimeSelectionTable(sixDoFRigidBodyMotionConstraint, axis, dictionary)
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
errorManip< error > abort(error &err)
Definition: errorManip.H:131
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
dimensioned< scalar > mag(const dimensioned< Type > &)
error FatalError