shifted.H
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-2019 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::energyScalingFunctions::shifted
26 
27 Description
28 
29 
30 SourceFiles
31  shifted.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef shifted_H
36 #define shifted_H
37 
38 #include "energyScalingFunction.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace energyScalingFunctions
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class shifted Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class shifted
52 :
54 {
55  // Private Data
56 
57  scalar e_at_rCut_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("shifted");
64 
65 
66  // Constructors
67 
68  //- Construct from components
69  shifted
70  (
71  const word& name,
73  const pairPotential& pairPot
74  );
75 
76 
77  //- Destructor
78  ~shifted()
79  {}
80 
81 
82  // Member Functions
83 
84  void scaleEnergy(scalar& e, const scalar r) const;
85 
86  //- Read dictionary
87  bool read(const dictionary& energyScalingFunctionProperties);
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace energyScalingFunctions
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
TypeName("shifted")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
bool read(const dictionary &energyScalingFunctionProperties)
Read dictionary.
Definition: shifted.C:70
const dictionary & energyScalingFunctionProperties() const
shifted(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
Construct from components.
Definition: shifted.C:51
A class for handling words, derived from string.
Definition: word.H:59
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
const doubleScalar e
Elementary charge.
Definition: doubleScalar.H:105
void scaleEnergy(scalar &e, const scalar r) const
Definition: shifted.C:64
Namespace for OpenFOAM.