sixDoFRigidBodyMotionLineConstraint.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) 2011-2015 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 
30 #include "sixDoFRigidBodyMotion.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace sixDoFRigidBodyMotionConstraints
37 {
38  defineTypeNameAndDebug(line, 0);
39 
41  (
42  sixDoFRigidBodyMotionConstraint,
43  line,
44  dictionary
45  );
46 }
47 }
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& sDoFRBMCDict,
56  const sixDoFRigidBodyMotion& motion
57 )
58 :
59  sixDoFRigidBodyMotionConstraint(name, sDoFRBMCDict, motion)
60 {
61  read(sDoFRBMCDict);
62 }
63 
64 
65 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
66 
68 {}
69 
70 
71 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
72 
74 (
75  point& CofR
76 ) const
77 {
78  CofR = centreOfRotation_;
79 }
80 
81 
83 (
84  pointConstraint& pc
85 ) const
86 {
87  pc.combine(pointConstraint(Tuple2<label, vector>(2, direction_)));
88 }
89 
90 
92 (
93  pointConstraint& pc
94 ) const
95 {}
96 
97 
99 (
100  const dictionary& sDoFRBMCDict
101 )
102 {
104 
105  centreOfRotation_ = sDoFRBMCCoeffs_.lookupOrDefault
106  (
107  "centreOfRotation",
108  motion_.initialCentreOfMass()
109  );
110 
111  sDoFRBMCCoeffs_.readEntry("direction", direction_);
112 
113  scalar magDir(mag(direction_));
114 
115  if (magDir > VSMALL)
116  {
117  direction_ /= magDir;
118  }
119  else
120  {
122  << "line direction has zero length"
123  << abort(FatalError);
124  }
125 
126  return true;
127 }
128 
129 
131 (
132  Ostream& os
133 ) const
134 {
135  os.writeEntry("centreOfRotation", centreOfRotation_);
136  os.writeEntry("direction", direction_);
137 }
138 
139 // ************************************************************************* //
Foam::sixDoFRigidBodyMotionConstraints::line::constrainRotation
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
Definition: sixDoFRigidBodyMotionLineConstraint.C:92
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::sixDoFRigidBodyMotionConstraints::line::~line
virtual ~line()
Destructor.
Definition: sixDoFRigidBodyMotionLineConstraint.C:67
Foam::pointConstraint
Accumulates point constraints through successive applications of the applyConstraint function.
Definition: pointConstraint.H:60
Foam::sixDoFRigidBodyMotionConstraints::line::read
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
Definition: sixDoFRigidBodyMotionLineConstraint.C:99
Foam::sixDoFRigidBodyMotionConstraint
Base class for defining constraints for sixDoF motions.
Definition: sixDoFRigidBodyMotionConstraint.H:67
Foam::sixDoFRigidBodyMotionConstraints::addToRunTimeSelectionTable
addToRunTimeSelectionTable(sixDoFRigidBodyMotionConstraint, axis, dictionary)
sixDoFRigidBodyMotion.H
sixDoFRigidBodyMotionLineConstraint.H
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::sixDoFRigidBodyMotionConstraints::line::line
line(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
Definition: sixDoFRigidBodyMotionLineConstraint.C:53
Foam::sixDoFRigidBodyMotionConstraints::line::setCentreOfRotation
virtual void setCentreOfRotation(point &) const
Set the centre of rotation to the projection of the.
Definition: sixDoFRigidBodyMotionLineConstraint.C:74
Foam::blockMeshTools::read
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:33
Foam::pointConstraint::combine
void combine(const pointConstraint &)
Combine constraints.
Definition: pointConstraintI.H:79
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::sixDoFRigidBodyMotionConstraints::line::constrainTranslation
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
Definition: sixDoFRigidBodyMotionLineConstraint.C:83
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::sixDoFRigidBodyMotionConstraints::point
Translation constraint on the centre of rotation: fixed in space.
Definition: sixDoFRigidBodyMotionPointConstraint.H:58
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:137
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:355
Foam::sixDoFRigidBodyMotion
Six degree of freedom motion for a rigid body.
Definition: sixDoFRigidBodyMotion.H:69
Foam::sixDoFRigidBodyMotionConstraint::read
virtual bool read(const dictionary &sDoFRBMCDict)
Update properties from given dictionary.
Definition: sixDoFRigidBodyMotionConstraint.C:63
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::sixDoFRigidBodyMotionConstraints::defineTypeNameAndDebug
defineTypeNameAndDebug(axis, 0)
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:219
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::sixDoFRigidBodyMotionConstraints::line::write
virtual void write(Ostream &) const
Write.
Definition: sixDoFRigidBodyMotionLineConstraint.C:131
Foam::Tuple2< label, vector >