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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2010-2011 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::fixedPoint
  26
  27 Description
  28     sixDoFRigidBodyMotionConstraint.  Point fixed in space.
  29
  30 SourceFiles
  31     fixedPoint.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef fixedPoint_H
  36 #define fixedPoint_H
  37
  38 #include "sixDoFRigidBodyMotionConstraint.H"
  39 #include "point.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 namespace sixDoFRigidBodyMotionConstraints
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class fixedPoint Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class fixedPoint
  54 :
  55     public sixDoFRigidBodyMotionConstraint
  56 {
  57     // Private data
  58
  59         //- Point which is rigidly attached to the body and constrains
  60         //  it so that this point remains fixed.  This serves as the
  61         //  reference point for displacements as well as the target
  62         //  position.
  63         point fixedPoint_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("fixedPoint");
  70
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         fixedPoint
  76         (
  77             const dictionary& sDoFRBMCDict
  78         );
  79
  80         //- Construct and return a clone
  81         virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone() const
  82         {
  83             return autoPtr<sixDoFRigidBodyMotionConstraint>
  84             (
  85                 new fixedPoint(*this)
  86             );
  87         }
  88
  89
  90     //- Destructor
  91     virtual ~fixedPoint();
  92
  93
  94     // Member Functions
  95
  96         //- Calculate the constraint position, force and moment.
  97         //  Global reference frame vectors.  Returns boolean stating
  98         //  whether the constraint been converged to tolerance.
  99         virtual bool constrain
 100         (
 101             const sixDoFRigidBodyMotion& motion,
 102             const vector& existingConstraintForce,
 103             const vector& existingConstraintMoment,
 104             scalar deltaT,
 105             vector& constraintPosition,
 106             vector& constraintForceIncrement,
 107             vector& constraintMomentIncrement
 108         ) const;
 109
 110         //- Update properties from given dictionary
 111         virtual bool read(const dictionary& sDoFRBMCCoeff);
 112
 113         //- Write
 114         virtual void write(Ostream&) const;
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace solidBodyMotionFunctions
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //