src/lagrangian/molecularDynamics/potential/pairPotential/pairPotentialList/pairPotentialListI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  28
  29 inline Foam::label Foam::pairPotentialList::pairPotentialIndex
  30 (
  31     const label a,
  32     const label b
  33 ) const
  34 {
  35     label index;
  36
  37     if (a < b)
  38     {
  39         index = a*(2*nIds_ - a - 1)/2 + b;
  40     }
  41
  42     else
  43     {
  44         index = b*(2*nIds_ - b - 1)/2 + a;
  45     }
  46
  47     if (index > size() - 1)
  48     {
  49         FatalErrorIn("Foam::pairPotentialList::pairPotentialIndex ")
  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 // ************************************************************************* //