azizChen.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 "azizChen.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace pairPotentials
36 {
37 
38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 
41 
43 (
45  azizChen,
47 );
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& azizChen
56 )
57 :
59  azizChenCoeffs_(azizChen.subDict(typeName + "Coeffs")),
60  epsilon_(azizChenCoeffs_.get<scalar>("epsilon")),
61  rm_(azizChenCoeffs_.get<scalar>("rm")),
62  A_(azizChenCoeffs_.get<scalar>("A")),
63  alpha_(azizChenCoeffs_.get<scalar>("alpha")),
64  C6_(azizChenCoeffs_.get<scalar>("C6")),
65  C8_(azizChenCoeffs_.get<scalar>("C8")),
66  C10_(azizChenCoeffs_.get<scalar>("C10")),
67  D_(azizChenCoeffs_.get<scalar>("D")),
68  gamma_(azizChenCoeffs_.get<scalar>("gamma"))
69 {
70  setLookupTables();
71 }
72 
73 
74 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
75 
76 scalar azizChen::unscaledEnergy(const scalar r) const
77 {
78  scalar x = r/rm_;
79 
80  scalar F = 1.0;
81 
82  if (x < D_)
83  {
84  F = exp(-pow(((D_ / x) - 1.0),2));
85  }
86 
87  return
88  epsilon_
89  *(
90  A_ * Foam::pow(x, gamma_)*exp(-alpha_*x)
91  - (
92  (C6_/ Foam::pow(x, 6))
93  + (C8_/ Foam::pow(x, 8))
94  + (C10_/ Foam::pow(x, 10))
95  )
96  *F
97  );
98 }
99 
100 
102 {
104 
105  azizChenCoeffs_ = azizChen.subDict(typeName + "Coeffs");
106 
107  azizChenCoeffs_.readEntry("epsilon", epsilon_);
108  azizChenCoeffs_.readEntry("rm", rm_);
109  azizChenCoeffs_.readEntry("A", A_);
110  azizChenCoeffs_.readEntry("alpha", alpha_);
111  azizChenCoeffs_.readEntry("C6", C6_);
112  azizChenCoeffs_.readEntry("C8", C8_);
113  azizChenCoeffs_.readEntry("C10", C10_);
114  azizChenCoeffs_.readEntry("D", D_);
115  azizChenCoeffs_.readEntry("gamma", gamma_);
116 
117  return true;
118 }
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace pairPotentials
124 } // End namespace Foam
125 
126 // ************************************************************************* //
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
List of values generated by applying the access operation to each list item.
azizChen(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: azizChen.C:46
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual bool read(const dictionary &pairPotentialProperties)=0
Read pairPotential dictionary.
Macros for easy insertion into run-time selection tables.
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect...
scalar unscaledEnergy(const scalar r) const
Definition: azizChen.C:69
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
dimensionedScalar exp(const dimensionedScalar &ds)
A class for handling words, derived from Foam::string.
Definition: word.H:63
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: azizChen.C:94
volVectorField F(fluid.F())
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
defineTypeNameAndDebug(azizChen, 0)
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
Namespace for OpenFOAM.