EdgeMap.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-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::EdgeMap
28 
29 Description
30  Map from edge (expressed as its endpoints) to value.
31  For easier forward declaration it is currently implemented as a
32  separate class rather than a template alias.
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef EdgeMap_H
37 #define EdgeMap_H
38 
39 #include "edge.H"
40 #include "HashTable.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class EdgeMap Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class T>
52 class EdgeMap
53 :
54  public HashTable<T, edge, Hash<edge>>
55 {
56 public:
57 
58  //- Inherit constructors from HashTable
59  using HashTable<T, edge, Hash<edge>>::HashTable;
60 
61 };
62 
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 } // End namespace Foam
67 
68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
69 
70 #endif
71 
72 // ************************************************************************* //
HashTable.H
Foam::HashTable< T, edge, Hash< edge > >::HashTable
HashTable()
Default construct with default (128) table capacity.
Definition: HashTable.C:39
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
edge.H
Foam::HashTable
A HashTable similar to std::unordered_map.
Definition: HashTable.H:105
Foam::EdgeMap
Map from edge (expressed as its endpoints) to value. For easier forward declaration it is currently i...
Definition: EdgeMap.H:51