exponentialRepulsion.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 #include "exponentialRepulsion.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace pairPotentials
34 {
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
38 defineTypeNameAndDebug(exponentialRepulsion, 0);
39 
41 (
42  pairPotential,
43  exponentialRepulsion,
44  dictionary
45 );
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const word& name,
53  const dictionary& exponentialRepulsion
54 )
55 :
56  pairPotential(name, exponentialRepulsion),
57  exponentialRepulsionCoeffs_
58  (
59  exponentialRepulsion.subDict(typeName + "Coeffs")
60  ),
61  rm_(exponentialRepulsionCoeffs_.template lookup<scalar>("rm")),
62  epsilon_(exponentialRepulsionCoeffs_.template lookup<scalar>("epsilon"))
63 {
64  setLookupTables();
65 }
66 
67 
68 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
69 
70 scalar exponentialRepulsion::unscaledEnergy(const scalar r) const
71 {
72  return epsilon_ * exp(-r/rm_);
73 }
74 
75 
76 bool exponentialRepulsion::read(const dictionary& exponentialRepulsion)
77 {
78  pairPotential::read(exponentialRepulsion);
79 
80  exponentialRepulsionCoeffs_ =
81  exponentialRepulsion.subDict(typeName + "Coeffs");
82 
83  exponentialRepulsionCoeffs_.lookup("rm") >> rm_;
84  exponentialRepulsionCoeffs_.lookup("epsilon") >> epsilon_;
85 
86  return true;
87 }
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace pairPotentials
93 } // End namespace Foam
94 
95 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual bool read(const dictionary &pairPotentialProperties)=0
Read pairPotential dictionary.
exponentialRepulsion(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Macros for easy insertion into run-time selection tables.
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:934
dimensionedScalar exp(const dimensionedScalar &ds)
A class for handling words, derived from string.
Definition: word.H:59
defineTypeNameAndDebug(azizChen, 0)
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
Namespace for OpenFOAM.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:812