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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "exponentialRepulsion.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33 namespace pairPotentials
  34 {
  35
  36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  37
  38 defineTypeNameAndDebug(exponentialRepulsion, 0);
  39
  40 addToRunTimeSelectionTable
  41 (
  42     pairPotential,
  43     exponentialRepulsion,
  44     dictionary
  45 );
  46
  47
  48 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  49
  50 exponentialRepulsion::exponentialRepulsion
  51 (
  52     const word& name,
  53     const dictionary& exponentialRepulsion
  54 )
  55 :
  56     pairPotential(name, exponentialRepulsion),
  57     exponentialRepulsionCoeffs_
  58     (
  59         exponentialRepulsion.subDict(typeName + "Coeffs")
  60     ),
  61     rm_(readScalar(exponentialRepulsionCoeffs_.lookup("rm"))),
  62     epsilon_(readScalar(exponentialRepulsionCoeffs_.lookup("epsilon")))
  63 {
  64     setLookupTables();
  65 }
  66
  67
  68 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  69
  70 scalar exponentialRepulsion::unscaledEnergy(const scalar r) const
  71 {
  72     return epsilon_ * exp(-r/rm_);
  73 }
  74
  75
  76 bool exponentialRepulsion::read(const dictionary& exponentialRepulsion)
  77 {
  78     pairPotential::read(exponentialRepulsion);
  79
  80     exponentialRepulsionCoeffs_ =
  81         exponentialRepulsion.subDict(typeName + "Coeffs");
  82
  83     exponentialRepulsionCoeffs_.lookup("rm") >> rm_;
  84     exponentialRepulsionCoeffs_.lookup("epsilon") >> epsilon_;
  85
  86     return true;
  87 }
  88
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 } // End namespace pairPotentials
  93 } // End namespace Foam
  94
  95 // ************************************************************************* //