sixDoFRigidBodyMotionAxisConstraint.H
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-2019 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 Class
25  Foam::sixDoFRigidBodyMotionConstraints::axis
26 
27 Description
28  Orientation constraint:
29  may only rotate around a fixed axis.
30 
31 SourceFiles
32  sixDoFRigidBodyMotionAxisConstraint.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef sixDoFRigidBodyMotionAxisConstraint_H
37 #define sixDoFRigidBodyMotionAxisConstraint_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 namespace sixDoFRigidBodyMotionConstraints
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class axis Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class axis
54 :
56 {
57 
58  // Private Data
59 
60  //- Reference axis in global space
61  vector axis_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("axis");
68 
69 
70  // Constructors
71 
72  //- Construct from components
73  axis
74  (
75  const word& name,
76  const dictionary& sDoFRBMCDict,
77  const sixDoFRigidBodyMotion& motion
78  );
79 
80  //- Construct and return a clone
82  {
84  (
85  new axis(*this)
86  );
87  }
88 
89 
90  //- Destructor
91  virtual ~axis();
92 
93 
94  // Member Functions
95 
96  //- Apply and accumulate translational constraints
97  virtual void constrainTranslation(pointConstraint&) const;
98 
99  //- Apply and accumulate rotational constraints
100  virtual void constrainRotation(pointConstraint&) const;
101 
102  //- Update properties from given dictionary
103  virtual bool read(const dictionary& sDoFRBMCCoeff);
104 
105  //- Write
106  virtual void write(Ostream&) const;
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace solidBodyMotionFunctions
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone() const
Construct and return a clone.
TypeName("axis")
Runtime type information.
const word & name() const
Return the name.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
Base class for defining constraints for sixDoF motions.
Orientation constraint: may only rotate around a fixed axis.
A class for handling words, derived from string.
Definition: word.H:59
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
Accumulates point constraints through successive applications of the applyConstraint function...
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
axis(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
Namespace for OpenFOAM.