src/lagrangian/molecularDynamics/potential/pairPotential/basic/pairPotential.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::pairPotential
  27
  28 Description
  29
  30 SourceFiles
  31     pairPotential.C
  32     newPairPotential.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef pairPotential_H
  37 #define pairPotential_H
  38
  39 #include "IOdictionary.H"
  40 #include "typeInfo.H"
  41 #include "runTimeSelectionTables.H"
  42 #include "autoPtr.H"
  43 #include "List.H"
  44 #include "Pair.H"
  45 #include "Switch.H"
  46 #include "mathematicalConstants.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Forward declaration of classes
  54 class energyScalingFunction;
  55
  56 /*---------------------------------------------------------------------------*\
  57                      Class pairPotential Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class pairPotential
  61 {
  62
  63 protected:
  64
  65     // Protected data
  66
  67         word name_;
  68         dictionary pairPotentialProperties_;
  69
  70         scalar rCut_;
  71         scalar rCutSqr_;
  72
  73         scalar rMin_;
  74         scalar dr_;
  75
  76         List<scalar> forceLookup_;
  77         List<scalar> energyLookup_;
  78
  79         mutable energyScalingFunction* esfPtr_;
  80
  81         bool writeTables_;
  82
  83
  84     // Private Member Functions
  85
  86         void scaleEnergy(scalar& e, const scalar r) const;
  87
  88         //- Disallow copy construct
  89         pairPotential(const pairPotential&);
  90
  91         //- Disallow default bitwise assignment
  92         void operator=(const pairPotential&);
  93
  94
  95 public:
  96
  97     //- Runtime type information
  98         TypeName("pairPotential");
  99
 100
 101     // Declare run-time constructor selection table
 102
 103         declareRunTimeSelectionTable
 104         (
 105             autoPtr,
 106             pairPotential,
 107             dictionary,
 108             (
 109                 const word& name,
 110                 const dictionary& pairPotentialProperties
 111             ),
 112             (name, pairPotentialProperties)
 113         );
 114
 115
 116     // Selectors
 117
 118         //- Return a reference to the selected viscosity model
 119         static autoPtr<pairPotential> New
 120         (
 121             const word& name,
 122             const dictionary& pairPotentialProperties
 123         );
 124
 125
 126     // Constructors
 127
 128         //- Construct from components
 129         pairPotential
 130         (
 131             const word& name,
 132             const dictionary& pairPotentialProperties
 133         );
 134
 135
 136     // Destructor
 137
 138         virtual ~pairPotential()
 139         {}
 140
 141
 142     // Member Functions
 143
 144         void setLookupTables();
 145
 146         inline scalar rMin() const;
 147
 148         inline scalar dr() const;
 149
 150         inline scalar rCut() const;
 151
 152         inline scalar rCutSqr() const;
 153
 154         scalar energy (const scalar r) const;
 155
 156         scalar force (const scalar r) const;
 157
 158         List<Pair<scalar> > energyTable() const;
 159
 160         List<Pair<scalar> > forceTable() const;
 161
 162         inline bool writeTables() const;
 163
 164         virtual scalar unscaledEnergy(const scalar r) const = 0;
 165
 166         scalar scaledEnergy(const scalar r) const;
 167
 168         scalar energyDerivative
 169         (
 170             const scalar r,
 171             const bool scaledEnergyDerivative = true
 172         ) const;
 173
 174         const dictionary& pairPotentialProperties() const
 175         {
 176             return pairPotentialProperties_;
 177         }
 178
 179         bool writeEnergyAndForceTables(Ostream& os) const;
 180
 181         //- Read pairPotential dictionary
 182         virtual bool read(const dictionary& pairPotentialProperties) = 0;
 183 };
 184
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace Foam
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 #include "pairPotentialI.H"
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #endif
 197
 198 // ************************************************************************* //