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