maitlandSmith.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::pairPotentials::maitlandSmith
28 
29 Description
30 
31  Reference:
32  \verbatim
33  Maitland, G. C., & Smith, E. B. (1973).
34  A simplified representation of intermolecular potential energy.
35  Chemical Physics Letters, 22(3), 443-446.
36  \endverbatim
37 
38  Parameters for other monoatomics from:
39  \verbatim
40  Maitland, G. C., Rigby, M., Smith, E., Wakeham, W. (1981).
41  Intermolecular forces: Their origin and determination.
42  Oxford: Clarendon Press.
43  \endverbatim
44 
45 SourceFiles
46  maitlandSmith.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef maitlandSmith_H
51 #define maitlandSmith_H
52 
53 #include "pairPotential.H"
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 namespace pairPotentials
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class maitlandSmith Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 class maitlandSmith
68 :
69  public pairPotential
70 {
71  // Private data
72 
73  dictionary maitlandSmithCoeffs_;
74 
75  scalar m_;
76  scalar gamma_;
77  scalar rm_;
78  scalar epsilon_;
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("maitlandSmith");
85 
86 
87  // Constructors
88 
89  //- Construct from components
91  (
92  const word& name,
94  );
95 
96 
97  //- Destructor
99  {}
100 
101 
102  // Member Functions
103 
104  scalar unscaledEnergy(const scalar r) const;
105 
106  //- Read dictionary
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace pairPotentials
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pairPotentials::maitlandSmith::TypeName
TypeName("maitlandSmith")
Runtime type information.
Foam::pairPotentials::maitlandSmith::maitlandSmith
maitlandSmith(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: maitlandSmith.C:53
Foam::pairPotentials::maitlandSmith::unscaledEnergy
scalar unscaledEnergy(const scalar r) const
Definition: maitlandSmith.C:71
Foam::pairPotentials::maitlandSmith::read
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: maitlandSmith.C:83
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::pairPotential
Definition: pairPotential.H:60
Foam::pairPotentials::maitlandSmith
Reference:
Definition: maitlandSmith.H:66
Foam::pairPotential::pairPotentialProperties
const dictionary & pairPotentialProperties() const
Definition: pairPotential.H:172
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotentials::maitlandSmith::~maitlandSmith
~maitlandSmith()
Destructor.
Definition: maitlandSmith.H:97
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
pairPotential.H