lennardJones.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 "lennardJones.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace pairPotentials
36 {
37 
38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 
40 defineTypeNameAndDebug(lennardJones, 0);
41 
43 (
44  pairPotential,
45  lennardJones,
46  dictionary
47 );
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& pairPotentialProperties
56 )
57 :
58  pairPotential(name, pairPotentialProperties),
59  lennardJonesCoeffs_(pairPotentialProperties.subDict(typeName + "Coeffs")),
60  sigma_(lennardJonesCoeffs_.get<scalar>("sigma")),
61  epsilon_(lennardJonesCoeffs_.get<scalar>("epsilon"))
62 {
63  setLookupTables();
64 }
65 
66 
67 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
68 
69 scalar lennardJones::unscaledEnergy(const scalar r) const
70 {
71  // (rIJ/sigma)^-2
72  scalar ir2 = (sigma_/r)*(sigma_/r);
73 
74  // (rIJ/sigma)^-6
75  scalar ir6 = ir2*ir2*ir2;
76 
77  return 4.0 * epsilon_*(ir6*(ir6 - 1.0));
78 }
79 
80 
81 bool lennardJones::read(const dictionary& pairPotentialProperties)
82 {
84 
85  lennardJonesCoeffs_ = pairPotentialProperties.subDict(typeName + "Coeffs");
86 
87  lennardJonesCoeffs_.readEntry("sigma", sigma_);
88  lennardJonesCoeffs_.readEntry("epsilon", epsilon_);
89 
90  return true;
91 }
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace pairPotentials
97 } // End namespace Foam
98 
99 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pairPotentials::addToRunTimeSelectionTable
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
Foam::dictionary::subDict
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:460
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::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)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::pairPotential::pairPotentialProperties
const dictionary & pairPotentialProperties() const
Definition: pairPotential.H:172
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotentials::lennardJones::read
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: lennardJones.C:81
Foam::pairPotentials::lennardJones::lennardJones
lennardJones(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: lennardJones.C:53
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
Foam::pairPotentials::lennardJones::unscaledEnergy
scalar unscaledEnergy(const scalar r) const
Definition: lennardJones.C:69
lennardJones.H