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