src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::electrostatic
  27
  28 Description
  29
  30
  31 SourceFiles
  32     coulomb.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coulomb_H
  37 #define coulomb_H
  38
  39 #include "pairPotential.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace pairPotentials
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class coulomb Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class coulomb
  53 :
  54     public pairPotential
  55 {
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("coulomb");
  60
  61
  62     // Static data members
  63
  64         static scalar oneOverFourPiEps0;
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         coulomb
  70         (
  71             const word& name,
  72             const dictionary& pairPotentialProperties
  73         );
  74
  75
  76     // Destructor
  77
  78         ~coulomb()
  79         {}
  80
  81
  82     // Member Functions
  83
  84         scalar unscaledEnergy(const scalar r) const;
  85
  86         //- Read dictionary
  87         bool read(const dictionary& pairPotentialProperties);
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace pairPotentials
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //