src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedLine/fixedLine.H

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