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

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