src/lagrangian/molecularDynamics/potential/energyScalingFunction/basic/energyScalingFunction.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::energyScalingFunction
  27
  28 Description
  29
  30 SourceFiles
  31     energyScalingFunction.C
  32     newEnergyScalingFunction.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef energyScalingFunction_H
  37 #define energyScalingFunction_H
  38
  39 #include "IOdictionary.H"
  40 #include "typeInfo.H"
  41 #include "runTimeSelectionTables.H"
  42 #include "autoPtr.H"
  43 #include "pairPotential.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                    Class energyScalingFunction Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class energyScalingFunction
  55 {
  56
  57 protected:
  58
  59     // Protected data
  60
  61         word name_;
  62
  63         dictionary energyScalingFunctionProperties_;
  64
  65         const pairPotential& pairPot_;
  66
  67
  68     // Private Member Functions
  69
  70         //- Disallow copy construct
  71         energyScalingFunction(const energyScalingFunction&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const energyScalingFunction&);
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("energyScalingFunction");
  81
  82
  83     // Declare run-time constructor selection table
  84
  85         declareRunTimeSelectionTable
  86         (
  87             autoPtr,
  88             energyScalingFunction,
  89             dictionary,
  90             (
  91                 const word& name,
  92                 const dictionary& energyScalingFunctionProperties,
  93                 const pairPotential& pairPot
  94             ),
  95             (name, energyScalingFunctionProperties, pairPot)
  96         );
  97
  98
  99     // Selectors
 100
 101         //- Return a reference to the selected viscosity model
 102         static autoPtr<energyScalingFunction> New
 103         (
 104             const word& name,
 105             const dictionary& energyScalingFunctionProperties,
 106             const pairPotential& pairPot
 107         );
 108
 109
 110     // Constructors
 111
 112         //- Construct from components
 113         energyScalingFunction
 114         (
 115             const word& name,
 116             const dictionary& energyScalingFunctionProperties,
 117             const pairPotential& pairPot
 118         );
 119
 120
 121     // Destructor
 122
 123         virtual ~energyScalingFunction()
 124         {}
 125
 126
 127     // Member Functions
 128
 129         virtual void scaleEnergy(scalar& e, const scalar r) const = 0;
 130
 131         const dictionary& energyScalingFunctionProperties() const
 132         {
 133             return energyScalingFunctionProperties_;
 134         }
 135
 136         //- Read energyScalingFunction dictionary
 137         virtual bool read(const dictionary& energyScalingFunctionProperties) = 0;
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace Foam
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************************************************************* //