initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / OpenFOAM / meshes / meshShapes / edge / EdgeMap.H
blob7767fab30e8c3372f54a8d67cfad8f1261cee829
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::EdgeMap
28 Description
29     Map from edge (expressed as its endpoints) to value
31 \*---------------------------------------------------------------------------*/
33 #ifndef EdgeMap_H
34 #define EdgeMap_H
36 #include "HashTable.H"
37 #include "edge.H"
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 namespace Foam
44 /*---------------------------------------------------------------------------*\
45                            Class EdgeMap Declaration
46 \*---------------------------------------------------------------------------*/
48 template<class T>
49 class EdgeMap
51     public HashTable<T, edge, Hash<edge> >
54 public:
56     // Constructors
58         //- Construct given initial map size
59         EdgeMap(const label size = 128)
60         :
61             HashTable<T, edge, Hash<edge> >(size)
62         {}
64         //- Construct from Istream
65         EdgeMap(Istream& is)
66         :
67             HashTable<T, edge, Hash<edge> >(is)
68         {}
70         //- Construct as copy
71         EdgeMap(const EdgeMap<T>& map)
72         :
73             HashTable<T, edge, Hash<edge> >(map)
74         {}
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 } // End namespace Foam
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 #endif
86 // ************************************************************************* //