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) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pairPotentials::electrostaticPotential
  26
  27 Description
  28
  29
  30 SourceFiles
  31     electrostaticPotential.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef electrostaticPotential_H
  36 #define electrostaticPotential_H
  37
  38 #include "scalar.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                    Class electrostaticPotential Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class electrostaticPotential
  50 {
  51     // Private data
  52
  53     scalar prefactor;
  54
  55
  56 public:
  57
  58     // Constructors
  59
  60         //- Construct and set prefactor
  61         electrostaticPotential();
  62
  63
  64     //- Destructor
  65     ~electrostaticPotential()
  66     {}
  67
  68
  69     // Member Functions
  70
  71         scalar energy(const scalar r) const;
  72
  73         scalar force(const scalar r) const;
  74 };
  75
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 } // End namespace Foam
  80
  81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  82
  83 #endif
  84
  85 // ************************************************************************* //