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