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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pairPotentials::exponentialRepulsion
  26
  27 Description
  28
  29 SourceFiles
  30     exponentialRepulsion.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef exponentialRepulsion_H
  35 #define exponentialRepulsion_H
  36
  37 #include "pairPotential.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 namespace pairPotentials
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                    Class exponentialRepulsion Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class exponentialRepulsion
  52 :
  53     public pairPotential
  54 {
  55     // Private data
  56
  57         dictionary exponentialRepulsionCoeffs_;
  58
  59         scalar rm_;
  60         scalar epsilon_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("exponentialRepulsion");
  67
  68
  69     // Constructors
  70
  71         //- Construct from components
  72         exponentialRepulsion
  73         (
  74             const word& name,
  75             const dictionary& pairPotentialProperties
  76         );
  77
  78
  79     // Destructor
  80
  81         ~exponentialRepulsion()
  82         {}
  83
  84
  85     // Member Functions
  86
  87         scalar unscaledEnergy(const scalar r) const;
  88
  89         //- Read dictionary
  90         bool read(const dictionary& pairPotentialProperties);
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace pairPotentials
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //