noScaling.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 \*---------------------------------------------------------------------------*/
25 
26 #include "noScaling.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace energyScalingFunctions
34 {
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
38 defineTypeNameAndDebug(noScaling, 0);
39 
41 (
42  energyScalingFunction,
43  noScaling,
44  dictionary
45 );
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const word& name,
53  const dictionary& energyScalingFunctionProperties,
54  const pairPotential& pairPot
55 )
56 :
57  energyScalingFunction(name, energyScalingFunctionProperties, pairPot)
58 {}
59 
60 
61 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
62 
63 void noScaling::scaleEnergy(scalar& e, const scalar r) const
64 {}
65 
66 
67 bool noScaling::read(const dictionary& energyScalingFunctionProperties)
68 {
69  energyScalingFunction::read(energyScalingFunctionProperties);
70 
71  return true;
72 }
73 
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 } // End namespace energyScalingFunctions
78 } // End namespace Foam
79 
80 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
defineTypeNameAndDebug(doubleSigmoid, 0)
noScaling(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
Construct from components.
Definition: noScaling.C:51
Macros for easy insertion into run-time selection tables.
A class for handling words, derived from string.
Definition: word.H:59
addToRunTimeSelectionTable(energyScalingFunction, doubleSigmoid, dictionary)
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual bool read(const dictionary &energyScalingFunctionProperties)=0
Read energyScalingFunction dictionary.
void scaleEnergy(scalar &e, const scalar r) const
Definition: noScaling.C:63
bool read(const dictionary &energyScalingFunctionProperties)
Read dictionary.
Definition: noScaling.C:67
const doubleScalar e
Elementary charge.
Definition: doubleScalar.H:98
Namespace for OpenFOAM.