00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 2008-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::tetherPotentials::harmonicSpring 00026 00027 Description 00028 00029 00030 SourceFiles 00031 harmonicSpring.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef harmonicSpring_H 00036 #define harmonicSpring_H 00037 00038 #include <potential/tetherPotential.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 namespace tetherPotentials 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class harmonicSpring Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class harmonicSpring 00052 : 00053 public tetherPotential 00054 { 00055 // Private data 00056 00057 dictionary harmonicSpringCoeffs_; 00058 00059 scalar springConstant_; 00060 00061 00062 public: 00063 00064 //- Runtime type information 00065 TypeName("harmonicSpring"); 00066 00067 00068 // Constructors 00069 00070 //- Construct from components 00071 harmonicSpring 00072 ( 00073 const word& name, 00074 const dictionary& tetherPotentialProperties 00075 ); 00076 00077 00078 // Destructor 00079 00080 ~harmonicSpring() 00081 {} 00082 00083 00084 // Member Functions 00085 00086 scalar energy(const vector r) const; 00087 00088 vector force(const vector r) const; 00089 00090 //- Read dictionary 00091 bool read(const dictionary& tetherPotentialProperties); 00092 }; 00093 00094 00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00096 00097 } // End namespace tetherPotentials 00098 } // End namespace Foam 00099 00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00101 00102 #endif 00103 00104 // ************************ vim: set sw=4 sts=4 et: ************************ //
