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