Map.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2024 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 Class
25  Foam::Map
26 
27 Description
28  A HashTable to objects of type <T> with a label key.
29 
30 See also
31  PtrMap
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Map_H
36 #define Map_H
37 
38 #include "HashTable.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class Map Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class T>
50 class Map
51 :
52  public HashTable<T, label, Hash<label>>
53 {
54 
55 public:
56 
57  // Constructors
58 
59  using HashTable<T, label, Hash<label>>::HashTable;
60 };
61 
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 } // End namespace Foam
66 
67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68 
69 #endif
70 
71 // ************************************************************************* //
Foam::HashTable
An STL-conforming hash table.
Definition: HashTable.H:127
Foam::HashTable< T, label, Hash< label > >::HashTable
HashTable(const label size=128)
Construct given initial table size.
Definition: HashTable.C:36
Foam::Map
A HashTable to objects of type <T> with a label key.
Definition: Map.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214