src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.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 "sigmoid.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace energyScalingFunctions
  35 {
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 defineTypeNameAndDebug(sigmoid, 0);
  40
  41 addToRunTimeSelectionTable
  42 (
  43     energyScalingFunction,
  44     sigmoid,
  45     dictionary
  46 );
  47
  48
  49 // * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * * //
  50
  51 scalar sigmoid::sigmoidScale
  52     (
  53         const scalar r,
  54         const scalar shift,
  55         const scalar scale
  56     ) const
  57 {
  58     return 1.0 / (1.0 + exp( scale * (r - shift)));
  59 }
  60
  61
  62 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  63
  64 sigmoid::sigmoid
  65 (
  66     const word& name,
  67     const dictionary& energyScalingFunctionProperties,
  68     const pairPotential& pairPot
  69 )
  70 :
  71     energyScalingFunction(name, energyScalingFunctionProperties, pairPot),
  72     sigmoidCoeffs_
  73     (
  74         energyScalingFunctionProperties.subDict(typeName + "Coeffs")
  75     ),
  76     shift_(readScalar(sigmoidCoeffs_.lookup("shift"))),
  77     scale_(readScalar(sigmoidCoeffs_.lookup("scale")))
  78 {}
  79
  80
  81 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  82
  83 void sigmoid::scaleEnergy(scalar& e, const scalar r) const
  84 {
  85     e *= sigmoidScale(r, shift_, scale_);
  86 }
  87
  88
  89 bool sigmoid::read(const dictionary& energyScalingFunctionProperties)
  90 {
  91     energyScalingFunction::read(energyScalingFunctionProperties);
  92
  93     sigmoidCoeffs_ =
  94         energyScalingFunctionProperties.subDict(typeName + "Coeffs");
  95
  96     sigmoidCoeffs_.lookup("shift") >> shift_;
  97     sigmoidCoeffs_.lookup("scale") >> shift_;
  98
  99     return true;
 100 }
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace energyScalingFunctions
 106 } // End namespace Foam
 107
 108 // ************************************************************************* //