FreeFOAM The Cross-Platform CFD Toolkit
shifted.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2008-2010 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
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 
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 
80  {}
81 
82 
83  // Member Functions
84 
85  void scaleEnergy(scalar& e, const scalar r) const;
86 
87  //- Read dictionary
88  bool read(const dictionary& energyScalingFunctionProperties);
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace energyScalingFunctions
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************ vim: set sw=4 sts=4 et: ************************ //