OpenFOAM logo
Open Source CFD Toolkit

Hash.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     Hash
00027 
00028 Description
00029     Hash function class for primitives.  All non-primitives used to hash
00030     entries on hash tables need a specialised version of this class.
00031 
00032 \*---------------------------------------------------------------------------*/
00033 
00034 #ifndef Hash_H
00035 #define Hash_H
00036 
00037 #include "label.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class Hash Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 template<class primitive>
00049 class Hash
00050 {
00051 
00052 public:
00053 
00054     Hash()
00055     {}
00056 
00057     label operator()(const primitive& p) const
00058     {
00059         return label(p);
00060     }
00061 
00062     label operator()(const primitive& p, const label tableSize) const
00063     {
00064         return mag(operator()(p)) % tableSize;
00065     }
00066 };
00067 
00068 
00069 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00070 
00071 } // End namespace Foam
00072 
00073 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00074 
00075 #endif
00076 
00077 // ************************************************************************* //
For further information go to www.openfoam.org