CartDecomposition.hpp 23.2 KB
Newer Older
incardon's avatar
incardon committed
1
2
3
4
5
6
7
8
9
10
11
/*
 * CartDecomposition.hpp
 *
 *  Created on: Aug 15, 2014
 *      Author: Pietro Incardona
 */

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
12
13
#include "VCluster.hpp"
#include "Graph/CartesianGraphFactory.hpp"
incardon's avatar
incardon committed
14
#include "Decomposition.hpp"
incardon's avatar
incardon committed
15
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
16
17
18
19
20
21
#include <vector>
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "metis_util.hpp"
#include "dec_optimizer.hpp"
#include "Space/Shape/Box.hpp"
incardon's avatar
incardon committed
22
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
23
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
24
25
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
26
#include "Space/Ghost.hpp"
incardon's avatar
incardon committed
27
28
#include "common.hpp"
#include "ie_loc_ghost.hpp"
29
30
#include "ie_ghost.hpp"
#include "nn_processor.hpp"
incardon's avatar
incardon committed
31

32
33
34
35
36
37
38
39
40
41
42
#define CARTDEC_ERROR 2000lu

// Macro that decide what to do in case of error
#ifdef STOP_ON_ERROR
#define ACTION_ON_ERROR() exit(1);
#elif defined(THROW_ON_ERROR)
#define ACTION_ON_ERROR() throw CARTDEC_ERROR;
#else
#define ACTION_ON_ERROR()
#endif

incardon's avatar
incardon committed
43
44
45
46
47
48
49
50
/**
 * \brief This class decompose a space into subspaces
 *
 * \tparam dim is the dimensionality of the physical domain we are going to decompose.
 * \tparam T type of the space we decompose, Real, Integer, Complex ...
 * \tparam Memory Memory factory used to allocate memory
 * \tparam Domain Structure that contain the information of your physical domain
 *
51
52
 * Given an N-dimensional space, this class decompose the space into a Cartesian grid of small
 * sub-sub-domain. At each sub-sub-domain is assigned  an id that identify which processor is
incardon's avatar
incardon committed
53
 * going to take care of that part of space (in general the space assigned to a processor is
54
55
56
57
58
59
 * simply connected), a second step merge several sub-sub-domain with same id into bigger region
 *  sub-domain with the id. Each sub-domain has an extended space called ghost part
 *
 * Assuming that VCluster.getProcessUnitID(), equivalent to the MPI processor rank, return the processor local
 * processor id, we define
 *
60
61
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
62
63
64
65
66
67
68
69
70
71
72
73
 * * external ghost box: (or ghost box) are the boxes that compose the ghost space of the processor, or the
 *   boxes produced expanding every local sub-domain by the ghost extension and intersecting with the sub-domain
 *   of the other processors
 * * Near processors are the processors adjacent to the local processor, where with adjacent we mean all the processor
 *   that has a non-zero intersection with the ghost part of the local processor, or all the processors that
 *   produce non-zero external boxes with the local processor, or all the processor that should communicate
 *   in case of ghost data synchronization
 * * internal ghost box: is the part of ghost of the near processor that intersect the space of the
 *       processor, or the boxes produced expanding the sub-domain of the near processors with the local sub-domain
 * * Near processor sub-domain: is a sub-domain that live in the a near (or contiguous) processor
 * * Near processor list: the list of all the near processor of the local processor (each processor has a list
 *                        of the near processor)
incardon's avatar
incardon committed
74
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
75
76
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
77
 *
78
79
80
 * ### Create a Cartesian decomposition object on a Box space, distribute, calculate internal and external ghost boxes
 * \snippet CartDecomposition_unit_test.hpp Create CartDecomposition
 *
incardon's avatar
incardon committed
81
82
 */

83
template<unsigned int dim, typename T, typename Memory=HeapMemory, template<unsigned int, typename> class Domain=Box>
incardon's avatar
incardon committed
84
class CartDecomposition : public ie_loc_ghost<dim,T>, public nn_prcs<dim,T> , public ie_ghost<dim,T>
incardon's avatar
incardon committed
85
{
incardon's avatar
incardon committed
86

incardon's avatar
incardon committed
87
public:
incardon's avatar
incardon committed
88

incardon's avatar
incardon committed
89
90
91
92
93
94
95
96
	//! Type of the domain we are going to decompose
	typedef T domain_type;

	//! It simplify to access the SpaceBox element
	typedef SpaceBox<dim,T> Box;

private:

incardon's avatar
incardon committed
97
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
98
	//! acc_key is size_t
99
	typedef typename openfpm::vector<SpaceBox<dim,T>,Memory,openfpm::vector_grow_policy_default,openfpm::vect_isel<SpaceBox<dim,T>>::value >::access_key acc_key;
incardon's avatar
incardon committed
100
101

	//! the set of all local sub-domain as vector
incardon's avatar
incardon committed
102
	openfpm::vector<SpaceBox<dim,T>> sub_domains;
incardon's avatar
incardon committed
103

incardon's avatar
incardon committed
104
	//! for each sub-domain, contain the list of the neighborhood processors
incardon's avatar
incardon committed
105
106
	openfpm::vector<openfpm::vector<long unsigned int> > box_nn_processor;

incardon's avatar
incardon committed
107
	//! Structure that contain for each sub-sub-domain box the processor id
incardon's avatar
Add ORB    
incardon committed
108
	//! exist for efficient global communication
incardon's avatar
incardon committed
109
110
	openfpm::vector<size_t> fine_s;

incardon's avatar
incardon committed
111
112
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
113

incardon's avatar
incardon committed
114
115
116
	//! Structure that decompose your structure into cell without creating them
	//! useful to convert positions to CellId or sub-domain id in this case
	CellDecomposer_sm<dim,T> cd;
incardon's avatar
incardon committed
117
118
119
120
121
122
123
124
125
126

	//! rectangular domain to decompose
	Domain<dim,T> domain;

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

incardon's avatar
incardon committed
127
128
129
	//! Cell-list that store the geometrical information of the local internal ghost boxes
	CellList<dim,T,FAST> lgeo_cell;

130
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
131
	 *
132
     * \param v_cl Virtual cluster, used internally for communications
133
     *
incardon's avatar
incardon committed
134
135
136
	 */
	void CreateDecomposition(Vcluster & v_cl)
	{
137
138
139
140
141
142
143
#ifdef SE_CLASS1
		if (&v_cl == NULL)
		{
			std::cerr << __FILE__ << ":" << __LINE__ << " error VCluster instance is null, check that you ever initialized it \n";
			ACTION_ON_ERROR()
		}
#endif
incardon's avatar
incardon committed
144
145
146
147
148
149
150
151
		// Calculate the total number of box and and the spacing
		// on each direction
		// Get the box containing the domain
		SpaceBox<dim,T> bs = domain.getBox();

		for (unsigned int i = 0; i < dim ; i++)
		{
			// Calculate the spacing
incardon's avatar
incardon committed
152
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
153
154
155
156
		}

		// Here we use METIS
		// Create a cartesian grid graph
incardon's avatar
incardon committed
157
		CartesianGraphFactory<dim,Graph_CSR<nm_part_v,nm_part_e>> g_factory_part;
incardon's avatar
incardon committed
158
159

		// Processor graph
incardon's avatar
incardon committed
160
		Graph_CSR<nm_part_v,nm_part_e> gp = g_factory_part.template construct<NO_EDGE,T,dim-1>(gr.getSize(),domain);
incardon's avatar
incardon committed
161
162
163
164
165
166
167
168

		// Get the number of processing units
		size_t Np = v_cl.getProcessingUnits();

		// Get the processor id
		long int p_id = v_cl.getProcessUnitID();

		// Convert the graph to metis
incardon's avatar
incardon committed
169
		Metis<Graph_CSR<nm_part_v,nm_part_e>> met(gp,Np);
incardon's avatar
incardon committed
170
171

		// decompose
incardon's avatar
incardon committed
172
		met.decompose<nm_part_v::id>();
incardon's avatar
incardon committed
173

incardon's avatar
Add ORB    
incardon committed
174
		// fill the structure that store the processor id for each sub-domain
incardon's avatar
incardon committed
175
		fine_s.resize(gr.size());
incardon's avatar
Add ORB    
incardon committed
176

incardon's avatar
incardon committed
177
178
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
179
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
180
181
182
183

		// set of Boxes produced by the decomposition optimizer
		openfpm::vector<::Box<dim,size_t>> loc_box;

incardon's avatar
incardon committed
184
		// optimize the decomposition
incardon's avatar
incardon committed
185
186
		d_o.template optimize<nm_part_v::sub_id,nm_part_v::id>(gp,p_id,loc_box,box_nn_processor);

incardon's avatar
incardon committed
187
188
189
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
190
191
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
192
193
194
			sub_d.mul(spacing);
			sub_d.expand(spacing);

195
196
197
198
199
200
201
202
203
204
205
206
207
			// Fixing sub-domains to cover all the domain

			// Fixing sub_d
			// if (loc_box) is a the boundary we have to ensure that the box span the full
			// domain (avoiding rounding off error)
			for (size_t i = 0 ; i < dim ; i++)
			{
				if (sub_dc.getHigh(i) == cd.getGrid().size(i) - 1)
				{
					sub_d.setHigh(i,domain.getHigh(i));
				}
			}

incardon's avatar
incardon committed
208
209
210
211
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
212
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
213
214
215
			bbox = sub_d;
		}

incardon's avatar
incardon committed
216
		// convert into sub-domain
incardon's avatar
incardon committed
217
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
218
		{
219
220
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
221

incardon's avatar
incardon committed
222
223
224
			// re-scale and add spacing (the end is the starting point of the next domain + spacing)
			sub_d.mul(spacing);
			sub_d.expand(spacing);
incardon's avatar
incardon committed
225

226
227
228
229
230
231
232
233
234
235
236
237
238
			// Fixing sub-domains to cover all the domain

			// Fixing sub_d
			// if (loc_box) is a the boundary we have to ensure that the box span the full
			// domain (avoiding rounding off error)
			for (size_t i = 0 ; i < dim ; i++)
			{
				if (sub_dc.getHigh(i) == cd.getGrid().size(i) - 1)
				{
					sub_d.setHigh(i,domain.getHigh(i));
				}
			}

incardon's avatar
incardon committed
239
240
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
241
242
243
244
245
246

			// Calculate the bound box
			bbox.enclose(sub_d);

			// Create the smallest box contained in all sub-domain
			ss_box.contained(sub_d);
incardon's avatar
incardon committed
247
		}
incardon's avatar
incardon committed
248

249
250
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);

incardon's avatar
incardon committed
251
		// fill fine_s structure
incardon's avatar
incardon committed
252
253
254
		// fine_s structure contain the processor id for each sub-sub-domain
		// with sub-sub-domain we mean the sub-domain decomposition before
		// running dec_optimizer (before merging sub-domains)
incardon's avatar
incardon committed
255
256
257
258
259
260
261
262
263
264
265
		auto it = gp.getVertexIterator();

		while (it.isNext())
		{
			size_t key = it.get();

			// fill with the fine decomposition
			fine_s.get(key) = gp.template vertex_p<nm_part_v::id>(key);

			++it;
		}
266
267
268
269
270
271

		// Get the smallest sub-division on each direction
		::Box<dim,T> unit = getSmallestSubdivision();
		// Get the processor bounding Box
		::Box<dim,T> bound = getProcessorBounds();

incardon's avatar
incardon committed
272
		// calculate the sub-divisions
273
274
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
275
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
276
277
278
279
280
281
282
283
284

		// Create shift
		Point<dim,T> orig;

		// p1 point of the Processor bound box is the shift
		for (size_t i = 0 ; i < dim ; i++)
			orig.get(i) = bound.getLow(i);

		// Initialize the geo_cell structure
incardon's avatar
incardon committed
285
		ie_ghost<dim,T>::Initialize_geo_cell(domain,div,orig);
incardon's avatar
incardon committed
286
		lgeo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
287
288
	}

incardon's avatar
incardon committed
289
290
291
	// Save the ghost boundaries
	Ghost<dim,T> ghost;

incardon's avatar
incardon committed
292

incardon's avatar
incardon committed
293
294
295
296
297
298
	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
299
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327

		// create a grid_key_dx iterator
		grid_key_dx_iterator<dim> gk_it(g);

		// Divide the space into subspaces
		while (gk_it.isNext())
		{
			//! iterate through all subspaces
			grid_key_dx<dim> key = gk_it.get();

			//! Create a new subspace
			SpaceBox<dim,T> tmp;

			//! fill with the Margin of the box
			for (int i = 0 ; i < dim ; i++)
			{
				tmp.setHigh(i,(key.get(i)+1)*spacing[i]);
				tmp.setLow(i,key.get(i)*spacing[i]);
			}

			//! add the space box
			sub_domains.add(tmp);

			// add the iterator
			++gk_it;
		}
	}

incardon's avatar
incardon committed
328
329
330
331
332
333
334
335
336
	// Heap memory receiver
	HeapMemory hp_recv;

	// vector v_proc
	openfpm::vector<size_t> v_proc;

	// Receive counter
	size_t recv_cnt;

incardon's avatar
incardon committed
337
338
339
340
341
342
343
344
public:

	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
345
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl)
incardon's avatar
incardon committed
346
347
348
349
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
350
351
352
353
354

	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
355
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
356

357
358
359
360
361
362
363
364
365
366
367
368
369
370
	/*! \brief class to select the returned id by ghost_processorID
	 *
	 */
	class box_id
	{
	public:
		/*! \brief Return the box id
		 *
		 * \param p structure containing the id informations
		 * \param b_id box_id
		 *
		 * \return box id
		 *
		 */
incardon's avatar
incardon committed
371
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
		{
			return b_id;
		}
	};

	/*! \brief class to select the returned id by ghost_processorID
	 *
	 */
	class processor_id
	{
	public:
		/*! \brief Return the processor id
		 *
		 * \param p structure containing the id informations
		 * \param b_id box_id
		 *
		 * \return processor id
		 *
		 */
incardon's avatar
incardon committed
391
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
		{
			return p.proc;
		}
	};

	/*! \brief class to select the returned id by ghost_processorID
	 *
	 */
	class lc_processor_id
	{
	public:
		/*! \brief Return the near processor id
		 *
		 * \param p structure containing the id informations
		 * \param b_id box_id
		 *
		 * \return local processor id
		 *
		 */
incardon's avatar
incardon committed
411
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
412
413
414
415
416
		{
			return p.lc_proc;
		}
	};

incardon's avatar
incardon committed
417
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
418
419
420
421
422
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
423
424
425
	 *
	 \verbatim

incardon's avatar
incardon committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
|                 Sub-domain 0                       +-----------------------------------+
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
 |              |   |  XXXXXXXXXXXXX XX         |B9_0|                                   |
 |              | B |  X Processor 10 X         |    |                                   |
 | Processor 5  | 5 |  X Sub-domain 0 X         |    |                                   |
 | Subdomain 0  | _ |  X              X         +----------------------------------------+
 |              | 0 |  XXXXXXXXXXXXXXXX         |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

451
452
 \endverbatim

incardon's avatar
incardon committed
453
       and also
incardon's avatar
incardon committed
454
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
455

456
457
 \verbatim

incardon's avatar
incardon committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
|                 Sub-domain 0                       +-----------------------------------+
|           +---------------------------------------------+                              |
|           |         G8_0                           |    |                              |
++--------------+------------------------------------+    |   Processor 9                |
 |          |   |                                    |    |   Subdomain 0                |
 |          |   |                                    |G9_0|                              |
 |          |   |                                    |    |                              |
 |          |   |      XXXXXXXXXXXXX XX              |    |                              |
 |          |   |      X Processor 10 X              |    |                              |
 | Processor|5  |      X Sub-domain 0 X              |    |                              |
 | Subdomain|0  |      X              X              +-----------------------------------+
 |          |   |      XXXXXXXXXXXXXXXX              |    |                              |
 |          | G |                                    |    |                              |
 |          | 5 |                                    |    |   Processor 9                |
 |          | | |                                    |    |   Subdomain 1                |
 |          | 0 |                                    |G9_1|                              |
 |          |   |                                    |    |                              |
 |          |   |                                    |    |                              |
 +--------------+------------------------------------+    |                              |
            |                                        |    |                              |
            +----------------------------------------+----+------------------------------+


484
485
 \endverbatim

incardon's avatar
incardon committed
486
487
488
489
490
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
491
492
	 *
	 \verbatim
incardon's avatar
incardon committed
493
494
495
496
497
498
499
500
501
502
503
504
505
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

506
507
     \endverbatim

incardon's avatar
incardon committed
508
509
510
	 *
	 *
	 */
incardon's avatar
incardon committed
511
	void calculateGhostBoxes()
incardon's avatar
incardon committed
512
513
514
515
516
517
518
	{
#ifdef DEBUG
		// the ghost margins are assumed to be smaller
		// than one sub-domain

		for (size_t i = 0 ; i < dim ; i++)
		{
incardon's avatar
incardon committed
519
			if (ghost.template getLow(i) >= domain.template getHigh(i) / gr.size(i) || ghost.template getHigh(i)  >= domain.template getHigh(i) / gr.size(i))
incardon's avatar
incardon committed
520
			{
521
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one domain" << "\n";
incardon's avatar
incardon committed
522
523
524
525
526
527
			}
		}
#endif

		// Intersect all the local sub-domains with the sub-domains of the contiguous processors

incardon's avatar
incardon committed
528
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
529
530
		ie_ghost<dim,T>::create_box_nn_processor_ext(v_cl,ghost,sub_domains,box_nn_processor,*this);
		ie_ghost<dim,T>::create_box_nn_processor_int(v_cl,ghost,sub_domains,box_nn_processor,*this);
incardon's avatar
incardon committed
531

incardon's avatar
incardon committed
532
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
533
534
535

		ie_loc_ghost<dim,T>::create_loc_ghost_ibox(ghost,sub_domains);
		ie_loc_ghost<dim,T>::create_loc_ghost_ebox(ghost,sub_domains);
incardon's avatar
incardon committed
536
537
538
539
540
541
542
543
544

		// get the smallest sub-domain dimension on each direction
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (ghost.template getLow(i) >= ss_box.getHigh(i) || ghost.template getHigh(i)  >= domain.template getHigh(i) / gr.size(i))
			{
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one domain" << "\n";
			}
		}
incardon's avatar
incardon committed
545
546
	}

547
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
548
549
550
551
	 *
	 * \return processorID
	 *
	 */
incardon's avatar
incardon committed
552
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
553
	{
incardon's avatar
incardon committed
554
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
555
556
	}

incardon's avatar
incardon committed
557
558
559
560
561
562
563
564
565
566
567
568
569
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

	/*! \brief Get the smallest subdivision of the domain on each direction
	 *
	 * \return a box p1 is set to zero
	 *
	 */
	const ::Box<dim,T> & getSmallestSubdivision()
	{
		return ss_box;
	}

570
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
571
572
573
574
575
	 *
	 * \return processorID
	 *
	 */

576
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
577
	{
incardon's avatar
incardon committed
578
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
579
580
	}

