src/OpenFOAM/meshes/polyMesh/globalMeshData/globalIndexI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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 #include "ListOps.H"
  27
  28 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  29
  30 inline Foam::label Foam::globalIndex::offset(const label procI) const
  31 {
  32     return offsets_[procI];
  33 }
  34
  35
  36 inline Foam::label Foam::globalIndex::localSize(const label procI) const
  37 {
  38     return offsets_[procI+1] - offsets_[procI];
  39 }
  40
  41
  42 inline Foam::label Foam::globalIndex::localSize() const
  43 {
  44     return localSize(Pstream::myProcNo());
  45 }
  46
  47
  48 inline Foam::label Foam::globalIndex::size() const
  49 {
  50     return offsets_[Pstream::nProcs()];
  51 }
  52
  53
  54 inline Foam::label Foam::globalIndex::toGlobal
  55 (
  56     const label procI,
  57     const label i
  58 ) const
  59 {
  60     return i + offsets_[procI];
  61 }
  62
  63
  64 inline Foam::label Foam::globalIndex::toGlobal(const label i) const
  65 {
  66     return toGlobal(Pstream::myProcNo(), i);
  67 }
  68
  69
  70 //- Is on local processor
  71 inline bool Foam::globalIndex::isLocal(const label procI, const label i) const
  72 {
  73     return i >= offsets_[procI] && i < offsets_[procI+1];
  74 }
  75
  76
  77 inline bool Foam::globalIndex::isLocal(const label i) const
  78 {
  79     return isLocal(Pstream::myProcNo(), i);
  80 }
  81
  82
  83 inline Foam::label Foam::globalIndex::toLocal(const label procI, const label i)
  84 const
  85 {
  86     label localI = i - offsets_[procI];
  87
  88     if (localI < 0 || i >= offsets_[procI+1])
  89     {
  90         FatalErrorIn("globalIndex::toLocal(const label, const label)")
  91             << "Global " << i << " does not belong on processor "
  92             << procI << endl << "Offsets:" << offsets_
  93             << abort(FatalError);
  94     }
  95     return localI;
  96 }
  97
  98
  99 inline Foam::label Foam::globalIndex::toLocal(const label i) const
 100 {
 101     return toLocal(Pstream::myProcNo(), i);
 102 }
 103
 104
 105 inline Foam::label Foam::globalIndex::whichProcID(const label i) const
 106 {
 107     if (i < 0 || i >= offsets_[Pstream::nProcs()])
 108     {
 109         FatalErrorIn("globalIndex::whichProcID(const label)")
 110             << "Global " << i << " does not belong on any processor."
 111             << " Offsets:" << offsets_
 112             << abort(FatalError);
 113     }
 114
 115     return findLower(offsets_, i+1);
 116 }
 117
 118
 119 // ************************************************************************* //