wordPairHashes.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) 2015 OpenFOAM Foundation
9  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
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 
27 Alias
28  Foam::WordPairMap
29  A HashTable to objects of type <T> with a wordPair key.
30 
31 Typedef
32  Foam::wordPairHashSet
33 
34 Description
35  A HashSet for a wordPair.
36 
37 Typedef
38  Foam::wordPairHashTable
39 
40 Description
41  HashTable of wordPair
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef wordPairHashes_H
46 #define wordPairHashes_H
47 
48 #include "wordPair.H"
49 #include "HashSet.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55  template<class T>
56  using WordPairMap = HashTable<T, wordPair, Foam::Hash<wordPair>>;
57 
58  typedef HashSet<wordPair, Foam::Hash<wordPair>> wordPairHashSet;
59 
60  typedef HashTable<word, wordPair, Foam::Hash<wordPair>> wordPairHashTable;
61 }
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 #endif
66 
67 // ************************************************************************* //
Foam::wordPairHashSet
HashSet< wordPair, Foam::Hash< wordPair > > wordPairHashSet
A HashSet for a wordPair.
Definition: wordPairHashes.H:58
Foam::HashSet
A HashTable with keys but without contents that is similar to std::unordered_set.
Definition: HashSet.H:77
wordPair.H
HashSet.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::HashTable
A HashTable similar to std::unordered_map.
Definition: HashTable.H:105
Foam::wordPairHashTable
HashTable< word, wordPair, Foam::Hash< wordPair > > wordPairHashTable
HashTable of wordPair.
Definition: wordPairHashes.H:60