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 | Copyright (C) 2011-2015 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
27 
28 inline Foam::label Foam::pairPotentialList::pairPotentialIndex
29 (
30  const label a,
31  const label b
32 ) const
33 {
34  label index;
35 
36  if (a < b)
37  {
38  index = a*(2*nIds_ - a - 1)/2 + b;
39  }
40 
41  else
42  {
43  index = b*(2*nIds_ - b - 1)/2 + a;
44  }
45 
46  if (index > size() - 1)
47  {
49  << "Attempting to access a pairPotential with too high an index."
50  << nl << "a = " << a << ", b = " << b << ", index = " << index
51  << nl << "max index = " << size() - 1
52  << nl << abort(FatalError);
53  }
54 
55  return index;
56 }
57 
58 
59 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
60 
61 inline Foam::scalar Foam::pairPotentialList::rCutMax() const
62 {
63  return rCutMax_;
64 }
65 
66 
67 inline Foam::scalar Foam::pairPotentialList::rCutMaxSqr() const
68 {
69  return rCutMaxSqr_;
70 }
71 
72 
74 {
75  return electrostaticPotential_;
76 }
77 
78 
79 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
error FatalError
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
errorManip< error > abort(error &err)
Definition: errorManip.H:131
static const char nl
Definition: Ostream.H:262
label size() const
Return the number of elements in the UPtrList.
Definition: UPtrListI.H:29
const pairPotential & electrostatic() const