FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

tetherPotentialListI.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 \*---------------------------------------------------------------------------*/
00025 
00026 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
00027 
00028 inline Foam::label Foam::tetherPotentialList::tetherPotentialIndex
00029 (
00030     const label a
00031 ) const
00032 {
00033     label index = idMap_[a];
00034 
00035     if (index == -1 || a >= idMap_.size())
00036     {
00037         FatalErrorIn
00038         (
00039             "Foam::tetherPotentialList::tetherPotentialIndex(const label a)"
00040         )
00041         << "Attempting to access an undefined tetherPotential."
00042         << abort(FatalError);
00043 
00044         return -1;
00045     }
00046     else
00047     {
00048         return index;
00049     }
00050 }
00051 
00052 
00053 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines