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