sixDoFRigidBodyMotionAxisConstraint.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 | Copyright (C) 2011-2015 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  axis,
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  axis_()
59 {
60  read(sDoFRBMCDict);
61 }
62 
63 
64 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
65 
67 {}
68 
69 
70 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
71 
73 (
74  pointConstraint& pc
75 ) const
76 {}
77 
78 
80 (
81  pointConstraint& pc
82 ) const
83 {
85 }
86 
87 
89 (
90  const dictionary& sDoFRBMCDict
91 )
92 {
94 
95  sDoFRBMCCoeffs_.lookup("axis") >> axis_;
96 
97  scalar magFixedAxis(mag(axis_));
98 
99  if (magFixedAxis > VSMALL)
100  {
101  axis_ /= magFixedAxis;
102  }
103  else
104  {
106  (
107  "Foam::sixDoFRigidBodyMotionConstraints::axis::read"
108  "("
109  "const dictionary& sDoFRBMCDict"
110  ")"
111  )
112  << "axis has zero length"
113  << abort(FatalError);
114  }
115 
116  return true;
117 }
118 
119 
121 (
122  Ostream& os
123 ) const
124 {
125  os.writeKeyword("axis")
126  << axis_ << token::END_STATEMENT << nl;
127 }
128 
129 // ************************************************************************* //
Orientation constraint: may only rotate around a fixed axis.
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
dimensioned< scalar > mag(const dimensioned< Type > &)
A class for handling words, derived from string.
Definition: word.H:59
Accumulates point constraints through successive applications of the applyConstraint function...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual bool read(const dictionary &sDoFRBMCDict)
Update properties from given dictionary.
static const char nl
Definition: Ostream.H:260
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
Macros for easy insertion into run-time selection tables.
Base class for defining constraints for sixDoF motions.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:59
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
addToRunTimeSelectionTable(sixDoFRigidBodyMotionConstraint, axis, dictionary)
error FatalError
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
bool read(const char *, int32_t &)
Definition: int32IO.C:87
Six degree of freedom motion for a rigid body.
void combine(const pointConstraint &)
Combine constraints.
axis(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.