src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2009 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 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 Class
  26     Foam::energyScalingFunctions::sigmoid
  27
  28 Description
  29
  30
  31 SourceFiles
  32     sigmoid.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef sigmoid_H
  37 #define sigmoid_H
  38
  39 #include "energyScalingFunction.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace energyScalingFunctions
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class sigmoid Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class sigmoid
  53 :
  54     public energyScalingFunction
  55 {
  56     // Private data
  57
  58         dictionary sigmoidCoeffs_;
  59
  60         scalar shift_;
  61         scalar scale_;
  62
  63
  64     // Private Member Functions
  65
  66         scalar sigmoidScale
  67         (
  68             const scalar r,
  69             const scalar shift,
  70             const scalar scale
  71         ) const;
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("sigmoid");
  78
  79
  80     // Constructors
  81
  82         //- Construct from components
  83         sigmoid
  84         (
  85             const word& name,
  86             const dictionary& energyScalingFunctionProperties,
  87             const pairPotential& pairPot
  88         );
  89
  90
  91     // Destructor
  92
  93         ~sigmoid()
  94         {}
  95
  96
  97     // Member Functions
  98
  99         void scaleEnergy(scalar& e, const scalar r) const;
 100
 101         //- Read dictionary
 102         bool read(const dictionary& energyScalingFunctionProperties);
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace energyScalingFunctions
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //