Loading [MathJax]/extensions/tex2jax.js
ug4
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
grid_object_id.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2013-2015: G-CSC, Goethe University Frankfurt
3 * Author: Sebastian Reiter
4 *
5 * This file is part of UG4.
6 *
7 * UG4 is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License version 3 (as published by the
9 * Free Software Foundation) with the following additional attribution
10 * requirements (according to LGPL/GPL v3 §7):
11 *
12 * (1) The following notice must be displayed in the Appropriate Legal Notices
13 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14 *
15 * (2) The following notice must be displayed at a prominent place in the
16 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17 *
18 * (3) The following bibliography is recommended for citation and must be
19 * preserved in all covered files:
20 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21 * parallel geometric multigrid solver on hierarchically distributed grids.
22 * Computing and visualization in science 16, 4 (2013), 151-164"
23 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24 * flexible software system for simulating pde based models on high performance
25 * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26 *
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU Lesser General Public License for more details.
31 */
32
33#ifndef __H__LIB_GRID__GEOMETRIC_OBJECT_ID__
34#define __H__LIB_GRID__GEOMETRIC_OBJECT_ID__
35
36#include <algorithm>
37#include <ostream>
40
41namespace ug{
42
45
48
52typedef std::pair<int, size_t> GeomObjID;
53
54UG_API std::ostream& operator<<(std::ostream& out, const GeomObjID& goId);
55
56UG_API bool operator<(const GeomObjID& gid1, const GeomObjID& gid2);
57
60inline GeomObjID MakeGeomObjID(int procRank, size_t localGeomObjID)
61{
62 return std::make_pair(procRank, localGeomObjID);
63}
64
68
71
73
74template <>
75size_t hash_key<GeomObjID>(const GeomObjID& key);
76
77}// end of namespace
78
79#endif
A generic specialization of IAttachment.
Definition attachment_pipe.h:263
AGeomObjID aGeomObjID
This attachment instance should be used to store global ids.
Attachment< GeomObjID > AGeomObjID
An attachment which can store GeomObjIDs.
Definition grid_object_id.h:67
size_t hash_key< GeomObjID >(const GeomObjID &key)
generates a hash key for a GeomObjID.
Definition parallel_grid_layout.cpp:40
std::pair< int, size_t > GeomObjID
The global id can be used to uniquely identify distributed objects.
Definition grid_object_id.h:52
GeomObjID MakeGeomObjID(int procRank, size_t localGeomObjID)
Can be used to construct a GeomObjID from a proc-rank and a local id.
Definition grid_object_id.h:60
std::ostream & operator<<(std::ostream &outStream, const ug::MathMatrix< 2, 2 > &m)
Definition math_matrix.cpp:38
#define UG_API
Definition ug_config.h:65
bool operator<(const MathVector< N, T > &v, const MathVector< N, T > &w)
Definition math_vector.h:541
the ug namespace