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 | 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 {
39 
41  (
43  axis,
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  axis_()
61 {
62  read(sDoFRBMCDict);
63 }
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {}
70 
71 
72 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
73 
75 (
76  pointConstraint& pc
77 ) const
78 {}
79 
80 
82 (
83  pointConstraint& pc
84 ) const
85 {
87 }
88 
89 
91 (
92  const dictionary& sDoFRBMCDict
93 )
94 {
96 
97  sDoFRBMCCoeffs_.readEntry("axis", axis_);
98 
99  scalar magFixedAxis(mag(axis_));
100 
101  if (magFixedAxis > VSMALL)
102  {
103  axis_ /= magFixedAxis;
104  }
105  else
106  {
108  << "axis has zero length"
109  << abort(FatalError);
110  }
111 
112  return true;
113 }
114 
115 
117 (
118  Ostream& os
119 ) const
120 {
121  os.writeEntry("axis", axis_);
122 }
123 
124 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:120
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:578
addToRunTimeSelectionTable(sixDoFRigidBodyMotionConstraint, axis, dictionary)
void combine(const pointConstraint &)
Combine constraints.
Base class for defining constraints for sixDoF motions.
Macros for easy insertion into run-time selection tables.
Orientation constraint: may only rotate around a fixed axis.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:52
A class for handling words, derived from Foam::string.
Definition: word.H:63
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
Accumulates point constraints through successive applications of the applyConstraint function...
errorManip< error > abort(error &err)
Definition: errorManip.H:139
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:55
virtual bool read(const dictionary &sDoFRBMCDict)
Update properties from given dictionary.
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
OBJstream os(runTime.globalPath()/outputName)
axis(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
Namespace for OpenFOAM.