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