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