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

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