OpenFOAM: API Guide
v2112
The open source CFD toolbox
pairPotentialListI.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-2015 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
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29
30
inline
Foam::label Foam::pairPotentialList::pairPotentialIndex
31
(
32
const
label a,
33
const
label
b
34
)
const
35
{
36
label index;
37
38
if
(a <
b
)
39
{
40
index = a*(2*nIds_ - a - 1)/2 +
b
;
41
}
42
else
43
{
44
index =
b
*(2*nIds_ -
b
- 1)/2 + a;
45
}
46
47
if
(index > size() - 1)
48
{
49
FatalErrorInFunction
50
<<
"Attempting to access a pairPotential with too high an index."
51
<<
nl
<<
"a = "
<< a <<
", b = "
<<
b
<<
", index = "
<< index
52
<<
nl
<<
"max index = "
<< size() - 1
53
<<
nl
<<
abort
(
FatalError
);
54
}
55
56
return
index;
57
}
58
59
60
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
61
62
inline
Foam::scalar
Foam::pairPotentialList::rCutMax
()
const
63
{
64
return
rCutMax_;
65
}
66
67
68
inline
Foam::scalar
Foam::pairPotentialList::rCutMaxSqr
()
const
69
{
70
return
rCutMaxSqr_;
71
}
72
73
74
inline
const
Foam::pairPotential
&
Foam::pairPotentialList::electrostatic
()
const
75
{
76
return
*electrostaticPotential_;
77
}
78
79
80
// ************************************************************************* //
Foam::pairPotentialList::electrostatic
const pairPotential & electrostatic() const
Definition:
pairPotentialListI.H:74
Foam::pairPotentialList::rCutMaxSqr
scalar rCutMaxSqr() const
Definition:
pairPotentialListI.H:68
Foam::constant::physicoChemical::b
const dimensionedScalar b
Wien displacement law constant: default SI units: [m.K].
Definition:
createFields.H:27
Foam::FatalError
error FatalError
Foam::pairPotential
Definition:
pairPotential.H:60
Foam::abort
errorManip< error > abort(error &err)
Definition:
errorManip.H:144
Foam::pairPotentialList::rCutMax
scalar rCutMax() const
Definition:
pairPotentialListI.H:62
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition:
error.H:453
Foam::nl
constexpr char nl
Definition:
Ostream.H:404
src
lagrangian
molecularDynamics
potential
pairPotential
pairPotentialList
pairPotentialListI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.