FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

fixedPlane.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::sixDoFRigidBodyMotionConstraints::fixedPlane
00026 
00027 Description
00028     sixDoFRigidBodyMotionConstraint.  Reference point may only move
00029     along a plane.
00030 
00031 SourceFiles
00032     fixedPlane.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef fixedPlane_H
00037 #define fixedPlane_H
00038 
00039 #include <forces/sixDoFRigidBodyMotionConstraint.H>
00040 #include <OpenFOAM/plane.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 namespace sixDoFRigidBodyMotionConstraints
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                           Class fixedPlane Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class fixedPlane
00055 :
00056     public sixDoFRigidBodyMotionConstraint
00057 {
00058     // Private data
00059 
00060         //- Plane which the transformed reference point is constrained
00061         //  to move along
00062         plane fixedPlane_;
00063 
00064 
00065 public:
00066 
00067     //- Runtime type information
00068     TypeName("fixedPlane");
00069 
00070 
00071     // Constructors
00072 
00073         //- Construct from components
00074         fixedPlane
00075         (
00076             const dictionary& sDoFRBMCDict
00077         );
00078 
00079         //- Construct and return a clone
00080         virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone() const
00081         {
00082             return autoPtr<sixDoFRigidBodyMotionConstraint>
00083             (
00084                 new fixedPlane(*this)
00085             );
00086         }
00087 
00088 
00089     // Destructor
00090 
00091         virtual ~fixedPlane();
00092 
00093 
00094     // Member Functions
00095 
00096         //- Calculate the constraint position, force and moment.
00097         //  Global reference frame vectors.  Returns boolean stating
00098         //  whether the constraint been converged to tolerance.
00099         virtual bool constrain
00100         (
00101             const sixDoFRigidBodyMotion& motion,
00102             const vector& existingConstraintForce,
00103             const vector& existingConstraintMoment,
00104             scalar deltaT,
00105             vector& constraintPosition,
00106             vector& constraintForceIncrement,
00107             vector& constraintMomentIncrement
00108         ) const;
00109 
00110         //- Update properties from given dictionary
00111         virtual bool read(const dictionary& sDoFRBMCCoeff);
00112 
00113         //- Write
00114         virtual void write(Ostream&) const;
00115 };
00116 
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 } // End namespace solidBodyMotionFunctions
00121 } // End namespace Foam
00122 
00123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00124 
00125 #endif
00126 
00127 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines