maitlandSmith.C
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 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 \*---------------------------------------------------------------------------*/
27 
28 #include "maitlandSmith.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace pairPotentials
36 {
37 
38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 
40 defineTypeNameAndDebug(maitlandSmith, 0);
41 
43 (
44  pairPotential,
45  maitlandSmith,
46  dictionary
47 );
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
56 )
57 :
59  maitlandSmithCoeffs_(maitlandSmith.subDict(typeName + "Coeffs")),
60  m_(maitlandSmithCoeffs_.get<scalar>("m")),
61  gamma_(maitlandSmithCoeffs_.get<scalar>("gamma")),
62  rm_(maitlandSmithCoeffs_.get<scalar>("rm")),
63  epsilon_(maitlandSmithCoeffs_.get<scalar>("epsilon"))
64 {
65  setLookupTables();
66 }
67 
68 
69 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
70 
71 scalar maitlandSmith::unscaledEnergy(const scalar r) const
72 {
73  scalar nr = (m_ + gamma_*(r/rm_ - 1.0));
74 
75  return epsilon_
76  *(
77  (6.0 / (nr - 6.0))*Foam::pow(r/rm_, -nr)
78  - (nr / (nr - 6.0))*Foam::pow(r/rm_, -6)
79  );
80 }
81 
82 
84 {
86 
87  maitlandSmithCoeffs_ = maitlandSmith.subDict(typeName + "Coeffs");
88 
89  maitlandSmithCoeffs_.readEntry("m", m_);
90  maitlandSmithCoeffs_.readEntry("gamma", gamma_);
91  maitlandSmithCoeffs_.readEntry("rm", rm_);
92  maitlandSmithCoeffs_.readEntry("epsilon", epsilon_);
93 
94  return true;
95 }
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace pairPotentials
101 } // End namespace Foam
102 
103 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pairPotentials::addToRunTimeSelectionTable
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
maitlandSmith.H
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::readEntry
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
Definition: dictionaryTemplates.C:302
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:75
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::defineTypeNameAndDebug
defineTypeNameAndDebug(azizChen, 0)
Foam::pairPotentials::maitlandSmith
Reference:
Definition: maitlandSmith.H:66
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotential::read
virtual bool read(const dictionary &pairPotentialProperties)=0
Read pairPotential dictionary.
Definition: pairPotential.C:224
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59