coulomb.H
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 Class
27  Foam::pairPotentials::coulomb
28 
29 Description
30 
31 
32 SourceFiles
33  coulomb.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef coulomb_H
38 #define coulomb_H
39 
40 #include "pairPotential.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace pairPotentials
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class coulomb Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class coulomb
54 :
55  public pairPotential
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("coulomb");
61 
62 
63  // Static data members
64 
65  static scalar oneOverFourPiEps0;
66 
67  // Constructors
68 
69  //- Construct from components
70  coulomb
71  (
72  const word& name,
74  );
75 
76 
77  //- Destructor
78  ~coulomb()
79  {}
80 
81 
82  // Member Functions
83 
84  scalar unscaledEnergy(const scalar r) const;
85 
86  //- Read dictionary
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace pairPotentials
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
Foam::pairPotentials::coulomb::~coulomb
~coulomb()
Destructor.
Definition: coulomb.H:77
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::pairPotentials::coulomb::coulomb
coulomb(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: coulomb.C:57
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::pairPotential
Definition: pairPotential.H:60
Foam::pairPotential::pairPotentialProperties
const dictionary & pairPotentialProperties() const
Definition: pairPotential.H:172
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotentials::coulomb::read
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: coulomb.C:76
Foam::pairPotentials::coulomb::TypeName
TypeName("coulomb")
Runtime type information.
Foam::pairPotentials::coulomb
Definition: coulomb.H:52
pairPotential.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