src/lagrangian/molecularDynamics/potential/tetherPotential/tetherPotentialList/tetherPotentialListI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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::tetherPotentialList::tetherPotentialIndex
  30 (
  31     const label a
  32 ) const
  33 {
  34     label index = idMap_[a];
  35
  36     if (index == -1 || a >= idMap_.size())
  37     {
  38         FatalErrorIn
  39         (
  40             "Foam::tetherPotentialList::tetherPotentialIndex(const label a)"
  41         )
  42             << "Attempting to access an undefined tetherPotential."
  43             << abort(FatalError);
  44
  45         return -1;
  46     }
  47     else
  48     {
  49         return index;
  50     }
  51 }
  52
  53
  54 // ************************************************************************* //