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