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

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