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

fixedLine.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::fixedLine
00026 
00027 Description
00028     sixDoFRigidBodyMotionConstraint.  Reference point may only move
00029     along a line.
00030 
00031 SourceFiles
00032     fixedLine.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef fixedLine_H
00037 #define fixedLine_H
00038 
00039 #include <forces/sixDoFRigidBodyMotionConstraint.H>
00040 #include <OpenFOAM/point.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 namespace sixDoFRigidBodyMotionConstraints
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                           Class fixedLine Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class fixedLine
00055 :
00056     public sixDoFRigidBodyMotionConstraint
00057 {
00058     // Private data
00059 
00060         //- Reference point for the constraining line
00061         point refPt_;
00062 
00063         //- Direction of the constraining line
00064         vector dir_;
00065 
00066 
00067 public:
00068 
00069     //- Runtime type information
00070     TypeName("fixedLine");
00071 
00072 
00073     // Constructors
00074 
00075         //- Construct from components
00076         fixedLine
00077         (
00078             const dictionary& sDoFRBMCDict
00079         );
00080 
00081         //- Construct and return a clone
00082         virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone() const
00083         {
00084             return autoPtr<sixDoFRigidBodyMotionConstraint>
00085             (
00086                 new fixedLine(*this)
00087             );
00088         }
00089 
00090 
00091     // Destructor
00092 
00093         virtual ~fixedLine();
00094 
00095 
00096     // Member Functions
00097 
00098         //- Calculate the constraint position, force and moment.
00099         //  Global reference frame vectors.  Returns boolean stating
00100         //  whether the constraint been converged to tolerance.
00101         virtual bool constrain
00102         (
00103             const sixDoFRigidBodyMotion& motion,
00104             const vector& existingConstraintForce,
00105             const vector& existingConstraintMoment,
00106             scalar deltaT,
00107             vector& constraintPosition,
00108             vector& constraintForceIncrement,
00109             vector& constraintMomentIncrement
00110         ) const;
00111 
00112         //- Update properties from given dictionary
00113         virtual bool read(const dictionary& sDoFRBMCCoeff);
00114 
00115         //- Write
00116         virtual void write(Ostream&) const;
00117 };
00118 
00119 
00120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00121 
00122 } // End namespace solidBodyMotionFunctions
00123 } // End namespace Foam
00124 
00125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00126 
00127 #endif
00128 
00129 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines