The open source CFD toolbox
labelPairHashes.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011 OpenFOAM Foundation
9 Copyright (C) 2017-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Alias
28 Foam::LabelPairMap
29
30Description
31 A HashTable to objects of type <T> with a labelPair key.
32 The hashing is based on labelPair (FixedList) and is thus non-commutative.
33 For commutative hashing, an EdgeMap can be used.
34
35Typedef
36 Foam::labelPairHashSet
37
38Description
39 A HashSet for a labelPair.
40 The hashing is based on labelPair (FixedList) and is thus non-commutative.
41
42Typedef
43 Foam::labelPairLookup
44
45Description
46 This is a Map of a labelPair to a label.
47 Used for e.g. for face1, face2 to shared edge.
48 The hashing is based on labelPair (FixedList) and is thus non-commutative.
49
50\*---------------------------------------------------------------------------*/
51
52#ifndef labelPairHashes_H
53#define labelPairHashes_H
54
55#include "labelPair.H"
56#include "HashSet.H"
57
58// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59
60namespace Foam
61{
62 template<class T>
64
66
68}
69
70// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71
72#endif
73
74// ************************************************************************* //
A HashTable with keys but without contents that is similar to std::unordered_set.
Definition: HashSet.H:96
A HashTable similar to std::unordered_map.
Definition: HashTable.H:123
Namespace for OpenFOAM.
HashTable< label, labelPair, Foam::Hash< labelPair > > labelPairLookup
This is a Map of a labelPair to a label. Used for e.g. for face1, face2 to shared edge....
HashSet< labelPair, Foam::Hash< labelPair > > labelPairHashSet
A HashSet for a labelPair. The hashing is based on labelPair (FixedList) and is thus non-commutative.