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 | 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 "coulomb.H"
29 #include "mathematicalConstants.H"
31 
32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace pairPotentials
37 {
38 
39 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
40 
41 defineTypeNameAndDebug(coulomb, 0);
42 
44 (
45  pairPotential,
46  coulomb,
47  dictionary
48 );
49 
51  1.0/(4.0*constant::mathematical::pi*8.854187817e-12);
52 
53 
54 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
55 
57 (
58  const word& name,
59  const dictionary& pairPotentialProperties
60 )
61 :
62  pairPotential(name, pairPotentialProperties)
63 {
64  setLookupTables();
65 }
66 
67 
68 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
69 
70 scalar coulomb::unscaledEnergy(const scalar r) const
71 {
72  return oneOverFourPiEps0/r;
73 }
74 
75 
76 bool coulomb::read(const dictionary& pairPotentialProperties)
77 {
79 
80  return true;
81 }
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace pairPotentials
87 } // End namespace Foam
88 
89 // ************************************************************************* //
mathematicalConstants.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pairPotentials::addToRunTimeSelectionTable
addToRunTimeSelectionTable(pairPotential, azizChen, dictionary)
Foam::pairPotentials::coulomb::coulomb
coulomb(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: coulomb.C:57
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::constant::mathematical::pi
constexpr scalar pi(M_PI)
Foam::pairPotentials::coulomb::read
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: coulomb.C:76
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
coulomb.H
Foam::pairPotentials::coulomb::oneOverFourPiEps0
static scalar oneOverFourPiEps0
Definition: coulomb.H:64
Foam::pairPotentials::coulomb::unscaledEnergy
scalar unscaledEnergy(const scalar r) const
Definition: coulomb.C:70