OpenFOAM: API Guide
v2112
The open source CFD toolbox
electrostaticPotential.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::electrostaticPotential
28
29
Description
30
31
32
SourceFiles
33
electrostaticPotential.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef electrostaticPotential_H
38
#define electrostaticPotential_H
39
40
#include "
scalar.H
"
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class electrostaticPotential Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
electrostaticPotential
52
{
53
// Private data
54
55
scalar prefactor;
56
57
58
public
:
59
60
// Constructors
61
62
//- Construct and set prefactor
63
electrostaticPotential
();
64
65
66
//- Destructor
67
~electrostaticPotential
()
68
{}
69
70
71
// Member Functions
72
73
scalar
energy
(
const
scalar r)
const
;
74
75
scalar
force
(
const
scalar r)
const
;
76
};
77
78
79
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80
81
}
// End namespace Foam
82
83
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84
85
#endif
86
87
// ************************************************************************* //
Foam::electrostaticPotential::force
scalar force(const scalar r) const
Definition:
electrostaticPotential.C:46
Foam::electrostaticPotential::~electrostaticPotential
~electrostaticPotential()
Destructor.
Definition:
electrostaticPotential.H:66
Foam::electrostaticPotential
Definition:
electrostaticPotential.H:50
Foam::electrostaticPotential::electrostaticPotential
electrostaticPotential()
Construct and set prefactor.
Definition:
electrostaticPotential.C:33
scalar.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::electrostaticPotential::energy
scalar energy(const scalar r) const
Definition:
electrostaticPotential.C:40
src
lagrangian
molecularDynamics
potential
electrostaticPotential
electrostaticPotential.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.