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

   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 Class
  26     Foam::energyScalingFunctions::shifted
  27
  28 Description
  29
  30
  31 SourceFiles
  32     shifted.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef shifted_H
  37 #define shifted_H
  38
  39 #include "energyScalingFunction.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace energyScalingFunctions
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class shifted Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class shifted
  53 :
  54     public energyScalingFunction
  55 {
  56     // Private data
  57
  58         scalar e_at_rCut_;
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("shifted");
  65
  66
  67     // Constructors
  68
  69         //- Construct from components
  70         shifted
  71         (
  72             const word& name,
  73             const dictionary& energyScalingFunctionProperties,
  74             const pairPotential& pairPot
  75         );
  76
  77
  78     // Destructor
  79
  80         ~shifted()
  81         {}
  82
  83
  84     // Member Functions
  85
  86         void scaleEnergy(scalar& e, const scalar r) const;
  87
  88         //- Read dictionary
  89         bool read(const dictionary& energyScalingFunctionProperties);
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace energyScalingFunctions
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //