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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, 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     ~exponentialRepulsion()
  81     {}
  82
  83
  84     // Member Functions
  85
  86         scalar unscaledEnergy(const scalar r) const;
  87
  88         //- Read dictionary
  89         bool read(const dictionary& pairPotentialProperties);
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace pairPotentials
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //