src/triSurface/tools/labelPair/labelPairLookup.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 Typedef
  25     Foam::labelPairLookup
  26
  27 Description
  28     A HashTable for two labels to another label.
  29     Used for e.g. for face1, face2 to shared edge.
  30
  31 Note
  32     The hash table is based on a FixedList and not edge, since an edge
  33     hashes commutatively!
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef labelPairLookup_H
  38 #define labelPairLookup_H
  39
  40 #include "FixedList.H"
  41 #include "HashTable.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47     typedef HashTable
  48     <
  49        label,
  50        FixedList<label, 2>,
  51        FixedList<label, 2>::Hash<>
  52     > labelPairLookup;
  53 }
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 #endif
  58
  59 // ************************************************************************* //