CartDecomposition.hpp 27.7 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"
incardon's avatar
incardon committed
32

33 34
#define CARTDEC_ERROR 2000lu

incardon's avatar
incardon committed
35 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
 * \tparam Domain Structure that contain the information of your physical domain
 *
43 44
 * 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
45
 * going to take care of that part of space (in general the space assigned to a processor is
46 47 48 49 50 51
 * 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
 *
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
 */

75
template<unsigned int dim, typename T, typename Memory=HeapMemory, template<unsigned int, typename> class Domain=Box>
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 111 112 113 114 115 116 117 118

	//! 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
119 120 121
	//! Cell-list that store the geometrical information of the local internal ghost boxes
	CellList<dim,T,FAST> lgeo_cell;

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
	// Heap memory receiver
	HeapMemory hp_recv;

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

	// Receive counter
	size_t recv_cnt;

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

	// Save the ghost boundaries
	Ghost<dim,T> ghost;

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

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

incardon's avatar
incardon committed
166
		// sub-sub-domain graph
incardon's avatar
incardon committed
167
		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
168 169 170 171 172 173 174 175

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

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

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

incardon's avatar
incardon committed
184 185
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
186
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
187 188 189 190

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

incardon's avatar
incardon committed
191
		// optimize the decomposition
incardon's avatar
incardon committed
192 193
		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
194 195 196
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
197 198
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
199 200 201
			sub_d.mul(spacing);
			sub_d.expand(spacing);

202 203 204 205 206 207 208 209 210 211 212 213 214
			// 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
215 216 217 218
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
219
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
220 221 222
			bbox = sub_d;
		}

incardon's avatar
incardon committed
223
		// convert into sub-domain
incardon's avatar
incardon committed
224
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
225
		{
226 227
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
228

incardon's avatar
incardon committed
229 230 231
			// 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
232

233 234 235 236 237 238 239 240 241 242 243 244 245
			// 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
246 247
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
248 249 250 251 252 253

			// 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
254
		}
incardon's avatar
incardon committed
255

256 257
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);

incardon's avatar
incardon committed
258
		// fill fine_s structure
incardon's avatar
incardon committed
259 260 261
		// 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
262 263 264 265 266 267 268 269 270 271 272
		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;
		}
273 274 275 276 277 278

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

incardon's avatar
incardon committed
279
		// calculate the sub-divisions
280 281
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
282
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
283 284 285 286 287 288 289 290 291

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

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

		// Initialize the geo_cell structure
incardon's avatar
incardon committed
292
		ie_ghost<dim,T>::Initialize_geo_cell(domain,div,orig);
incardon's avatar
incardon committed
293
		lgeo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
294 295 296 297 298 299 300 301
	}

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

		// 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:

incardon's avatar
incardon committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346
	//! 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
347 348 349 350 351 352
	/*! \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
353
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
354 355 356 357
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
358

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
	CartDecomposition(const CartDecomposition<dim,T,Memory,Domain> & cart)
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),ref_cnt(0)
	{
		this->operator=(cart);
	}

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
	CartDecomposition(CartDecomposition<dim,T,Memory,Domain> && cart)
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),ref_cnt(0)
	{
		this->operator=(cart);
	}

incardon's avatar
incardon committed
381 382 383 384
	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
385
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
386

387 388 389 390 391 392 393 394 395 396 397 398 399 400
	/*! \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
401
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
		{
			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
421
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
		{
			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
441
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
442 443 444 445 446
		{
			return p.lc_proc;
		}
	};

incardon's avatar
incardon committed
447
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
448 449 450 451 452
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
453 454 455
	 *
	 \verbatim

incardon's avatar
incardon committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
+----------------------------------------------------+
|                                                    |
|                 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                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

481 482
 \endverbatim

incardon's avatar
incardon committed
483
       and also
incardon's avatar
incardon committed
484
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
485

486 487
 \verbatim

incardon's avatar
incardon committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
+----------------------------------------------------+
|                                                    |
|                 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|                              |
 |          |   |                                    |    |                              |
 |          |   |                                    |    |                              |
 +--------------+------------------------------------+    |                              |
            |                                        |    |                              |
            +----------------------------------------+----+------------------------------+


514 515
 \endverbatim

incardon's avatar
incardon committed
516 517 518 519 520
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
521 522
	 *
	 \verbatim
incardon's avatar
incardon committed
523 524 525 526 527 528 529 530 531 532 533 534 535
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

536 537
     \endverbatim

incardon's avatar
incardon committed
538 539 540
	 *
	 *
	 */
incardon's avatar
incardon committed
541
	void calculateGhostBoxes()
incardon's avatar
incardon committed
542 543 544 545 546 547 548
	{
#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
549
			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
550
			{
551
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
552 553 554 555 556 557
			}
		}
#endif

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

incardon's avatar
incardon committed
558
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
559 560
		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
561

incardon's avatar
incardon committed
562
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
563 564 565

		ie_loc_ghost<dim,T>::create_loc_ghost_ibox(ghost,sub_domains);
		ie_loc_ghost<dim,T>::create_loc_ghost_ebox(ghost,sub_domains);
incardon's avatar
incardon committed
566 567 568 569 570 571

		// get the smallest sub-domain dimension on each direction
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (ghost.template getLow(i) >= ss_box.getHigh(i) || ghost.template getHigh(i)  >= domain.template getHigh(i) / gr.size(i))
			{
572
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
573 574
			}
		}
