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) 2011 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::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
  39 #include "sixDoFRigidBodyMotionConstraint.H"
  40 #include "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 :
  56     public sixDoFRigidBodyMotionConstraint
  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
  82         virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone() const
  83         {
  84             return autoPtr<sixDoFRigidBodyMotionConstraint>
  85             (
  86                 new fixedLine(*this)
  87             );
  88         }
  89
  90
  91     //- Destructor
  92     virtual ~fixedLine();
  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 // ************************************************************************* //