incardon's avatar
incardon committed
581
582
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
583
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
584
585
586
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
587
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
588
	{
incardon's avatar
incardon committed
589
590
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
591
592
		// Set the decomposition parameters

incardon's avatar
incardon committed
593
		gr.setDimensions(div_);
incardon's avatar
incardon committed
594
		domain = domain_;
incardon's avatar
incardon committed
595
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
596
597
598
599
600
601

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

602
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
603
604
605
606
607
608
609
610
611
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
612
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
613
	 *
incardon's avatar
incardon committed
614
615
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
	 *
	 */
	SpaceBox<dim,T> getLocalHyperCube(size_t lc)
	{
		// Create a space box
		SpaceBox<dim,T> sp;

		// fill the space box

		for (size_t k = 0 ; k < dim ; k++)
		{
			// create the SpaceBox Low and High
			sp.setLow(k,sub_domains.template get<Box::p1>(lc)[k]);
			sp.setHigh(k,sub_domains.template get<Box::p2>(lc)[k]);
		}

		return sp;
	}

incardon's avatar
incardon committed
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
	/*! \brief Get the local sub-domain with ghost extension
	 *
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
	 *
	 */
	SpaceBox<dim,T> getSubDomainWithGhost(size_t lc)
	{
		// Create a space box
		SpaceBox<dim,T> sp = sub_domains.get(lc);

		// enlarge with ghost
		sp.enlarge(ghost);

		return sp;
	}

incardon's avatar
incardon committed
652
653
654
655
656
657
658
659
660
661
	/*! \brief Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */
	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
662
663
664
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
665
	 *
incardon's avatar
incardon committed
666
	 * \return true if it is local
incardon's avatar
incardon committed
667
668
	 *
	 */
669
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
670
	{
671
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
672
	}
incardon's avatar
incardon committed
673

incardon's avatar
incardon committed
674
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
675
	 *
incardon's avatar
incardon committed
676
	 * \param p object position
incardon's avatar
incardon committed
677
	 *
incardon's avatar
incardon committed
678
	 * \return true if it is local
incardon's avatar
incardon committed
679
680
	 *
	 */
681
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
682
	{
incardon's avatar
incardon committed
683
684
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
685
686
687

	::Box<dim,T> bbox;

688
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
689
690
691
692
693
694
695
696
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
697

698

699
700
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
701
702
703
704
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
705
706
707
708
709
710
	 * * subdomains_X.vtk domain for the local processor (X) as union of sub-domain
	 * * subdomains_adjacent_X.vtk sub-domains adjacent to the local processor (X)
	 * * internal_ghost_X.vtk Internal ghost boxes for the local processor (X)
	 * * external_ghost_X.vtk External ghost boxes for the local processor (X)
	 * * local_internal_ghost_X.vtk internal local ghost boxes for the local processor (X)
	 * * local_external_ghost_X.vtk external local ghost boxes for the local processor (X)
incardon's avatar
incardon committed
711
	 *
incardon's avatar
incardon committed
712
	 * where X is the local processor rank
incardon's avatar
incardon committed
713
714
715
716
717
718
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
719
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
720
721
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
722
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
723

724
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
725
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
726
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
727

728
		return true;
incardon's avatar
incardon committed
729
	}
incardon's avatar
incardon committed
730
731
732
733
734
735
736
737

	/*! \brief function to check the consistency of the information of the decomposition
	 *
	 * \return false if is inconsistent
	 *
	 */
	bool check_consistency()
	{
incardon's avatar
incardon committed
738
739
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
740
741
742

		return true;
	}
743
744
745

	void debugPrint()
	{
746
747
748
749
750
751
		std::cout << "Subdomains\n";
		for (size_t p = 0 ; p < sub_domains.size() ; p++)
		{
			std::cout << ::SpaceBox<dim,T>(sub_domains.get(p)).toString() << "\n";
		}

752
		std::cout << "External ghost box\n";
753

754
755
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
756
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
757
			{
incardon's avatar
incardon committed
758
				std::cout << ie_ghost<dim,T>::getProcessorEGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p) << "   id=" << ie_ghost<dim,T>::getProcessorEGhostId(p,i) << "\n";
759
			}
760
		}
761

762
		std::cout << "Internal ghost box\n";
763

764
765
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
766
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNIGhost(p) ; i++)
767
			{
incardon's avatar
incardon committed
768
				std::cout << ie_ghost<dim,T>::getProcessorIGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p)  << "   id=" << ie_ghost<dim,T>::getProcessorIGhostId(p,i) <<  "\n";
769
770
			}
		}
771
	}
incardon's avatar
incardon committed
772
773
774
775
};


#endif