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

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
#include "Decomposition.hpp"
incardon's avatar
incardon committed
13
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
14
15
16
17
18
19
20
#include <vector>
#include "global_const.hpp"
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "metis_util.hpp"
#include "dec_optimizer.hpp"
#include "Space/Shape/Box.hpp"
incardon's avatar
incardon committed
21
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
22
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
23
24
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
25
#include "Space/Ghost.hpp"
incardon's avatar
incardon committed
26
27
28
29
30
31
32
33
34
35
36
37

/**
 * \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 layout to use
 * \tparam Memory Memory factory used to allocate memory
 * \tparam Domain Structure that contain the information of your physical domain
 * \tparam data type of structure that store the sub-domain decomposition can be an openfpm structure like
 *        vector, ...
 *
38
39
 * 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
40
 * going to take care of that part of space (in general the space assigned to a processor is
41
42
43
44
45
46
47
48
49
50
51
52
53
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
 *
 * * local sub-domain: all the sub-domain with id == local processor
 * * 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
60
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
61
62
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
63
 *
incardon's avatar
incardon committed
64
65
 */

incardon's avatar
incardon committed
66
template<unsigned int dim, typename T, template<typename> class device_l=openfpm::device_cpu, typename Memory=HeapMemory, template<unsigned int, typename> class Domain=Box, template<typename, typename, typename, typename, unsigned int> class data_s = openfpm::vector>
incardon's avatar
incardon committed
67
68
class CartDecomposition
{
incardon's avatar
incardon committed
69
70
	struct N_box
	{
71
		// id of the processor in the nn_processor list (local processor id)
incardon's avatar
incardon committed
72
73
74
75
76
77
		size_t id;

		// Near processor sub-domains
		typename openfpm::vector<::Box<dim,T>> bx;
	};

incardon's avatar
incardon committed
78
79
80
	struct Box_proc
	{
		// Intersection between the local sub-domain enlarged by the ghost and the contiguous processor
incardon's avatar
incardon committed
81
		// sub-domains (External ghost)
incardon's avatar
incardon committed
82
83
84
		openfpm::vector<::Box<dim,T>> bx;

		// Intersection between the contiguous processor sub-domain enlarged by the ghost with the
incardon's avatar
incardon committed
85
		// local sub-domain (Internal ghost)
incardon's avatar
incardon committed
86
87
88
89
90
91
92
		openfpm::vector<::Box<dim,T>> nbx;


		// processor
		size_t proc;
	};

93
	//! It contain a box definition and from witch sub-domain it come from
incardon's avatar
incardon committed
94
	struct Box_sub : Box<dim,T>
95
96
97
	{
		// Domain id
		size_t sub;
incardon's avatar
incardon committed
98
99
100
101
102
103
104

		Box_sub operator=(const Box<dim,T> & box)
		{
			::Box<dim,T>::operator=(box);

			return *this;
		}
105
106
	};

incardon's avatar
incardon committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
	//! Particular case for internal ghost boxes, in contain the internal local ghost box
	struct Box_sub_k : Box<dim,T>
	{
		// Domain id
		size_t sub;

		//! k \see getLocalGhostIBoxE
		long int k;

		Box_sub_k operator=(const Box<dim,T> & box)
		{
			::Box<dim,T>::operator=(box);

			return *this;
		}
	};

124
125
126
127
	struct Box_dom
	{
		// Intersection between the local sub-domain enlarged by the ghost and the contiguous processor
		// sub-domains (External ghost)
incardon's avatar
incardon committed
128
		openfpm::vector_std< Box_sub > ebx;
129
130
131

		// Intersection between the contiguous processor sub-domain enlarged by the ghost with the
		// local sub-domain (Internal ghost)
incardon's avatar
incardon committed
132
		openfpm::vector_std< Box_sub> ibx;
133
134
	};

incardon's avatar
incardon committed
135
136
137
138
139
140
141
142
143
144
145
146
	//! Case for local ghost box
	struct lBox_dom
	{
		// Intersection between the local sub-domain enlarged by the ghost and the contiguous processor
		// sub-domains (External ghost)
		openfpm::vector_std< Box_sub > ebx;

		// Intersection between the contiguous processor sub-domain enlarged by the ghost with the
		// local sub-domain (Internal ghost)
		openfpm::vector_std< Box_sub_k> ibx;
	};

incardon's avatar
incardon committed
147
public:
incardon's avatar
incardon committed
148

incardon's avatar
incardon committed
149
150
151
152
153
154
155
156
	//! 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
157
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
158
	//! acc_key is size_t
incardon's avatar
incardon committed
159
	typedef typename data_s<SpaceBox<dim,T>,device_l<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
160
161
162
163
164

	//! the margin of the sub-domain selected
	SpaceBox<dim,T> sub_domain;

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

incardon's avatar
incardon committed
167
168
169
	//! List of near processors
	openfpm::vector<size_t> nn_processors;

170
	//! for each sub-domain (first vector), contain the list (nested vector) of the neighborhood processors
incardon's avatar
incardon committed
171
	//! and for each processor contain the boxes calculated from the intersection
172
173
	//! of the sub-domains + ghost with the near-by processor sub-domain () and the other way around
	//! \see calculateGhostBoxes
incardon's avatar
incardon committed
174
175
	openfpm::vector< openfpm::vector< Box_proc > > box_nn_processor_int;

176
177
178
	//! It store the same information of box_nn_processor_int organized by processor id
	openfpm::vector< Box_dom > proc_int_box;

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

	// for each near-processor store the sub-domain of the near processor
incardon's avatar
incardon committed
183
	std::unordered_map<size_t, N_box> nn_processor_subdomains;
incardon's avatar
incardon committed
184

incardon's avatar
incardon committed
185
	//! it contain the internal ghosts of the local processor
incardon's avatar
incardon committed
186
	openfpm::vector<lBox_dom> loc_ghost_box;
incardon's avatar
incardon committed
187

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

incardon's avatar
incardon committed
192
193
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
194

incardon's avatar
incardon committed
195
196
197
	//! 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
198
199
200
201
202
203
204
205
206
207

	//! 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
208
	//! Cell-list that store the geometrical information of the internal ghost boxes
incardon's avatar
incardon committed
209
210
	CellList<dim,T,FAST> geo_cell;

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

incardon's avatar
incardon committed
214

incardon's avatar
incardon committed
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
	/*! \brief Create internally the decomposition
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	void CreateDecomposition(Vcluster & v_cl)
	{
		// 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
230
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
231
232
233
234
		}

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

		// Processor graph
incardon's avatar
incardon committed
238
		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
239
240
241
242
243
244
245
246

		// 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
247
		Metis<Graph_CSR<nm_part_v,nm_part_e>> met(gp,Np);
incardon's avatar
incardon committed
248
249

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

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

incardon's avatar
incardon committed
255
256
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
257
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
258
259
260
261

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

incardon's avatar
incardon committed
262
		// optimize the decomposition
incardon's avatar
incardon committed
263
264
		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
265
266
		// produce the list of the contiguous processor (nn_processors) and link nn_processor_subdomains to the
		// processor list
incardon's avatar
incardon committed
267
268
269
270
271
272
273
274
275
276
277
278
		for (size_t i = 0 ;  i < box_nn_processor.size() ; i++)
		{
			for (size_t j = 0 ; j < box_nn_processor.get(i).size() ; j++)
			{
				nn_processors.add(box_nn_processor.get(i).get(j));
			}
		}

		// make the list sorted and unique
	    std::sort(nn_processors.begin(), nn_processors.end());
	    auto last = std::unique(nn_processors.begin(), nn_processors.end());
	    nn_processors.erase(last, nn_processors.end());
incardon's avatar
incardon committed
279

incardon's avatar
incardon committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
		// produce the list of the contiguous processor (nn_processors) and link nn_processor_subdomains to the
		// processor list
		for (size_t i = 0 ;  i < box_nn_processor.size() ; i++)
		{
			for (size_t j = 0 ; j < box_nn_processor.get(i).size() ; j++)
			{
				// processor id near to this sub-domain
				size_t proc_id = box_nn_processor.get(i).get(j);

				size_t k = 0;
				// search inside near processor list
				for (k = 0 ; k < nn_processors.size() ; k++)
					if (nn_processors.get(k) == proc_id)	break;

				nn_processor_subdomains[proc_id].id = k;
			}
		}

		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
			SpaceBox<dim,T> sub_d(loc_box.get(0));
			sub_d.mul(spacing);
			sub_d.expand(spacing);

			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
			bbox = sub_d;
		}

incardon's avatar
incardon committed
312
		// convert into sub-domain
incardon's avatar
incardon committed
313
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
314
315
316
		{
			SpaceBox<dim,T> sub_d(loc_box.get(s));

incardon's avatar
incardon committed
317
318
319
			// 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
320
321
322

			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
323
324
325
326
327
328

			// 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
329
		}
incardon's avatar
incardon committed
330
331

		// fill fine_s structure
incardon's avatar
incardon committed
332
333
334
		// 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
335
336
337
338
339
340
341
342
343
344
345
		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;
		}
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365

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

		// calculate the sub-divisions (0.5 for rounding error)
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i) + 0.5);

		// 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
		geo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
366
		lgeo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
367
368
	}

incardon's avatar
incardon committed
369
370
371
	// Save the ghost boundaries
	Ghost<dim,T> ghost;

incardon's avatar
incardon committed
372
373
374
375
376
377
378
	/*! \brief Create the external local ghost boxes
	 *
	 * \param ghost margin to enlarge
	 *
	 */
	void create_loc_ghost_ebox(Ghost<dim,T> & ghost)
	{
incardon's avatar
incardon committed
379
380
381
		// Save the ghost
		this->ghost = ghost;

incardon's avatar
incardon committed
382
383
384
385
386
		loc_ghost_box.resize(sub_domains.size());

		// For each sub-domain
		for (size_t i = 0 ; i < sub_domains.size() ; i++)
		{
incardon's avatar
incardon committed
387
388
389
390
			SpaceBox<dim,T> sub_with_ghost = sub_domains.get(i);

			// enlarge the sub-domain with the ghost
			sub_with_ghost.enlarge(ghost);
incardon's avatar
incardon committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407

			// intersect with the other local sub-domains
			for (size_t j = 0 ; j < sub_domains.size() ; j++)
			{
				if (i == j)
					continue;

				::Box<dim,T> bi;

				bool intersect = sub_with_ghost.Intersect(::SpaceBox<dim,T>(sub_domains.get(j)),bi);

				if (intersect == true)
				{
					Box_sub b;
					b.sub = j;
					b = bi;

incardon's avatar
incardon committed
408
409
410
411
412
413
414
415
416
417
418
419
					// local external ghost box
					loc_ghost_box.get(i).ebx.add(b);

					// search this box in the internal box of the sub-domain j
					for (size_t k = 0; k < loc_ghost_box.get(j).ibx.size() ; k++)
					{
						if (loc_ghost_box.get(j).ibx.get(k).sub == i)
						{
							loc_ghost_box.get(j).ibx.get(k).k = loc_ghost_box.get(i).ebx.size()-1;
							break;
						}
					}
incardon's avatar
incardon committed
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
				}
			}
		}
	}

	/*! \brief Create the internal local ghost boxes
	 *
	 * \param ghost margin to enlarge
	 *
	 */
	void create_loc_ghost_ibox(Ghost<dim,T> & ghost)
	{
		loc_ghost_box.resize(sub_domains.size());

		// For each sub-domain
		for (size_t i = 0 ; i < sub_domains.size() ; i++)
		{
			// intersect with the others local sub-domains
			for (size_t j = 0 ; j < sub_domains.size() ; j++)
			{
				if (i == j)
					continue;

incardon's avatar
incardon committed
443
444
445
446
				SpaceBox<dim,T> sub_with_ghost = sub_domains.get(j);
				// enlarge the sub-domain with the ghost
				sub_with_ghost.enlarge(ghost);

incardon's avatar
incardon committed
447
448
				::Box<dim,T> bi;

incardon's avatar
incardon committed
449
				bool intersect = sub_with_ghost.Intersect(::SpaceBox<dim,T>(sub_domains.get(i)),bi);
incardon's avatar
incardon committed
450
451
452

				if (intersect == true)
				{
incardon's avatar
incardon committed
453
					Box_sub_k b;
incardon's avatar
incardon committed
454
455
					b.sub = j;
					b = bi;
incardon's avatar
incardon committed
456
					b.k = -1;
incardon's avatar
incardon committed
457
458
459
460
461
462
463

					loc_ghost_box.get(i).ibx.add(b);
				}
			}
		}
	}

incardon's avatar
incardon committed
464
465
466
467
468
469
470
471
472
	/*! \brief Create the subspaces that decompose your domain
	 *
	 * Create the subspaces that decompose your domain
	 *
	 */

	void CreateSubspaces()
	{
		// Create a grid where each point is a space
473
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501

		// 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;
		}
	}

502
503
504
505
506
507
508
509
510
511
512
513
514
515
	/*! \brief Create the box_nn_processor_int (bx part)  structure
	 *
	 * This structure store for each sub-domain of this processors enlarged by the ghost size the boxes that
	 *  come from the intersection with the near processors sub-domains (External ghost box)
	 *
	 * \param ghost margins
	 *
	 * \note Are the G8_0 G9_0 G9_1 G5_0 boxes in calculateGhostBoxes
	 * \see calculateGhostBoxes
	 *
	 */
	void create_box_nn_processor_ext(Ghost<dim,T> & ghost)
	{
		box_nn_processor_int.resize(sub_domains.size());
516
		proc_int_box.resize(getNNProcessors());
517
518
519
520
521
522
523
524
525

		// For each sub-domain
		for (size_t i = 0 ; i < sub_domains.size() ; i++)
		{
			SpaceBox<dim,T> sub_with_ghost = sub_domains.get(i);

			// enlarge the sub-domain with the ghost
			sub_with_ghost.enlarge(ghost);

incardon's avatar
incardon committed
526
			// resize based on the number of adjacent processors
527
528
			box_nn_processor_int.get(i).resize(box_nn_processor.get(i).size());

incardon's avatar
incardon committed
529
			// For each processor adjacent to this sub-domain
530
531
532
533
534
			for (size_t j = 0 ; j < box_nn_processor.get(i).size() ; j++)
			{
				// Contiguous processor
				size_t p_id = box_nn_processor.get(i).get(j);

535
536
537
				// store the box in proc_int_box storing from which sub-domain they come from
				Box_dom & proc_int_box_g = proc_int_box.get(ProctoID(p_id));

incardon's avatar
incardon committed
538
				// get the set of sub-domains of the adjacent processor p_id
539
				openfpm::vector< ::Box<dim,T> > & nn_processor_subdomains_g = nn_processor_subdomains[p_id].bx;
540
541

				// near processor sub-domain intersections
542
				openfpm::vector< ::Box<dim,T> > & box_nn_processor_int_gg = box_nn_processor_int.get(i).get(j).bx;
543
544

				// for each near processor sub-domain intersect with the enlarged local sub-domain and store it
545
				for (size_t b = 0 ; b < nn_processor_subdomains_g.size() ; b++)
546
547
548
				{
					::Box<dim,T> bi;

549
					bool intersect = sub_with_ghost.Intersect(::Box<dim,T>(nn_processor_subdomains_g.get(b)),bi);
550
551
552
553
554
555
556
557
558

					if (intersect == true)
					{
						struct p_box pb;

						pb.box = bi;
						pb.proc = p_id;
						pb.lc_proc = ProctoID(p_id);

559
560
561
562
563
564
565
566
567
568
						//
						// Updating
						//
						// vb_ext
						// box_nn_processor_int
						// proc_int_box
						//
						// They all store the same information but organized in different ways
						// read the description of each for more information
						//
569
						vb_ext.add(pb);
570
571
						box_nn_processor_int_gg.add(bi);
						proc_int_box_g.ebx.add();
incardon's avatar
incardon committed
572
573
						proc_int_box_g.ebx.last() = bi;
						proc_int_box_g.ebx.last().sub = i;
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
					}
				}
			}
		}
	}

	/*! \brief Create the box_nn_processor_int (nbx part) structure, the geo_cell list and proc_int_box
	 *
	 * This structure store for each sub-domain of this processors the boxes that come from the intersection
	 * of the near processors sub-domains enlarged by the ghost size (Internal ghost box). These boxes
	 * fill a geometrical cell list. The proc_int_box store the same information ordered by near processors
	 *
	 * \param ghost margins
	 *
	 * \note Are the B8_0 B9_0 B9_1 B5_0 boxes in calculateGhostBoxes
	 * \see calculateGhostBoxes
	 *
	 */
	void create_box_nn_processor_int(Ghost<dim,T> & ghost)
	{
		box_nn_processor_int.resize(sub_domains.size());
		proc_int_box.resize(getNNProcessors());

		// For each sub-domain
		for (size_t i = 0 ; i < sub_domains.size() ; i++)
		{
			// For each processor contiguous to this sub-domain
			for (size_t j = 0 ; j < box_nn_processor.get(i).size() ; j++)
			{
				// Contiguous processor
				size_t p_id = box_nn_processor.get(i).get(j);

				// get the set of sub-domains of the contiguous processor p_id
				openfpm::vector< ::Box<dim,T> > & nn_p_box = nn_processor_subdomains[p_id].bx;

				// get the local processor id
				size_t lc_proc = nn_processor_subdomains[p_id].id;

				// For each near processor sub-domains enlarge and intersect with the local sub-domain and store the result
				for (size_t k = 0 ; k < nn_p_box.size() ; k++)
				{

					// enlarge the near-processor sub-domain
					::Box<dim,T> n_sub = nn_p_box.get(k);

					// local sub-domain
					::SpaceBox<dim,T> l_sub = sub_domains.get(i);

					// Create a margin of ghost size around the near processor sub-domain
					n_sub.enlarge(ghost);

					// Intersect with the local sub-domain
					p_box b_int;
					bool intersect = n_sub.Intersect(l_sub,b_int.box);

					// store if it intersect
					if (intersect == true)
					{
632
						// the box fill with the processor id
633
634
635
636
637
						b_int.proc = p_id;

						// fill the local processor id
						b_int.lc_proc = lc_proc;

638
639
640
641
642
643
644
645
646
647
648
649
						//
						// Updating
						//
						// vb_int
						// box_nn_processor_int
						// proc_int_box
						//
						// They all store the same information but organized in different ways
						// read the description of each for more information
						//

						// add the box to the near processor sub-domain intersections
650
651
652
653
						openfpm::vector< ::Box<dim,T> > & p_box_int = box_nn_processor_int.get(i).get(j).nbx;
						p_box_int.add(b_int.box);
						vb_int.add(b_int);

654
						// store the box in proc_int_box storing from which sub-domain they come from
655
						Box_dom & pr_box_int = proc_int_box.get(ProctoID(p_id));
656
						Box_sub sb;
incardon's avatar
incardon committed
657
						sb = b_int.box;
658
						sb.sub = i;
incardon's avatar
incardon committed
659

660
						pr_box_int.ibx.add(sb);
661
662
663

						// update the geo_cell list

incardon's avatar
incardon committed
664
						// get the cells this box span
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
						const grid_key_dx<dim> p1 = geo_cell.getCellGrid(b_int.box.getP1());
						const grid_key_dx<dim> p2 = geo_cell.getCellGrid(b_int.box.getP2());

						// Get the grid and the sub-iterator
						auto & gi = geo_cell.getGrid();
						grid_key_dx_iterator_sub<dim> g_sub(gi,p1,p2);

						// add the box-id to the cell list
						while (g_sub.isNext())
						{
							auto key = g_sub.get();
							geo_cell.addCell(gi.LinId(key),vb_int.size()-1);
							++g_sub;
						}
					}
				}
			}
		}
	}

incardon's avatar
incardon committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
	// Heap memory receiver
	HeapMemory hp_recv;

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

	// Receive counter
	size_t recv_cnt;

	/*! \brief Message allocation
	 *
	 * \param message size required to receive from i
	 * \param total message size to receive from all the processors
	 * \param the total number of processor want to communicate with you
	 * \param i processor id
incardon's avatar
incardon committed
700
701
	 * \param ri request id (it is an id that goes from 0 to total_p, and is unique
	 *           every time message_alloc is called)
incardon's avatar
incardon committed
702
703
704
705
706
	 * \param ptr a pointer to the vector_dist structure
	 *
	 * \return the pointer where to store the message
	 *
	 */
incardon's avatar
incardon committed
707
	static void * message_alloc(size_t msg_i ,size_t total_msg, size_t total_p, size_t i, size_t ri, void * ptr)
incardon's avatar
incardon committed
708
709
710
711
712
	{
		// cast the pointer
		CartDecomposition<dim,T,device_l,Memory,Domain,data_s> * cd = static_cast< CartDecomposition<dim,T,device_l,Memory,Domain,data_s> *>(ptr);

		// Resize the memory
713
		cd->nn_processor_subdomains[i].bx.resize(msg_i / sizeof(::Box<dim,T>) );
incardon's avatar
incardon committed
714
715

		// Return the receive pointer
incardon's avatar
incardon committed
716
		return cd->nn_processor_subdomains[i].bx.getPointer();
incardon's avatar
incardon committed
717
718
	}

incardon's avatar
incardon committed
719
720
721
722
723
724
725
726
public:

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(CartDecomposition<dim,T,device_l,Memory,Domain,data_s> && cd)
incardon's avatar
incardon committed
727
	:sub_domain(cd.sub_domain),gr(cd.gr),cd(cd.cd),domain(cd.domain),v_cl(cd.v_cl)
incardon's avatar
incardon committed
728
	{
incardon's avatar
incardon committed
729
730
731
		// Reset the box to zero
		bbox.zero();

incardon's avatar
incardon committed
732
733
734
		//! the set of all local sub-domain as vector
		sub_domains.swap(cd.sub_domains);

735
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
736
737
738
739
740
741
742
743
744
745
746
747
		{
			//! Box Spacing
			this->spacing[i] = spacing[i];
		}
	}

	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
incardon's avatar
incardon committed
748
	:v_cl(v_cl)
incardon's avatar
incardon committed
749
750
751
752
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
753
754
755
756
757

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

758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
	// It store all the boxes of the near processors in a linear array
	struct p_box
	{
		//! Box that identify the intersection of the ghost of the near processor with the
		//! processor sub-domain
		::Box<dim,T> box;
		//! local processor id
		size_t lc_proc;
		//! processor id
		size_t proc;

		/*! \brief Check if two p_box are the same
		 *
		 * \param pb box to check
		 *
		 */
		bool operator==(const p_box & pb)
		{
			return pb.lc_proc == lc_proc;
		}
	};

incardon's avatar
incardon committed
780
781
	openfpm::vector<size_t> ids;

782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
	/*! \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
		 *
		 */
		inline static size_t id(p_box & p, size_t b_id)
		{
			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
		 *
		 */
		inline static size_t id(p_box & p, size_t b_id)
		{
			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
		 *
		 */
		inline static size_t id(p_box & p, size_t b_id)
		{
			return p.lc_proc;
		}
	};

842
843
844
845
846
847
848
849
850
851
852
	/*! /brief Given a point it return the set of boxes in which the point fall
	 *
	 * \param p Point to check
	 * \return An iterator with the id's of the internal boxes in which the point fall
	 *
	 */
	auto getInternalIDBoxes(Point<dim,T> & p) -> decltype(geo_cell.getIterator(geo_cell.getCell(p)))
	{
		return geo_cell.getIterator(geo_cell.getCell(p));
	}

853
854
855
856

#define UNIQUE 1
#define MULTIPLE 2

incardon's avatar
incardon committed
857
	/*! \brief Given a position it return if the position belong to any neighborhood processor ghost
incardon's avatar
incardon committed
858
	 * (Internal ghost)
incardon's avatar
incardon committed
859
	 *
860
	 * \tparam id type of if to get box_id processor_id lc_processor_id
incardon's avatar
incardon committed
861
	 * \param p Particle position
862
863
864
	 * \param opt intersection boxes of the same processor can overlap, so in general the function
	 *        can produce more entry with the same processor, the UNIQUE option eliminate double entries
	 *        (UNIQUE) is for particle data (MULTIPLE) is for grid data [default MULTIPLE]
incardon's avatar
incardon committed
865
866
867
868
	 *
	 * \param return the processor ids
	 *
	 */
869
	template <typename id> inline const openfpm::vector<size_t> ghost_processorID(Point<dim,T> & p, const int opt = MULTIPLE)
incardon's avatar
incardon committed
870
871
872
	{
		ids.clear();

873
		// Check with geo-cell if a particle is inside one Cell containing boxes
incardon's avatar
incardon committed
874

875
		auto cell_it = geo_cell.getIterator(geo_cell.getCell(p));
incardon's avatar
incardon committed
876
877

		// For each element in the cell, check if the point is inside the box
878
		// if it is, store the processor id
incardon's avatar
incardon committed
879
880
881
882
883
884
		while (cell_it.isNext())
		{
			size_t bid = cell_it.get();

			if (vb_int.get(bid).box.isInside(p) == true)
			{
885
				ids.add(id::id(vb_int.get(bid),bid));
incardon's avatar
incardon committed
886
			}
887
888

			++cell_it;
incardon's avatar
incardon committed
889
890
		}

891
892
893
894
		// Make the id unique
		if (opt == UNIQUE)
			ids.unique();

incardon's avatar
incardon committed
895
896
897
898
		return ids;
	}

	/*! \brief Given a position it return if the position belong to any neighborhood processor ghost
incardon's avatar
incardon committed
899
	 * (Internal ghost)
incardon's avatar
incardon committed
900
	 *
901
	 * \tparam id type of if to get box_id processor_id lc_processor_id
incardon's avatar
incardon committed
902
903
904
905
906
	 * \param p Particle position
	 *
	 * \param return the processor ids
	 *
	 */
907
	template<typename id, typename Mem> inline const openfpm::vector<size_t> ghost_processorID(const encapc<1,Point<dim,T>,Mem> & p, const int opt = MULTIPLE)
incardon's avatar
incardon committed
908
909
910
911
912
	{
		ids.clear();

		// Check with geo-cell if a particle is inside one Cell containing boxes

incardon's avatar
incardon committed
913
		auto cell_it = geo_cell.getIterator(geo_cell.getCell(p));
incardon's avatar
incardon committed
914
915
916
917
918
919
920
921
922

		// For each element in the cell, check if the point is inside the box
		// if it is, store the processor id
		while (cell_it.isNext())
		{
			size_t bid = cell_it.get();

			if (vb_int.get(bid).box.isInside(p) == true)
			{
923
				ids.add(id::id(vb_int.get(bid),bid));
incardon's avatar
incardon committed
924
			}
925
926

			++cell_it;
incardon's avatar
incardon committed
927
928
		}

929
930
931
932
		// Make the id unique
		if (opt == UNIQUE)
			ids.unique();

incardon's avatar
incardon committed
933
934
935
		return ids;
	}

936
937
	// External ghost boxes for this processor, indicated with G8_0 G9_0 ...
	openfpm::vector<p_box> vb_ext;
incardon's avatar
incardon committed
938

939
	// Internal ghost boxes for this processor domain, indicated with B8_0 B9_0 ..... in the figure
incardon's avatar
incardon committed
940
	// below as a linear vector
incardon's avatar
incardon committed
941
	openfpm::vector<p_box> vb_int;
incardon's avatar
incardon committed
942

incardon's avatar
incardon committed
943
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
+----------------------------------------------------+
|                                                    |
|                 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                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

       and also
incardon's avatar
incardon committed
975
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023

+----------------------------------------------------+
|                                                    |
|                 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|                              |
 |          |   |                                    |    |                              |
 |          |   |                                    |    |                              |
 +--------------+------------------------------------+    |                              |
            |                                        |    |                              |
            +----------------------------------------+----+------------------------------+


	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

	 *
	 *
	 */
incardon's avatar
incardon committed
1024
	void calculateGhostBoxes()
incardon's avatar
incardon committed
1025
1026
1027
1028
1029
1030
1031
	{
#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
1032
			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
1033
			{
1034
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one domain" << "\n";
incardon's avatar
incardon committed
1035
1036
1037
1038
			}
		}
#endif

incardon's avatar
incardon committed
1039
1040
		// create a buffer with the sub-domains of this processor, the informations ( the boxes )
		// of the sub-domains contiguous to the processor A are sent to the processor A and
incardon's avatar
incardon committed
1041
1042
		// the information of the contiguous sub-domains in the near processors are received
		//
incardon's avatar
incardon committed
1043
		openfpm::vector< openfpm::vector< ::SpaceBox<dim,T>> > boxes(nn_processors.size());
incardon's avatar
incardon committed
1044
1045
1046
1047
1048
1049
1050

		for (size_t b = 0 ; b < box_nn_processor.size() ; b++)
		{
			for (size_t p = 0 ; p < box_nn_processor.get(b).size() ; p++)
			{
				size_t prc = box_nn_processor.get(b).get(p);

incardon's avatar
incardon committed
1051
1052
1053
1054
1055
				// id of the processor in the processor list
				// [value between 0 and the number of the near processors]
				size_t id = nn_processor_subdomains[prc].id;

				boxes.get(id).add(sub_domains.get(b));
incardon's avatar
incardon committed
1056
1057
1058
1059
1060
1061
			}
		}

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

		// Get the sub-domains of the near processors
incardon's avatar
incardon committed
1062
		v_cl.sendrecvMultipleMessagesNBX(nn_processors,boxes,CartDecomposition<dim,T,device_l,Memory,Domain,data_s>::message_alloc, this ,NEED_ALL_SIZE);
incardon's avatar
incardon committed
1063

incardon's avatar
incardon committed
1064
		// create the internal structures that store ghost information
1065
1066
		create_box_nn_processor_ext(ghost);
		create_box_nn_processor_int(ghost);
incardon's avatar
incardon committed
1067
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
1068
		create_loc_ghost_ibox(ghost);
incardon's avatar
incardon committed
1069
		create_loc_ghost_ebox(ghost);
incardon's avatar
incardon committed
1070
1071
	}

incardon's avatar
incardon committed
1072
1073
1074
1075
1076
1077
	/*! \brief processorID return in which processor the particle should go
	 *
	 * \return processorID
	 *
	 */

incardon's avatar
incardon committed
1078
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
1079
	{
incardon's avatar
incardon committed
1080
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
1081
1082
	}

incardon's avatar
incardon committed
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
	// 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;
	}

incardon's avatar
incardon committed
1096
1097
1098
1099
1100
1101
	/*! \brief processorID return in which processor the particle should go
	 *
	 * \return processorID
	 *
	 */

1102
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
1103
	{
incardon's avatar
incardon committed
1104
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
1105
1106
	}

incardon's avatar
incardon committed
1107
1108
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
1109
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
1110
1111
1112
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
1113
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
1114
	{
incardon's avatar
incardon committed
1115
1116
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
1117
1118
		// Set the decomposition parameters

incardon's avatar
incardon committed
1119
		gr.setDimensions(div_);
incardon's avatar
incardon committed
1120
		domain = domain_;
incardon's avatar
incardon committed
1121
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

	/*! \brief Get the number of local local hyper-cubes or sub-domains
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

	/*! \brief Get the number of one set of hyper-cube enclosing one particular
	 *         subspace, the hyper-cube enclose your space, even if one box is enough
	 *         can be more that one to increase occupancy
	 *
     * In case of Cartesian decomposition it just return 1, each subspace
	 * has one hyper-cube, and occupancy 1
	 *
	 * \param id of the subspace
	 * \return the number of hyper-cube enclosing your space
	 *
	 */
	size_t getNHyperCube(size_t id)
	{
		return 1;
	}

	/*! \brief Get the hyper-cube margins id_c has to be 0
	 *
	 * Get the hyper-cube margins id_c has to be 0, each subspace
	 * has one hyper-cube
	 *
	 * \param id of the subspace
	 * \param id_c
	 * \return The specified hyper-cube space
	 *
	 */
	SpaceBox<dim,T> & getHyperCubeMargins(size_t id, size_t id_c)
	{
#ifdef DEBUG
		// Check if this subspace exist
incardon's avatar
incardon committed
1168
		if (id >= gr.size())
incardon's avatar
incardon committed
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
		{
			std::cerr << "Error CartDecomposition: id > N_tot";
		}
		else if (id_c > 0)
		{
			// Each subspace is an hyper-cube so return error if id_c > 0
			std::cerr << "Error CartDecomposition: id_c > 0";
		}
#endif

		return sub_domains.get<Object>(id);
	}

incardon's avatar
incardon committed
1182
	/*! \brief Get the total number of sub-domain for the local processor
incardon's avatar
incardon committed
1183
	 *
incardon's avatar
incardon committed
1184
	 * \return The total number of sub-domains
incardon's avatar
incardon committed
1185
1186
1187
1188
1189
	 *
	 */

	size_t getNHyperCube()
	{
incardon's avatar
incardon committed
1190
		return gr.size();
incardon's avatar
incardon committed
1191
1192
	}

incardon's avatar
incardon committed
1193
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
1194
	 *
incardon's avatar
incardon committed
1195
1196
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
	 *
	 */
	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
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
	/*! \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
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
	/*! \brief Return the structure that store the physical domain
	 *
	 * Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */

	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
1247
1248
1249
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
1250
	 *
incardon's avatar
incardon committed
1251
	 * \return true if it is local
incardon's avatar
incardon committed
1252
1253
	 *
	 */
1254
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
1255
	{
1256
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
1257
	}
incardon's avatar
incardon committed
1258

incardon's avatar
incardon committed
1259
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
1260
	 *
incardon's avatar
incardon committed
1261
	 * \param p object position
incardon's avatar
incardon committed
1262
	 *
incardon's avatar
incardon committed
1263
	 * \return true if it is local
incardon's avatar
incardon committed
1264
1265
	 *
	 */
1266
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
1267
	{
incardon's avatar
incardon committed
1268
1269
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281

	::Box<dim,T> bbox;

	/*! \brief Return the bounding box containing the processor box + smallest subdomain spacing
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294

	/*! \brief if the point fall into the ghost of some near processor it return the processors id's in which
	 *  it fall
	 *
	 * \param p Point
	 * \return iterator of the processors id's
	 *
	 */
	inline auto labelPoint(Point<dim,T> & p) -> decltype(geo_cell.getIterator(geo_cell.getCell(p)))
	{
		return geo_cell.getIterator(geo_cell.getCell(p));
	}

1295

1296
1297
1298
	////////////// Functions to get decomposition information ///////////////


1299
	/*! \brief Get the number of Internal ghost boxes for one processor
1300
	 *
1301
	 * \param id near processor list id (the id go from 0 to getNNProcessor())
1302
1303
1304
1305
1306
1307
1308
1309
	 * \return the number of internal ghost
	 *
	 */
	inline size_t getProcessorNIGhost(size_t id) const
	{
		return proc_int_box.get(id).ibx.size();
	}

1310
	/*! \brief Get the number of External ghost boxes for one processor id
1311
	 *
1312
1313
1314
1315
1316
1317
1318
1319
1320
	 * \param id near processor list id (the id go from 0 to getNNProcessor())
	 * \return the number of external ghost
	 *
	 */
	inline size_t getProcessorNEGhost(size_t id) const
	{
		return proc_int_box.get(id).ebx.size();
	}

incardon's avatar
incardon committed
1321
1322
1323
1324
1325
1326
1327
1328
1329
	/*! \brief Get the number of external local ghost box for each sub-domain
	 *
	 * \param id sub-domain id
	 *
	 * \return the number of internal ghost box
	 *
	 */
	inline size_t getLocalNEGhost(size_t id)
	{
incardon's avatar
incardon committed
1330
		return loc_ghost_box.get(id).ebx.size();
incardon's avatar
incardon committed
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
	}

	/*! \brief Get the number of internal local ghost box for each sub-domain
	 *
	 * \param id sub-domain id
	 *
	 * \return the number of external ghost box
	 *
	 */
	inline size_t getLocalNIGhost(size_t id)
	{
incardon's avatar
incardon committed
1342
		return loc_ghost_box.get(id).ibx.size();
incardon's avatar
incardon committed
1343
1344
	}

1345
1346
1347
1348
	/*! \brief Get the j Internal ghost box for one processor
	 *
	 * \param id near processor list id (the id go from 0 to getNNProcessor())
	 * \param j box (each near processor can produce more than one internal ghost box)
1349
1350
1351
1352
1353
	 * \return the box
	 *
	 */
	inline const ::Box<dim,T> & getProcessorIGhostBox(size_t id, size_t j) const
	{
incardon's avatar
incardon committed
1354
		return proc_int_box.get(id).ibx.get(j);
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
	}

	/*! \brief Get the j External ghost box for one processor
	 *
	 * \param id near processor list id (the id go from 0 to getNNProcessor())
	 * \param j box (each near processor can produce more than one external ghost box)
	 * \return the box
	 *
	 */
	inline const ::Box<dim,T> & getProcessorEGhostBox(size_t id, size_t j) const
	{
incardon's avatar
incardon committed
1366
1367
1368
		return proc_int_box.get(id).ebx.get(j);
	}

incardon's avatar
incardon committed
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
	/*! \brief For the sub-domain i intersected with the sub-domain j enlarged, the associated
	 *       external ghost box is located in getLocalIGhostBox(j,k) with
	 *       getLocalIGhostSub(j,k) == i, this function return k
	 *
	 *
	 */
	inline size_t getLocalIGhostE(size_t i, size_t j)
	{
		return loc_ghost_box.get(i).ibx.get(j).k;
	}

incardon's avatar
incardon committed
1380
	/*! \brief Get the j internal local ghost box for the i sub-domain of the local processor
incardon's avatar
incardon committed
1381
1382
1383
1384
1385
1386
1387
1388
	 *
	 * \note For the sub-domain i intersected with the sub-domain j enlarged, the associated
	 *       external ghost box is located in getLocalIGhostBox(j,k) with
	 *       getLocalIGhostSub(j,k) == i
	 *
	 * To get k use getLocalIGhostE
	 *
	 * \see getLocalIGhostE
incardon's avatar
incardon committed
1389
1390
1391
1392
1393
1394
1395
1396
	 *
	 * \param i sub-domain
	 * \param j box
	 * \return the box
	 *
	 */
	inline const ::Box<dim,T> & getLocalIGhostBox(size_t i, size_t j) const
	{
incardon's avatar
incardon committed
1397
		return loc_ghost_box.get(i).ibx.get(j);
incardon's avatar
incardon committed
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
	}

	/*! \brief Get the j external local ghost box for the local processor
	 *
	 * \param i sub-domain
	 * \param j box
	 * \return the box
	 *
	 */
	inline const ::Box<dim,T> & getLocalEGhostBox(size_t i, size_t j) const
	{
incardon's avatar
incardon committed
1409
		return loc_ghost_box.get(i).ebx.get(j);
incardon's avatar
incardon committed
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
	}

	/*! \brief Considering that sub-domain has N internal local ghost box identified
	 *         with the 0 <= k < N that come from the intersection of 2 sub-domains i and j
	 *         where j is enlarged, given the sub-domain i and the id k, it return the id of
	 *         the other sub-domain that produced the intersection
	 *
	 * \param i sub-domain
	 * \param k id
	 * \return the box
	 *
	 */
incardon's avatar
incardon committed
1422
	inline size_t getLocalIGhostSub(size_t i, size_t j) const
incardon's avatar
incardon committed
1423
	{
incardon's avatar
incardon committed
1424
		return loc_ghost_box.get(i).ibx.get(j).sub;
incardon's avatar
incardon committed
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
	}

	/*! \brief Considering that sub-domain has N external local ghost box identified
	 *         with the 0 <= k < N that come from the intersection of 2 sub-domains i and j
	 *         where j is enlarged, given the sub-domain i and the id k, it return the id of
	 *         the other sub-domain that produced the intersection
	 *
	 * \param i sub-domain
	 * \param k id
	 * \return the box
	 *
	 */
incardon's avatar
incardon committed
1437
	inline size_t getLocalEGhostSub(size_t i, size_t j) const
incardon's avatar
incardon committed
1438
	{
incardon's avatar
incardon committed
1439
		return loc_ghost_box.get(i).ebx.get(j).sub;
1440
1441
1442
1443
	}

	/*! \brief Get the local sub-domain at witch belong the internal ghost box
	 *
incardon's avatar
incardon committed
1444
	 * \param id adjacent processor list id (the id go from 0 to getNNProcessor())
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
	 * \param j box (each near processor can produce more than one internal ghost box)
	 * \return sub-domain at which belong the internal ghost box
	 *
	 */
	inline const size_t getProcessorIGhostSub(size_t id, size_t j) const
	{
		return proc_int_box.get(id).ibx.get(j).sub;
	}

	/*! \brief Get the local sub-domain at witch belong the external ghost box
	 *
	 * \param id near processor list id (the id go from 0 to getNNProcessor())
	 * \param j box (each near processor can produce more than one external ghost box)
	 * \return sub-domain at which belong the external ghost box
	 *
	 */
	inline const size_t getProcessorEGhostSub(size_t id, size_t j) const
	{
		return proc_int_box.get(id).ebx.get(j).sub;
1464
1465
	}

1466
	/*! \brief Get the number of Near processors
1467
1468
1469
1470
	 *
	 * \return the number of near processors
	 *
	 */
1471
1472
1473
1474
1475
	inline size_t getNNProcessors() const
	{
		return nn_processors.size();
	}

1476
	/*! \brief Return the total number of the calculated internal ghost boxes
incardon's avatar
incardon committed
1477
	 *