src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.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     dampedCoulomb.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef dampedCoulomb_H
  37 #define dampedCoulomb_H
  38
  39 #include "pairPotential.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace pairPotentials
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                          Class dampedCoulomb Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class dampedCoulomb
  53 :
  54     public pairPotential
  55 {
  56     // Private data
  57
  58         dictionary dampedCoulombCoeffs_;
  59
  60         scalar alpha_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("dampedCoulomb");
  67
  68
  69     // Static data members
  70
  71         static scalar oneOverFourPiEps0;
  72
  73
  74     // Constructors
  75
  76         //- Construct from components
  77         dampedCoulomb
  78         (
  79             const word& name,
  80             const dictionary& pairPotentialProperties
  81         );
  82
  83
  84     // Destructor
  85
  86         ~dampedCoulomb()
  87         {}
  88
  89
  90     // Member Functions
  91
  92         scalar unscaledEnergy(const scalar r) const;
  93
  94         //- Read dictionary
  95         bool read(const dictionary& pairPotentialProperties);
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace pairPotentials
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //