coulomb.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 | Copyright (C) 2011 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 "coulomb.H"
27 #include "mathematicalConstants.H"
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace pairPotentials
35 {
36 
37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
38 
39 defineTypeNameAndDebug(coulomb, 0);
40 
42 (
43  pairPotential,
44  coulomb,
45  dictionary
46 );
47 
49  1.0/(4.0*constant::mathematical::pi*8.854187817e-12);
50 
51 
52 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
53 
55 (
56  const word& name,
57  const dictionary& pairPotentialProperties
58 )
59 :
60  pairPotential(name, pairPotentialProperties)
61 {
62  setLookupTables();
63 }
64 
65 
66 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
67 
68 scalar coulomb::unscaledEnergy(const scalar r) const
69 {
70  return oneOverFourPiEps0/r;
71 }
72 
73 
74 bool coulomb::read(const dictionary& pairPotentialProperties)
75 {
76  pairPotential::read(pairPotentialProperties);
77 
78  return true;
79 }
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace pairPotentials
85 } // End namespace Foam
86 
87 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
static scalar oneOverFourPiEps0
Definition: coulomb.H:62
virtual bool read(const dictionary &pairPotentialProperties)=0
Read pairPotential dictionary.
Macros for easy insertion into run-time selection tables.
scalar unscaledEnergy(const scalar r) const
Definition: coulomb.C:68
A class for handling words, derived from string.
Definition: word.H:59
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
coulomb(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: coulomb.C:55
defineTypeNameAndDebug(azizChen, 0)
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: coulomb.C:74
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
Namespace for OpenFOAM.