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