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

linearAxialAngularSpring.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::sixDoFRigidBodyMotionRestraints::linearAxialAngularSpring
00026 
00027 Description
00028     sixDoFRigidBodyMotionRestraints model.  Linear axial angular spring.
00029 
00030 SourceFiles
00031     linearAxialAngularSpring.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef linearAxialAngularSpring_H
00036 #define linearAxialAngularSpring_H
00037 
00038 #include <forces/sixDoFRigidBodyMotionRestraint.H>
00039 #include <OpenFOAM/point.H>
00040 #include <OpenFOAM/tensor.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 namespace sixDoFRigidBodyMotionRestraints
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                    Class linearAxialAngularSpring Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class linearAxialAngularSpring
00055 :
00056     public sixDoFRigidBodyMotionRestraint
00057 {
00058     // Private data
00059 
00060         //- Reference orientation where there is no moment
00061         tensor refQ_;
00062 
00063         //- Global unit axis around which the motion is sprung
00064         vector axis_;
00065 
00066         //- Spring stiffness coefficient (Nm/rad)
00067         scalar stiffness_;
00068 
00069         //- Damping coefficient (Nms/rad)
00070         scalar damping_;
00071 
00072 
00073 public:
00074 
00075     //- Runtime type information
00076     TypeName("linearAxialAngularSpring");
00077 
00078 
00079     // Constructors
00080 
00081         //- Construct from components
00082         linearAxialAngularSpring
00083         (
00084             const dictionary& sDoFRBMRDict
00085         );
00086 
00087         //- Construct and return a clone
00088         virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone() const
00089         {
00090             return autoPtr<sixDoFRigidBodyMotionRestraint>
00091             (
00092                 new linearAxialAngularSpring(*this)
00093             );
00094         }
00095 
00096 
00097     // Destructor
00098 
00099         virtual ~linearAxialAngularSpring();
00100 
00101 
00102     // Member Functions
00103 
00104         //- Calculate the restraint position, force and moment.
00105         //  Global reference frame vectors.
00106         virtual void restrain
00107         (
00108             const sixDoFRigidBodyMotion& motion,
00109             vector& restraintPosition,
00110             vector& restraintForce,
00111             vector& restraintMoment
00112         ) const;
00113 
00114         //- Update properties from given dictionary
00115         virtual bool read(const dictionary& sDoFRBMRCoeff);
00116 
00117         //- Write
00118         virtual void write(Ostream&) const;
00119 };
00120 
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 } // End namespace solidBodyMotionFunctions
00125 } // End namespace Foam
00126 
00127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00128 
00129 #endif
00130 
00131 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines