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

electrostaticPotential.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::electrostaticPotential
00026 
00027 Description
00028 
00029 
00030 SourceFiles
00031     electrostaticPotential.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef electrostaticPotential_H
00036 #define electrostaticPotential_H
00037 
00038 #include <OpenFOAM/scalar.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                    Class electrostaticPotential Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class electrostaticPotential
00050 {
00051     // Private data
00052 
00053     scalar prefactor;
00054 
00055 
00056 public:
00057 
00058     // Constructors
00059 
00060         //- Construct and set prefactor
00061         electrostaticPotential();
00062 
00063 
00064     // Destructor
00065 
00066         ~electrostaticPotential()
00067         {}
00068 
00069 
00070     // Member Functions
00071 
00072         scalar energy(const scalar r) const;
00073 
00074         scalar force(const scalar r) const;
00075 };
00076 
00077 
00078 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00079 
00080 } // End namespace Foam
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 #endif
00085 
00086 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines