CartDecomposition.hpp 34.3 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"
31
#include "util/se_util.hpp"
32
#include "util/mathutil.hpp"
incardon's avatar
incardon committed
33

34 35
#define CARTDEC_ERROR 2000lu

incardon's avatar
incardon committed
36 37 38 39 40 41 42
/**
 * \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
 *
43
 * Given an N-dimensional space, this class decompose the space into a Cartesian grid of small
incardon's avatar
incardon committed
44 45 46 47
 * sub-sub-domain. To each sub-sub-domain is assigned an id that identify at which processor is
 * assigned (in general the union of all the sub-sub-domain assigned to a processor is
 * simply connected space), a second step merge several sub-sub-domain with same id into bigger region
 *  sub-domain. Each sub-domain has an extended space called ghost part
48 49 50 51
 *
 * Assuming that VCluster.getProcessUnitID(), equivalent to the MPI processor rank, return the processor local
 * processor id, we define
 *
52 53
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
54 55 56 57 58 59 60 61 62 63 64 65
 * * 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
66
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
67 68
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
69
 *
70 71 72
 * ### 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
73 74
 */

Pietro Incardona's avatar
Pietro Incardona committed
75
template<unsigned int dim, typename T, typename Memory=HeapMemory>
incardon's avatar
incardon committed
76
class CartDecomposition : public ie_loc_ghost<dim,T>, public nn_prcs<dim,T> , public ie_ghost<dim,T>
incardon's avatar
incardon committed
77
{
incardon's avatar
incardon committed
78

incardon's avatar
incardon committed
79
public:
incardon's avatar
incardon committed
80

incardon's avatar
incardon committed
81 82 83 84 85 86 87 88
	//! 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
89
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
90
	//! acc_key is size_t
91
	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
92 93

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

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

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

incardon's avatar
incardon committed
103 104
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
105

incardon's avatar
incardon committed
106 107 108
	//! 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
109 110

	//! rectangular domain to decompose
Pietro Incardona's avatar
Pietro Incardona committed
111
	::Box<dim,T> domain;
incardon's avatar
incardon committed
112 113 114 115 116 117 118

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

incardon's avatar
incardon committed
119 120 121 122
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

	::Box<dim,T> bbox;
incardon's avatar
incardon committed
123

124 125 126 127 128 129 130 131 132
	// Heap memory receiver
	HeapMemory hp_recv;

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

	// reference counter of the object in case is shared between object
	long int ref_cnt;

Pietro Incardona's avatar
Pietro Incardona committed
133
	// ghost info
134 135
	Ghost<dim,T> ghost;

Pietro Incardona's avatar
Pietro Incardona committed
136 137 138
	// Boundary condition info
	size_t bc[dim];

139
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
140
	 *
141
     * \param v_cl Virtual cluster, used internally for communications
142
     *
incardon's avatar
incardon committed
143
	 */
Pietro Incardona's avatar
Pietro Incardona committed
144
	void CreateDecomposition(Vcluster & v_cl, const size_t (& bc)[dim])
incardon's avatar
incardon committed
145
	{
146 147 148 149 150 151 152
#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
153 154 155 156 157 158 159 160
		// 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
161
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
162 163 164 165
		}

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

Pietro Incardona's avatar
Pietro Incardona committed
168 169 170 171 172
		// the graph has only non perdiodic boundary conditions
		size_t bc_o[dim];
		for (size_t i = 0 ; i < dim ; i++)
			bc_o[i] = NON_PERIODIC;

incardon's avatar
incardon committed
173
		// sub-sub-domain graph
Pietro Incardona's avatar
Pietro Incardona committed
174
		Graph_CSR<nm_part_v,nm_part_e> gp = g_factory_part.template construct<NO_EDGE,T,dim-1>(gr.getSize(),domain,bc_o);
incardon's avatar
incardon committed
175 176 177 178 179 180 181 182

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

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

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

incardon's avatar
incardon committed
191 192
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
193
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
194 195 196 197

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

incardon's avatar
incardon committed
198
		// optimize the decomposition
Pietro Incardona's avatar
Pietro Incardona committed
199
		d_o.template optimize<nm_part_v::sub_id,nm_part_v::id>(gp,p_id,loc_box,box_nn_processor,bc);
incardon's avatar
incardon committed
200

incardon's avatar
incardon committed
201 202 203
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
204 205
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
206 207 208
			sub_d.mul(spacing);
			sub_d.expand(spacing);

209 210 211 212 213 214 215 216 217 218 219 220 221
			// 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
222 223 224 225
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
226
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
227 228 229
			bbox = sub_d;
		}

incardon's avatar
incardon committed
230
		// convert into sub-domain
incardon's avatar
incardon committed
231
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
232
		{
233 234
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
235

incardon's avatar
incardon committed
236 237 238
			// 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
239

240 241 242 243 244 245 246 247 248 249 250 251 252
			// 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
253 254
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
255 256 257 258 259 260

			// 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
261
		}
incardon's avatar
incardon committed
262

263
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);
incardon's avatar
incardon committed
264
		nn_prcs<dim,T>::refine_ss_box(ss_box);
Pietro Incardona's avatar
Pietro Incardona committed
265
		nn_prcs<dim,T>::applyBC(domain,ghost,bc);
266

incardon's avatar
incardon committed
267
		// fill fine_s structure
incardon's avatar
incardon committed
268 269 270
		// 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
271 272 273 274 275 276 277 278 279 280 281
		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;
		}
282

incardon's avatar
incardon committed
283 284 285 286 287 288 289 290 291 292
		Initialize_geo_cell_lists();
	}

	/*! \brief Initialize geo_cell lists
	 *
	 *
	 *
	 */
	void Initialize_geo_cell_lists()
	{
293 294 295 296
		// Get the smallest sub-division on each direction
		::Box<dim,T> unit = getSmallestSubdivision();
		// Get the processor bounding Box
		::Box<dim,T> bound = getProcessorBounds();
Pietro Incardona's avatar
Pietro Incardona committed
297 298
		// Not necessary, but I prefer
		bound.enlarge(ghost);
299

incardon's avatar
incardon committed
300
		// calculate the sub-divisions
301 302
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
303
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
304 305 306 307 308 309 310 311 312

		// 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
Pietro Incardona's avatar
Pietro Incardona committed
313
		ie_ghost<dim,T>::Initialize_geo_cell(bound,div,orig);
314 315 316

		// Initialize shift vectors
		ie_ghost<dim,T>::generateShiftVectors(domain);
incardon's avatar
incardon committed
317 318 319 320 321 322 323 324
	}

	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
325
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

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

public:

356 357 358 359
	static constexpr int dims = dim;

	typedef T stype;

incardon's avatar
incardon committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373
	//! Increment the reference counter
	void incRef()
	{ref_cnt++;}

	//! Decrement the reference counter
	void decRef()
	{ref_cnt--;}

	//! Return the reference counter
	long int ref()
	{
		return ref_cnt;
	}

incardon's avatar
incardon committed
374 375 376 377 378 379
	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
380
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
381 382 383 384
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
385

386 387 388 389 390
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
391
	CartDecomposition(const CartDecomposition<dim,T,Memory> & cart)
392
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),ref_cnt(0)
393 394 395 396 397 398 399 400 401
	{
		this->operator=(cart);
	}

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
402
	CartDecomposition(CartDecomposition<dim,T,Memory> && cart)
403
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),ref_cnt(0)
404 405 406 407
	{
		this->operator=(cart);
	}

incardon's avatar
incardon committed
408 409 410 411
	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
412
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
413

414 415 416 417 418 419 420 421 422 423 424 425 426 427
	/*! \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
428
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
		{
			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
448
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
		{
			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
468
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
469 470 471 472 473
		{
			return p.lc_proc;
		}
	};

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
	/*! \brief class to select the returned id by ghost_processorID
	 *
	 */
	class shift_id
	{
	public:
		/*! \brief Return the shift id
		 *
		 * \param p structure containing the id informations
		 * \param b_id box_id
		 *
		 * \return shift_id id
		 *
		 */
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
		{
			return p.shift_id;
		}
	};

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	/*! \brief Apply boundary condition to the point
	 *
	 * \param p Point to apply the boundary condition
	 *
	 */
	void applyPointBC(float (& pt)[dim]) const
	{
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt[i] = openfpm::math::periodic_l(pt[i],domain.getHigh(i),domain.getLow(i));
		}
	}

	/*! \brief Apply boundary condition to the point
	 *
	 * \param p Point to apply the boundary condition
	 *
	 */
	void applyPointBC(Point<dim,T> & pt) const
	{
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt.get(i) = openfpm::math::periodic_l(pt.get(i),domain.getHigh(i),domain.getLow(i));
		}
	}

	/*! \brief Apply boundary condition to the point
	 *
	 * \param encapsulated object
	 *
	 */
	template<typename Mem> void applyPointBC(encapc<1,Point<dim,T>,Mem> && pt) const
	{
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt.template get<0>()[i] = openfpm::math::periodic_l(pt.template get<0>()[i],domain.getHigh(i),domain.getLow(i));
		}
	}

incardon's avatar
incardon committed
536
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
537 538 539 540 541
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
542 543 544
	 *
	 \verbatim

incardon's avatar
incardon committed
545 546 547
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
incardon's avatar
incardon committed
548
|                 Sub+domain 0                       +-----------------------------------+
incardon's avatar
incardon committed
549 550 551 552 553 554
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
incardon's avatar
incardon committed
555 556 557 558 559
 |              |   |                           |B9_0|                                   |
 |              | B |    Local processor        |    |                                   |
 | Processor 5  | 5 |    Subdomain 0            |    |                                   |
 | Subdomain 0  | _ |                           +----------------------------------------+
 |              | 0 |                           |    |                                   |
incardon's avatar
incardon committed
560 561 562 563 564 565 566 567 568 569
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

incardon's avatar
incardon committed
570

571 572
 \endverbatim

incardon's avatar
incardon committed
573
       and also
incardon's avatar
incardon committed
574
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
575

incardon's avatar
incardon committed
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
      +----------------------------------------------------+
      |                 Processor 8                        |
      |                 Subdomain 0                        +-----------------------------------+
      |                                                    |                                   |
      |           +---------------------------------------------+                              |
      |           |         G8_0                           |    |                              |
+-----+---------------+------------------------------------+    |   Processor 9                |
|                 |   |                                    |    |   Subdomain 0                |
|                 |   |                                    |G9_0|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
|                 |   |        Local processor             |    |                              |
|  Processor 5    |   |        Sub+domain 0                |    |                              |
|  Subdomain 0    |   |                                    +-----------------------------------+
|                 |   |                                    |    |                              |
|                 | G |                                    |    |                              |
|                 | 5 |                                    |    |   Processor 9                |
|                 | | |                                    |    |   Subdomain 1                |
|                 | 0 |                                    |G9_1|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
+---------------------+------------------------------------+    |                              |
                  |                                        |    |                              |
                  +----------------------------------------+----+------------------------------+
incardon's avatar
incardon committed
600 601


602 603
 \endverbatim

incardon's avatar
incardon committed
604 605 606 607 608
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
609 610
	 *
	 \verbatim
incardon's avatar
incardon committed
611 612 613 614 615 616 617 618 619 620 621 622 623
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

624 625
     \endverbatim

incardon's avatar
incardon committed
626 627 628
	 *
	 *
	 */
incardon's avatar
incardon committed
629
	void calculateGhostBoxes()
incardon's avatar
incardon committed
630 631 632 633 634 635 636
	{
#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
637
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
incardon's avatar
incardon committed
638
			{
639
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
640 641 642 643 644 645
			}
		}
#endif

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

incardon's avatar
incardon committed
646
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
647 648
		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
649

incardon's avatar
incardon committed
650
		// ebox must come after ibox (in this case)
651
		ie_loc_ghost<dim,T>::create(sub_domains,domain,ghost,bc);
incardon's avatar
incardon committed
652 653 654 655

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

incardon's avatar
incardon committed
663 664 665 666 667 668 669
	/*! \brief It create another object that contain the same decomposition information but with different ghost boxes
	 *
	 * \param g ghost
	 *
	 * \return a duplicated decomposition with different ghost boxes
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
670
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
671
	{
Pietro Incardona's avatar
Pietro Incardona committed
672
		CartDecomposition<dim,T,Memory> cart(v_cl);
incardon's avatar
incardon committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689

		cart.box_nn_processor = box_nn_processor;
		cart.sub_domains = sub_domains;
		cart.fine_s = fine_s;

		cart.gr = gr;
		cart.cd = cd;
		cart.domain = domain;
		std::copy(spacing,spacing+3,cart.spacing);

		//! Runtime virtual cluster
		cart.v_cl = v_cl;

		cart.bbox = bbox;
		cart.ss_box = ss_box;
		cart.ghost = g;

690 691 692
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

693 694
		(static_cast<nn_prcs<dim,T> &>(cart)).create(box_nn_processor, sub_domains);
		(static_cast<nn_prcs<dim,T> &>(cart)).applyBC(domain,ghost,bc);
incardon's avatar
incardon committed
695

696 697
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
incardon's avatar
incardon committed
698 699 700 701 702

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
703 704 705 706
	 *
	 * \return a duplicated decomposition
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
707
	CartDecomposition<dim,T,Memory> duplicate() const
708
	{
Pietro Incardona's avatar
Pietro Incardona committed
709
		CartDecomposition<dim,T,Memory> cart(v_cl);
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

		(static_cast<ie_loc_ghost<dim,T>*>(&cart))->operator=(static_cast<ie_loc_ghost<dim,T>>(*this));
		(static_cast<nn_prcs<dim,T>*>(&cart))->operator=(static_cast<nn_prcs<dim,T>>(*this));
		(static_cast<ie_ghost<dim,T>*>(&cart))->operator=(static_cast<ie_ghost<dim,T>>(*this));

		cart.sub_domains = sub_domains;
		cart.box_nn_processor = box_nn_processor;
		cart.fine_s = fine_s;
		cart.gr = gr;
		cart.cd = cd;
		cart.domain = domain;
		std::copy(spacing,spacing+3,cart.spacing);

		//! Runtime virtual cluster
		cart.v_cl = v_cl;

		cart.ghost = ghost;

incardon's avatar
incardon committed
728 729 730
		cart.bbox = bbox;
		cart.ss_box = ss_box;

731 732 733
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = this->bc[i];

734 735 736 737 738 739 740 741
		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
742
	CartDecomposition<dim,T,Memory> & operator=(const CartDecomposition & cart)
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
	{
		static_cast<ie_loc_ghost<dim,T>*>(this)->operator=(static_cast<ie_loc_ghost<dim,T>>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->operator=(static_cast<nn_prcs<dim,T>>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->operator=(static_cast<ie_ghost<dim,T>>(cart));

		sub_domains = cart.sub_domains;
		box_nn_processor = cart.box_nn_processor;
		fine_s = cart.fine_s;
		gr = cart.gr;
		cd = cart.cd;
		domain = cart.domain;
		std::copy(cart.spacing,cart.spacing+3,spacing);

		//! Runtime virtual cluster
		v_cl = cart.v_cl;

		ghost = cart.ghost;

incardon's avatar
incardon committed
761 762 763
		bbox = cart.bbox;
		ss_box = cart.ss_box;

764 765 766
		for (size_t i = 0 ; i < dim ; i++)
			bc[i] = cart.bc[i];

767 768 769 770 771 772 773 774
		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
775
	CartDecomposition<dim,T,Memory> & operator=(CartDecomposition && cart)
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
	{
		static_cast<ie_loc_ghost<dim,T>*>(this)->operator=(static_cast<ie_loc_ghost<dim,T>*>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->operator=(static_cast<nn_prcs<dim,T>*>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->operator=(static_cast<ie_ghost<dim,T>*>(cart));

		sub_domains.swap(cart.sub_domains);
		box_nn_processor.swap(cart.box_nn_processor);
		fine_s.swap(cart.fine_s);
		gr = cart.gr;
		cd = cart.cd;
		domain = cart.domain;
		std::copy(cart.spacing,cart.spacing+3,spacing);

		//! Runtime virtual cluster
		v_cl = cart.v_cl;

		ghost = cart.ghost;

incardon's avatar
incardon committed
794 795 796
		cart.bbox = bbox;
		cart.ss_box = ss_box;

797 798 799
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

800 801 802
		return *this;
	}

803 804 805 806 807 808 809 810 811 812 813 814 815 816
	/*! \brief The default grid size
	 *
	 *  The default grid is always an isotropic grid that adapt with the number of processors,
	 *  it define in how many cell it will be divided the space for a particular required minimum
	 *  number of sub-domain
	 *
	 */
	static size_t getDefaultGrid(size_t n_sub)
	{
		// Calculate the number of sub-sub-domain on
		// each dimension
		return openfpm::math::round_big_2(pow(n_sub,1.0/dim));
	}

817
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
818 819 820 821
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
822
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
823
	{
Pietro Incardona's avatar
Pietro Incardona committed
824
		return fine_s.get(cd.template getCell<ofb>(p));
incardon's avatar
incardon committed
825 826
	}

827
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
828
	 *
829
	 * \return processorID
incardon's avatar
incardon committed
830 831
	 *
	 */
832
	size_t inline processorID(const Point<dim,T> &p) const
incardon's avatar
incardon committed
833
	{
834
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
835 836
	}

837
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
838 839 840 841
	 *
	 * \return processorID
	 *
	 */
842
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
843
	{
incardon's avatar
incardon committed
844
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
845 846
	}

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary conditions are considered
	 *
	 * \return processorID
	 *
	 */
	template<typename Mem> size_t inline processorIDBC(encapc<1, Point<dim,T>, Mem> p)
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(pt));
	}

	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary conditions are considered
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
869
	template<typename ofb> size_t inline processorIDBC(const Point<dim,T> &p) const
870 871 872 873 874 875 876 877 878 879 880 881 882 883
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(p));
	}

	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary consition are considered
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
884
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
885 886 887 888 889 890 891
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(p));
	}

892 893 894 895 896 897 898 899 900 901
	/*! \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;
	}

902 903 904 905 906 907 908 909 910 911 912 913
	/*! \brief Get the periodicity on i dimension
	 *
	 * \param i dimension
	 *
	 * \return the periodicity in direction i
	 *
	 */
	size_t isPeriodic(size_t i)
	{
		return bc[i];
	}

incardon's avatar
incardon committed
914 915
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
916
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
917 918 919
     * \param domain_ domain to decompose
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
920
	void setParameters(const size_t (& div_)[dim], ::Box<dim,T> domain_, const size_t (& bc)[dim] ,const Ghost<dim,T> & ghost)
incardon's avatar
incardon committed
921
	{
Pietro Incardona's avatar
Pietro Incardona committed
922 923 924 925
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

incardon's avatar
incardon committed
926 927
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
928 929
		// Set the decomposition parameters

incardon's avatar
incardon committed
930
		gr.setDimensions(div_);
incardon's avatar
incardon committed
931
		domain = domain_;
incardon's avatar
incardon committed
932
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
933 934 935

		//! Create the decomposition

Pietro Incardona's avatar
Pietro Incardona committed
936
		CreateDecomposition(v_cl,bc);
incardon's avatar
incardon committed
937 938
	}

939
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
940 941 942 943 944 945 946 947 948
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
949
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
950
	 *
incardon's avatar
incardon committed
951 952
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
	 *
	 */
	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
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
	/*! \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;
	}

989
	/*! \brief Return the box of the physical domain
incardon's avatar
incardon committed
990
	 *
991
	 * \return The physical domain box
incardon's avatar
incardon committed
992 993
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
994
	const ::Box<dim,T> & getDomain()
incardon's avatar
incardon committed
995 996 997 998
	{
		return domain;
	}

incardon's avatar
incardon committed
999
	/*! \brief Check if the particle is local
1000 1001
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
1002 1003
	 *
	 * \param p object position
incardon's avatar
incardon committed
1004
	 *
incardon's avatar
incardon committed
1005
	 * \return true if it is local
incardon's avatar
incardon committed
1006 1007
	 *
	 */
1008
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
1009
	{
1010
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
1011
	}
incardon's avatar
incardon committed
1012

incardon's avatar
incardon committed
1013
	/*! \brief Check if the particle is local
1014 1015
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
1016
	 *
incardon's avatar
incardon committed
1017
	 * \param p object position
incardon's avatar
incardon committed
1018
	 *
incardon's avatar
incardon committed
1019
	 * \return true if it is local
incardon's avatar
incardon committed
1020 1021
	 *
	 */
1022
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
1023
	{
incardon's avatar
incardon committed
1024 1025
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
1026

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
	/*! \brief Check if the particle is local considering boundary conditions
	 *
	 * \warning if the particle id outside the domain and non periodic the result
	 *          is unreliable
	 *
	 *
	 * \param p object position
	 *
	 * \return true if it is local
	 *
	 */
	template<typename Mem> bool isLocalBC(const encapc<1, Point<dim,T>, Mem> p, const size_t (& bc)[dim]) const
	{
		Point<dim,T> pt = p;

		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt.get(i) = openfpm::math::periodic_l(p.template get<0>()[i],domain.getHigh(i),domain.getLow(i));
		}

		return processorID<Mem>(pt) == v_cl.getProcessUnitID();
	}

	/*! \brief Check if the particle is local considering boundary conditions
	 *
	 * \param p object position
	 *
	 * \return true if it is local
	 *
	 */
	bool isLocalBC(const T (&p)[dim], const size_t (& bc)[dim]) const
	{
		Point<dim,T> pt = p;

		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt.get(i) = openfpm::math::periodic_l(p[i],domain.getHigh(i),domain.getLow(i));
		}

		return processorID(pt) == v_cl.getProcessUnitID();
	}

1071
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
1072 1073 1074 1075 1076 1077 1078 1079
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
1080

1081

1082 1083 1084 1085 1086 1087 1088 1089 1090
	/*! \brief Return the ghost
	 *
	 *
	 */
	const Ghost<dim,T> & getGhost() const
	{
		return ghost;
	}

1091 1092
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
1093 1094 1095 1096
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
1097 1098 1099 1100 1101 1102
	 * * 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
1103
	 *
incardon's avatar
incardon committed
1104
	 * where X is the local processor rank
incardon's avatar
incardon committed
1105 1106 1107 1108 1109 1110
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
1111
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
1112 1113
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
1114
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
1115

1116
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
1117
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
1118
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
1119

1120
		return true;
incardon's avatar
incardon committed
1121
	}
incardon's avatar
incardon committed
1122

Pietro Incardona's avatar
Pietro Incardona committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
	/*! \brief Get the Virtual Cluster machine
	 *
	 * \return the Virtual cluster machine
	 *
	 */
	Vcluster & getVC() const
	{
#ifdef SE_CLASS2
		check_valid(this,8);
#endif
		return v_cl;
	}

incardon's avatar
incardon committed
1136 1137 1138 1139 1140 1141 1142