ug4
pcl_debug.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010-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__PCL_DEBUG__
34 #define __H__PCL_DEBUG__
35 
36 #include <iostream>
37 #include "pcl_base.h"
38 #include "pcl_methods.h"
42 
45 
46 #define PCLLOG(msg) UG_LOG(msg)
47 
48 
49 namespace pcl
50 {
51 
54 
56 // LogLayoutStructure
58 
61 template <class TLayout>
62 void LogLayoutStructure(TLayout& layout, const char* prefix = "")
63 {
64  using namespace std;
65 
66  typedef typename TLayout::Interface Interface;
67  typedef typename TLayout::iterator InterfaceIter;
68 
69  PCLLOG(prefix << "-- PCL_DEBUG: layout-structure --\n");
70  PCLLOG(prefix << "---- num_levels: " << layout.num_levels() << endl);
71 
72  for(size_t lvl = 0; lvl < layout.num_levels(); ++lvl)
73  {
74  PCLLOG(prefix << "---- interfaces on level " << lvl << " (proc id, size): ");
75 
76  for(InterfaceIter iiter = layout.begin(lvl);
77  iiter != layout.end(lvl); ++iiter)
78  {
79  Interface& interface = layout.interface(iiter);
80  PCLLOG("(" << layout.proc_id(iiter) << ", " << interface.size() << "), ");
81  }
82  PCLLOG(endl);
83  }
84 }
85 
87 // LogLayoutMapStrucure
89 
92 template <class TType, class TLayoutMap>
93 void LogLayoutMapStructure(TLayoutMap& lm)
94 {
95  using namespace std;
96 
97  typedef typename TLayoutMap::template Types<TType>::Map::iterator iterator;
98  typedef typename TLayoutMap::template Types<TType>::Layout Layout;
99 
100  PCLLOG("-- PCL_DEBUG: layout-map-structure --\n");
101 
102  for(iterator iter = lm.template layouts_begin<TType>();
103  iter != lm.template layouts_end<TType>(); ++iter)
104  {
105  // get the key
106  PCLLOG("---- has key: " << iter->first << endl);
107 
108  // log the layout structure
109  Layout& layout = iter->second;
110  LogLayoutStructure(layout, "----");
111  }
112 }
113 
114 // end group pcl
116 
117 }// end of namespace
118 
119 #endif
void LogLayoutMapStructure(TLayoutMap &lm)
Logs the internals of a layout-map for a given type.
Definition: pcl_debug.h:93
void LogLayoutStructure(TLayout &layout, const char *prefix="")
Logs the internals of a layout.
Definition: pcl_debug.h:62
Definition: parallel_grid_layout.h:46
Definition: smart_pointer.h:814
#define PCLLOG(msg)
this allows us to print messages to the users terminal
Definition: pcl_debug.h:46