FreeFOAM The Cross-Platform CFD Toolkit
fixedAxis.H
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) 1991-2010 OpenCFD Ltd.
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::fixedAxis
26 
27 Description
28  sixDoFRigidBodyMotionConstraint. Body may only rotate around
29  an axis fixed in global space.
30 
31 SourceFiles
32  fixedAxis.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef fixedAxis_H
37 #define fixedAxis_H
38 
40 #include <OpenFOAM/point.H>
41 #include <OpenFOAM/tensor.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 namespace sixDoFRigidBodyMotionConstraints
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class fixedAxis Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class fixedAxis
56 :
58 {
59 
60  // Private data
61 
62  //- Reference axis in global space
63  vector fixedAxis_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("fixedAxis");
70 
71 
72  // Constructors
73 
74  //- Construct from components
75  fixedAxis
76  (
77  const dictionary& sDoFRBMCDict
78  );
79 
80  //- Construct and return a clone
82  {
84  (
85  new fixedAxis(*this)
86  );
87  }
88 
89 
90  // Destructor
91 
92  virtual ~fixedAxis();
93 
94 
95  // Member Functions
96 
97  //- Calculate the constraint position, force and moment.
98  // Global reference frame vectors. Returns boolean stating
99  // whether the constraint been converged to tolerance.
100  virtual bool constrain
101  (
102  const sixDoFRigidBodyMotion& motion,
103  const vector& existingConstraintForce,
104  const vector& existingConstraintMoment,
105  scalar deltaT,
106  vector& constraintPosition,
107  vector& constraintForceIncrement,
108  vector& constraintMomentIncrement
109  ) const;
110 
111  //- Update properties from given dictionary
112  virtual bool read(const dictionary& sDoFRBMCCoeff);
113 
114  //- Write
115  virtual void write(Ostream&) const;
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace solidBodyMotionFunctions
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************ vim: set sw=4 sts=4 et: ************************ //