incardon's avatar
incardon committed
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 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
	/*! \brief It create anothe object that contain the same information and act in the same way
	 *
	 * \return a duplicated decomposition
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> duplicate()
	{
		CartDecomposition<dim,T,Memory,Domain> cart(v_cl);

		(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;

		//! Cell-list that store the geometrical information of the local internal ghost boxes
		cart.lgeo_cell = lgeo_cell;
		cart.ghost = ghost;

		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> & operator=(const CartDecomposition & cart)
	{
		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;

		//! Cell-list that store the geometrical information of the local internal ghost boxes
		lgeo_cell = cart.lgeo_cell;
		ghost = cart.ghost;

		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> & operator=(CartDecomposition && cart)
	{
		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;

		//! Cell-list that store the geometrical information of the local internal ghost boxes
		lgeo_cell.swap(cart.lgeo_cell);
		ghost = cart.ghost;

		return *this;
	}

666 667 668 669 670 671 672 673 674 675 676 677 678 679
	/*! \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));
	}

680
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
681 682 683 684
	 *
	 * \return processorID
	 *
	 */
incardon's avatar
incardon committed
685
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
686
	{
incardon's avatar
incardon committed
687
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
688 689
	}

incardon's avatar
incardon committed
690 691 692 693 694 695 696 697 698 699 700 701 702
	// 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;
	}

703
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
704 705 706 707 708
	 *
	 * \return processorID
	 *
	 */

709
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
710
	{
incardon's avatar
incardon committed
711
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
712 713
	}

incardon's avatar
incardon committed
714 715
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
716
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
717 718 719
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
720
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
721
	{
incardon's avatar
incardon committed
722 723
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
724 725
		// Set the decomposition parameters

incardon's avatar
incardon committed
726
		gr.setDimensions(div_);
incardon's avatar
incardon committed
727
		domain = domain_;
incardon's avatar
incardon committed
728
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
729 730 731 732 733 734

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

735
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
736 737 738 739 740 741 742 743 744
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
745
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
746
	 *
incardon's avatar
incardon committed
747 748
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
	 *
	 */
	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
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
	/*! \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
785 786 787 788 789 790 791 792 793 794
	/*! \brief Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */
	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
795 796 797
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
798
	 *
incardon's avatar
incardon committed
799
	 * \return true if it is local
incardon's avatar
incardon committed
800 801
	 *
	 */
802
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
803
	{
804
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
805
	}
incardon's avatar
incardon committed
806

incardon's avatar
incardon committed
807
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
808
	 *
incardon's avatar
incardon committed
809
	 * \param p object position
incardon's avatar
incardon committed
810
	 *
incardon's avatar
incardon committed
811
	 * \return true if it is local
incardon's avatar
incardon committed
812 813
	 *
	 */
814
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
815
	{
incardon's avatar
incardon committed
816 817
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
818 819 820

	::Box<dim,T> bbox;

821
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
822 823 824 825 826 827 828 829
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
830

831

832 833
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
834 835 836 837
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
838 839 840 841 842 843
	 * * 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
844
	 *
incardon's avatar
incardon committed
845
	 * where X is the local processor rank
incardon's avatar
incardon committed
846 847 848 849 850 851
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
852
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
853 854
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
855
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
856

857
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
858
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
859
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
860

861
		return true;
incardon's avatar
incardon committed
862
	}
incardon's avatar
incardon committed
863 864 865 866 867 868 869 870

	/*! \brief function to check the consistency of the information of the decomposition
	 *
	 * \return false if is inconsistent
	 *
	 */
	bool check_consistency()
	{
incardon's avatar
incardon committed
871 872
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
873 874 875

		return true;
	}
876 877 878

	void debugPrint()
	{
879 880 881 882 883 884
		std::cout << "Subdomains\n";
		for (size_t p = 0 ; p < sub_domains.size() ; p++)
		{
			std::cout << ::SpaceBox<dim,T>(sub_domains.get(p)).toString() << "\n";
		}

885
		std::cout << "External ghost box\n";
886

887 888
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
889
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
890
			{
incardon's avatar
incardon committed
891
				std::cout << ie_ghost<dim,T>::getProcessorEGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p) << "   id=" << ie_ghost<dim,T>::getProcessorEGhostId(p,i) << "\n";
892
			}
893
		}
894

895
		std::cout << "Internal ghost box\n";
896

897 898
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
899
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNIGhost(p) ; i++)
900
			{
incardon's avatar
incardon committed
901
				std::cout << ie_ghost<dim,T>::getProcessorIGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p)  << "   id=" << ie_ghost<dim,T>::getProcessorIGhostId(p,i) <<  "\n";
902 903
			}
		}
904
	}
incardon's avatar
incardon committed
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945

	/*! \brief Check if the CartDecomposition contain the same information
	 *
	 * \param ele Element to check
	 *
	 */
	bool is_equal(CartDecomposition<dim,T,Memory,Domain> & cart)
	{
		static_cast<ie_loc_ghost<dim,T>*>(this)->is_equal(static_cast<ie_loc_ghost<dim,T>&>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->is_equal(static_cast<nn_prcs<dim,T>&>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->is_equal(static_cast<ie_ghost<dim,T>&>(cart));

		if (sub_domains != cart.sub_domains)
			return false;

		if (box_nn_processor != cart.box_nn_processor)
			return false;

		if (fine_s != cart.fine_s)
			return false;

		if (gr != cart.gr)
			return false;


		if (cd != cart.cd)
			return false;

		if (domain != cart.domain)
			return false;

		std::copy(cart.spacing,cart.spacing+3,spacing);

		if (lgeo_cell != cart.lgeo_cell)
			return false;

		if (ghost != cart.ghost)
			return false;

		return true;
	}
incardon's avatar
incardon committed
946 947 948 949
};


#endif