src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.C

   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "dampedCoulomb.H"
  27 #include "mathematicalConstants.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace pairPotentials
  35 {
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 defineTypeNameAndDebug(dampedCoulomb, 0);
  40
  41 addToRunTimeSelectionTable
  42 (
  43     pairPotential,
  44     dampedCoulomb,
  45     dictionary
  46 );
  47
  48 scalar dampedCoulomb::oneOverFourPiEps0 =
  49     1.0/(4.0*constant::mathematical::pi*8.854187817e-12);
  50
  51
  52 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  53
  54 dampedCoulomb::dampedCoulomb
  55 (
  56     const word& name,
  57     const dictionary& pairPotentialProperties
  58 )
  59 :
  60     pairPotential(name, pairPotentialProperties),
  61     dampedCoulombCoeffs_
  62     (
  63         pairPotentialProperties.subDict(typeName + "Coeffs")
  64     ),
  65     alpha_(readScalar(dampedCoulombCoeffs_.lookup("alpha")))
  66 {
  67     setLookupTables();
  68 }
  69
  70
  71 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  72
  73 scalar dampedCoulomb::unscaledEnergy(const scalar r) const
  74 {
  75     return oneOverFourPiEps0*erfc(alpha_*r)/r;
  76 }
  77
  78
  79 bool dampedCoulomb::read(const dictionary& pairPotentialProperties)
  80 {
  81     pairPotential::read(pairPotentialProperties);
  82
  83     dampedCoulombCoeffs_ =
  84         pairPotentialProperties.subDict(typeName + "Coeffs");
  85
  86     dampedCoulombCoeffs_.lookup("alpha") >> alpha_;
  87
  88     return true;
  89 }
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace pairPotentials
  95 } // End namespace Foam
  96
  97 // ************************************************************************* //