src/lagrangian/molecularDynamics/potential/electrostaticPotential/electrostaticPotential.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::pairPotentials::electrostaticPotential
  27
  28 Description
  29
  30
  31 SourceFiles
  32     electrostaticPotential.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef electrostaticPotential_H
  37 #define electrostaticPotential_H
  38
  39 #include "scalar.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                    Class electrostaticPotential Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class electrostaticPotential
  51 {
  52     // Private data
  53
  54     scalar prefactor;
  55
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Construct and set prefactor
  62         electrostaticPotential();
  63
  64
  65     // Destructor
  66
  67         ~electrostaticPotential()
  68         {}
  69
  70
  71     // Member Functions
  72
  73         scalar energy(const scalar r) const;
  74
  75         scalar force(const scalar r) const;
  76 };
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************************************************************* //