src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedPlane/fixedPlane.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::fixedPlane
  27
  28 Description
  29     sixDoFRigidBodyMotionConstraint.  Reference point may only move
  30     along a plane.
  31
  32 SourceFiles
  33     fixedPlane.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef fixedPlane_H
  38 #define fixedPlane_H
  39
  40 #include "sixDoFRigidBodyMotionConstraint.H"
  41 #include "plane.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 namespace sixDoFRigidBodyMotionConstraints
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                           Class fixedPlane Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class fixedPlane
  56 :
  57     public sixDoFRigidBodyMotionConstraint
  58 {
  59     // Private data
  60
  61         //- Plane which the transformed reference point is constrained
  62         //  to move along
  63         plane fixedPlane_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("fixedPlane");
  70
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         fixedPlane
  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 fixedPlane(*this)
  86             );
  87         }
  88
  89
  90     // Destructor
  91
  92         virtual ~fixedPlane();
  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 // ************************************************************************* //