CartDecomposition.hpp 38.9 KB
Newer Older
incardon's avatar
incardon committed
1 2 3
/*
 * CartDecomposition.hpp
 *
4
 *  Created on: Oct 07, 2015
5
 *      Author: Pietro Incardona, Antonio Leo
incardon's avatar
incardon committed
6 7 8 9 10 11
 */

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
12
#include <cmath>
13 14
#include "VCluster.hpp"
#include "Graph/CartesianGraphFactory.hpp"
incardon's avatar
incardon committed
15
#include "Decomposition.hpp"
incardon's avatar
incardon committed
16
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
17 18 19 20 21
#include <vector>
#include <initializer_list>
#include "SubdomainGraphNodes.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"
27 28
#include "common.hpp"
#include "ie_loc_ghost.hpp"
29 30
#include "ie_ghost.hpp"
#include "nn_processor.hpp"
31
#include "GraphMLWriter/GraphMLWriter.hpp"
32 33 34 35
#include "Distribution/ParMetisDistribution.hpp"
#include "Distribution/DistParMetisDistribution.hpp"
#include "Distribution/MetisDistribution.hpp"
#include "DLB/DLB.hpp"
36
#include "util/se_util.hpp"
37
#include "util/mathutil.hpp"
Pietro Incardona's avatar
Pietro Incardona committed
38
#include "CartDecomposition_ext.hpp"
incardon's avatar
incardon committed
39

40 41
#define CARTDEC_ERROR 2000lu

incardon's avatar
incardon committed
42
/**
Pietro Incardona's avatar
Pietro Incardona committed
43
 * \brief This class decompose a space into sub-sub-domains and distribute them across processors
incardon's avatar
incardon committed
44 45 46 47
 *
 * \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
48
 * \tparam Distribution type of distribution, can be ParMetisDistribution or MetisDistribution
incardon's avatar
incardon committed
49
 *
50
 * Given an N-dimensional space, this class decompose the space into a Cartesian grid of small
incardon's avatar
incardon committed
51 52 53 54
 * 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
55 56 57 58
 *
 * Assuming that VCluster.getProcessUnitID(), equivalent to the MPI processor rank, return the processor local
 * processor id, we define
 *
59 60
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
61 62 63 64 65 66 67 68 69 70 71 72
 * * 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
73
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
74 75
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
76
 *
77 78 79
 * ### 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
80 81
 */

Pietro Incardona's avatar
Pietro Incardona committed
82
template<unsigned int dim, typename T, typename Memory, typename Distribution>
83
class CartDecomposition: public ie_loc_ghost<dim, T>, public nn_prcs<dim, T>, public ie_ghost<dim, T>
incardon's avatar
incardon committed
84
{
incardon's avatar
incardon committed
85

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

incardon's avatar
incardon committed
88 89 90 91
	//! Type of the domain we are going to decompose
	typedef T domain_type;

	//! It simplify to access the SpaceBox element
92
	typedef SpaceBox<dim, T> Box;
incardon's avatar
incardon committed
93

Pietro Incardona's avatar
Pietro Incardona committed
94 95 96 97 98 99 100
	//! This class is base of itself
	typedef CartDecomposition<dim,T,Memory,Distribution> base_type;

	//! This class admit a class defined on an extended domain
	typedef CartDecomposition_ext<dim,T,Memory,Distribution> extended_type;

protected:
incardon's avatar
incardon committed
101

incardon's avatar
incardon committed
102
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
103
	//! acc_key is size_t
104
	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
105 106

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

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

incardon's avatar
incardon committed
112
	//! Structure that contain for each sub-sub-domain box the processor id
incardon's avatar
incardon committed
113
	//! exist for efficient global communication
incardon's avatar
incardon committed
114 115
	openfpm::vector<size_t> fine_s;

incardon's avatar
incardon committed
116
	//! Structure that store the cartesian grid information
117
	grid_sm<dim, void> gr;
incardon's avatar
incardon committed
118

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

	//! rectangular domain to decompose
124
	::Box<dim,T> domain;
incardon's avatar
incardon committed
125 126 127 128 129 130 131

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

132
	//! Create distribution
133 134
	Distribution dist;

135 136 137 138
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

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

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

143
	// ghost info
144 145
	Ghost<dim,T> ghost;

146 147
	// Boundary condition info
	size_t bc[dim];
incardon's avatar
incardon committed
148

149 150 151 152 153 154
	// Heap memory receiver
	HeapMemory hp_recv;

	// Receive counter
	size_t recv_cnt;

Pietro Incardona's avatar
Pietro Incardona committed
155 156 157 158 159 160
protected:



public:

161
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
162
	 *
163 164
	 * \param v_cl Virtual cluster, used internally for communications
	 *
incardon's avatar
incardon committed
165
	 */
Pietro Incardona's avatar
Pietro Incardona committed
166
	void createSubdomains(Vcluster & v_cl, const size_t (& bc)[dim])
incardon's avatar
incardon committed
167
	{
168 169 170 171 172 173 174
#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
175 176 177

		int p_id = v_cl.getProcessUnitID();

incardon's avatar
incardon committed
178 179 180
		// Calculate the total number of box and and the spacing
		// on each direction
		// Get the box containing the domain
181
		SpaceBox<dim, T> bs = domain.getBox();
incardon's avatar
incardon committed
182

183
		for (unsigned int i = 0; i < dim; i++)
incardon's avatar
incardon committed
184 185
		{
			// Calculate the spacing
incardon's avatar
incardon committed
186
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
187 188
		}

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

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

		// set of Boxes produced by the decomposition optimizer
197
		openfpm::vector<::Box<dim, size_t>> loc_box;
incardon's avatar
incardon committed
198

incardon's avatar
incardon committed
199
		// optimize the decomposition
200
		d_o.template optimize<nm_v::sub_id, nm_v::proc_id>(dist.getGraph(), p_id, loc_box, box_nn_processor,bc);
incardon's avatar
incardon committed
201

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

			// we add the
incardon's avatar
incardon committed
212

213 214 215
			// Fixing sub-domains to cover all the domain

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

223 224
				if (sub_dc.getLow(i) == 0)
					sub_d.setLow(i,domain.getLow(i));
225 226
			}

incardon's avatar
incardon committed
227 228 229 230
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
231
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
232 233 234
			bbox = sub_d;
		}

235 236 237 238
/*		if (loc_box.size())
		bbox.zero();
		ss_box = domain;*/

incardon's avatar
incardon committed
239
		// convert into sub-domain
240
		for (size_t s = 1; s < loc_box.size(); s++)
incardon's avatar
incardon committed
241
		{
242 243
			SpaceBox<dim, size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim, T> sub_d(sub_dc);
incardon's avatar
incardon committed
244

incardon's avatar
incardon committed
245 246 247
			// re-scale and add spacing (the end is the starting point of the next domain + spacing)
			sub_d.mul(spacing);
			sub_d.expand(spacing);
248
			sub_d += domain.getP1();
incardon's avatar
incardon committed
249

250 251 252 253 254
			// 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)
255
			for (size_t i = 0; i < dim; i++)
256 257
			{
				if (sub_dc.getHigh(i) == cd.getGrid().size(i) - 1)
258
					sub_d.setHigh(i, domain.getHigh(i));
259

260 261
				if (sub_dc.getLow(i) == 0)
					sub_d.setLow(i,domain.getLow(i));
262 263
			}

incardon's avatar
incardon committed
264 265
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
266 267 268 269 270 271

			// 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
272
		}
incardon's avatar
incardon committed
273

274
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);
275
		nn_prcs<dim,T>::refine_ss_box(ss_box);
276
		nn_prcs<dim,T>::applyBC(domain,ghost,bc);
277

incardon's avatar
incardon committed
278
		// fill fine_s structure
incardon's avatar
incardon committed
279 280 281
		// 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)
282
		auto it = dist.getGraph().getVertexIterator();
incardon's avatar
incardon committed
283 284 285 286 287 288

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

			// fill with the fine decomposition
289
			fine_s.get(key) = dist.getGraph().template vertex_p<nm_v::proc_id>(key);
incardon's avatar
incardon committed
290 291 292

			++it;
		}
293

294 295 296 297 298 299 300 301 302 303
		Initialize_geo_cell_lists();
	}

	/*! \brief Initialize geo_cell lists
	 *
	 *
	 *
	 */
	void Initialize_geo_cell_lists()
	{
304
		// Get the smallest sub-division on each direction
305
		::Box<dim, T> unit = getSmallestSubdivision();
306 307
		// Get the processor bounding Box
		::Box<dim,T> bound = getProcessorBounds();
Pietro Incardona's avatar
Pietro Incardona committed
308 309
		// Not necessary, but I prefer
		bound.enlarge(ghost);
310

311
		// calculate the sub-divisions
312
		size_t div[dim];
313 314
		for (size_t i = 0; i < dim; i++)
			div[i] = (size_t) ((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
315 316

		// Initialize the geo_cell structure
317
		ie_ghost<dim,T>::Initialize_geo_cell(bound,div);
318

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

323 324 325 326 327 328
	/*! \brief Calculate communication and migration costs
	 *
	 * \param ts how many timesteps have passed since last calculation, used to approximate the cost
	 */
	void computeCommunicationAndMigrationCosts(size_t ts)
	{
329
		float migration = 0;
330 331 332 333 334 335 336 337 338

		SpaceBox<dim, T> cellBox = cd.getCellBox();
		float b_s = cellBox.getHigh(0);
		float gh_s = ghost.getHigh(0);

		// compute the gh_area for 2 dim case
		float gh_v = (gh_s * b_s);

		// multiply for sub-sub-domain side for each domain
339
		for (size_t i = 2; i < dim; i++)
340 341 342 343 344 345 346 347 348 349
			gh_v *= b_s;

		size_t norm = (size_t) (1.0 / gh_v);

		migration = pow(b_s, dim);

		size_t prev = 0;

		for (size_t i = 0; i < dist.getNSubSubDomains(); i++)
		{
350
			dist.setMigrationCost(i, norm * migration * dist.getSubSubDomainComputationCost(i));
351 352 353

			for (size_t s = 0; s < dist.getNSubSubDomainNeighbors(i); s++)
			{
354
				dist.setCommunicationCost(i, s, 1 * dist.getSubSubDomainComputationCost(i) * ts);
355 356 357 358
			}
			prev += dist.getNSubSubDomainNeighbors(i);
		}
	}
incardon's avatar
incardon committed
359

incardon's avatar
incardon committed
360 361 362 363 364 365
	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
366
		grid_sm<dim, void> g(div);
incardon's avatar
incardon committed
367 368 369 370 371 372 373 374 375 376 377

		// 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
378
			SpaceBox<dim, T> tmp;
incardon's avatar
incardon committed
379 380

			//! fill with the Margin of the box
381
			for (int i = 0; i < dim; i++)
incardon's avatar
incardon committed
382
			{
383 384
				tmp.setHigh(i, (key.get(i) + 1) * spacing[i]);
				tmp.setLow(i, key.get(i) * spacing[i]);
incardon's avatar
incardon committed
385 386 387 388 389 390 391 392 393 394
			}

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

			// add the iterator
			++gk_it;
		}
	}

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 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 481 482 483 484 485 486 487 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 514 515 516 517 518 519 520 521

	/*! It calculate the internal ghost boxes
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
	 *
	 \verbatim

+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
|                 Sub+domain 0                       +-----------------------------------+
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |B9_0|                                   |
 |              | B |    Local processor        |    |                                   |
 | Processor 5  | 5 |    Subdomain 0            |    |                                   |
 | Subdomain 0  | _ |                           +----------------------------------------+
 |              | 0 |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+


 \endverbatim

       and also
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)

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

	 \endverbatim

	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
	 *
	 \verbatim

	 	 	 	 	 ^ p2[1]
	 	 	 	 	 |
	 	 	 	 	 |
	 	 	 	+----+----+
	 	 	 	|         |
	 	 	 	|         |
	 p1[0]<-----+         +----> p2[0]
	 	 	 	|         |
	 	 	 	|         |
	 	 	 	+----+----+
	 	 	 	 	 |
	 	 	 	 	 v  p1[1]

	 \endverbatim

	 *
	 *
	 */
	void calculateGhostBoxes()
	{
#ifdef DEBUG
		// the ghost margins are assumed to be smaller
		// than one sub-domain

		for (size_t i = 0; i < dim; i++)
		{
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
			{
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
			}
		}
#endif

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

		// create the internal structures that store ghost information
		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);

		ie_loc_ghost<dim,T>::create(sub_domains,domain,ghost,bc);

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

incardon's avatar
incardon committed
522 523
public:

524 525 526 527
	static constexpr int dims = dim;

	typedef T stype;

incardon's avatar
incardon committed
528 529 530 531 532 533 534 535 536 537 538 539 540 541
	//! 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
542 543
	/*! \brief Cartesian decomposition constructor
	 *
544
	 * \param v_cl Virtual cluster, used internally to handle or pipeline communication
incardon's avatar
incardon committed
545 546
	 *
	 */
547
	CartDecomposition(Vcluster & v_cl) :
548
			nn_prcs<dim, T>(v_cl), v_cl(v_cl), dist(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
549 550 551 552
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
553

554 555 556 557 558
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
559
	CartDecomposition(const CartDecomposition<dim,T,Memory> & cart)
560
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
561 562 563 564 565 566 567 568 569
	{
		this->operator=(cart);
	}

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

incardon's avatar
incardon committed
576 577
	//! Cartesian decomposition destructor
	~CartDecomposition()
578 579
	{
	}
incardon's avatar
incardon committed
580

581 582 583 584 585 586 587 588 589 590 591 592 593 594
	/*! \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
		 *
		 */
595
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
		{
			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
		 *
		 */
615
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
		{
			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
		 *
		 */
635
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
636 637 638 639 640
		{
			return p.lc_proc;
		}
	};

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
	/*! \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;
		}
	};

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
	/*! \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));
		}
	}

703 704 705 706 707 708 709
	/*! \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
	 *
	 */
710
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
711
	{
712
		CartDecomposition<dim,T,Memory> cart(v_cl);
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

		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;

730 731
		cart.dist = dist;

732 733 734
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

735 736
		(static_cast<nn_prcs<dim,T> &>(cart)).create(box_nn_processor, sub_domains);
		(static_cast<nn_prcs<dim,T> &>(cart)).applyBC(domain,ghost,bc);
737

738 739
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
740 741 742 743 744

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
745 746 747 748
	 *
	 * \return a duplicated decomposition
	 *
	 */
749
	CartDecomposition<dim,T,Memory> duplicate() const
750
	{
751
		CartDecomposition<dim,T,Memory> cart(v_cl);
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769

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

770 771 772
		cart.bbox = bbox;
		cart.ss_box = ss_box;

773 774 775
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = this->bc[i];

776 777 778 779 780 781 782 783
		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
	 */
784
	CartDecomposition<dim,T,Memory> & operator=(const CartDecomposition & cart)
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
	{
		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;

803 804 805
		bbox = cart.bbox;
		ss_box = cart.ss_box;

806 807 808
		for (size_t i = 0 ; i < dim ; i++)
			bc[i] = cart.bc[i];

809 810 811 812 813 814 815 816
		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
	 */
817
	CartDecomposition<dim,T,Memory> & operator=(CartDecomposition && cart)
818
	{
Pietro Incardona's avatar
Pietro Incardona committed
819 820 821
		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));
822 823 824 825 826 827 828 829 830 831 832 833 834 835

		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;

836 837 838
		cart.bbox = bbox;
		cart.ss_box = ss_box;

839 840 841
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

842 843 844
		return *this;
	}

845 846 847 848 849 850 851 852 853 854 855
	/*! \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
856
		return openfpm::math::round_big_2(pow(n_sub, 1.0 / dim));
857 858
	}

859
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
860 861 862 863
	 *
	 * \return processorID
	 *
	 */
864
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
865
	{
866
		return fine_s.get(cd.template getCell<ofb>(p));
incardon's avatar
incardon committed
867 868
	}

869
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
870
	 *
871
	 * \return processorID
incardon's avatar
incardon committed
872 873
	 *
	 */
874
	size_t inline processorID(const Point<dim,T> &p) const
incardon's avatar
incardon committed
875
	{
incardon's avatar
incardon committed
876
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
877 878
	}

879
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
880 881 882 883
	 *
	 * \return processorID
	 *
	 */
884
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
885
	{
incardon's avatar
incardon committed
886
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
887
	}
incardon's avatar
incardon committed
888

889
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
890
	 *
891 892 893
	 * Boundary conditions are considered
	 *
	 * \return processorID
incardon's avatar
incardon committed
894 895
	 *
	 */
896
	template<typename Mem> size_t inline processorIDBC(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
897
	{
898 899 900 901
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(pt));
incardon's avatar
incardon committed
902 903
	}

904
	/*! \brief Given a point return in which processor the particle should go
905 906
	 *
	 * Boundary conditions are considered
incardon's avatar
incardon committed
907 908 909 910
	 *
	 * \return processorID
	 *
	 */
911
	template<typename ofb> size_t inline processorIDBC(const Point<dim,T> &p) const
912 913 914
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);
incardon's avatar
incardon committed
915

916 917 918 919 920 921 922 923 924 925
		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
	 *
	 */
926
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
incardon's avatar
incardon committed
927
	{
928 929 930
		Point<dim,T> pt = p;
		applyPointBC(pt);

incardon's avatar
incardon committed
931
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
932 933
	}

934 935 936 937 938 939 940 941 942 943
	/*! \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;
	}

944 945 946 947 948 949 950 951 952 953 954 955
	/*! \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
956 957
	/*! \brief Set the parameter of the decomposition
	 *
958 959
	 * \param div_ storing into how many domain to decompose on each dimension
	 * \param domain_ domain to decompose
incardon's avatar
incardon committed
960 961
	 *
	 */
962
	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
963
	{
964 965 966 967
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

incardon's avatar
incardon committed
968 969
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
970

971
		// Set the decomposition parameters
incardon's avatar
incardon committed
972
		gr.setDimensions(div_);
incardon's avatar
incardon committed
973
		domain = domain_;
974
		cd.setDimensions(domain, div_, 0);
incardon's avatar
incardon committed
975

976
		// init distribution
977
		dist.createCartGraph(gr, domain);
978 979 980

	}

981 982 983 984 985 986 987 988 989 990
	void reset()
	{
		sub_domains.clear();
		box_nn_processor.clear();
		fine_s.clear();
		nn_prcs<dim, T>::reset();
		ie_ghost<dim, T>::reset();
		ie_loc_ghost<dim, T>::reset();
	}

991 992 993 994 995
	/*! \brief Start decomposition
	 *
	 */
	void decompose()
	{
996 997
		reset();

998 999 1000
		computeCommunicationAndMigrationCosts(1);

		dist.decompose();
incardon's avatar
incardon committed
1001

1002
		createSubdomains(v_cl,bc);
1003 1004

		calculateGhostBoxes();
incardon's avatar
incardon committed
1005 1006
	}

1007 1008 1009
	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
	 *
	 */
1010
	void rebalance(size_t ts)
1011
	{
1012 1013 1014
		reset();

		computeCommunicationAndMigrationCosts(ts);
1015 1016

		dist.refine();
1017 1018 1019 1020

		createSubdomains(v_cl,bc);

		calculateGhostBoxes();
1021 1022 1023 1024
	}

	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
	 *
1025
	 * \return true if the re-balance has been executed, false otherwise
1026
	 */
1027
	bool rebalance(DLB & dlb)
1028
	{
1029 1030 1031 1032 1033 1034 1035
		// if the DLB heuristic to use is the "Unbalance Threshold" get unbalance percentage
		if (dlb.getHeurisitc() == DLB::Heuristic::UNBALANCE_THRLD)
		{
			float unbalance = dist.getUnbalance();
			dlb.setUnbalance(unbalance);
			if (v_cl.getProcessUnitID() == 0)
			{
1036
				std::cout << std::setprecision(3) << unbalance << "\n";
1037 1038 1039
			}
		}

1040 1041
		if (dlb.rebalanceNeeded())
		{
1042 1043
			rebalance(dlb.getNTimeStepSinceDLB());

1044
			return true;
1045
		}
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		return false;
	}

	/*! \brief Get the current un-balance value
	 *
	 * \return the un-balance percentage value
	 */
	float getUnbalance()
	{
		return dist.getUnbalance();
	}

	/*! \brief Compute the processor load counting the total weights of its vertices
	 *
	 * \return the current processor load
	 */
	size_t getProcessorLoad()
	{
		return dist.getProcessorLoad();
1065 1066 1067 1068 1069 1070 1071 1072
	}

	/*! \brief function that return the position of the cell in the space
	 *
	 * \param id vertex id
	 * \param pos vector that will contain x, y, z
	 *
	 */
1073
	inline void getSubSubDomainPosition(size_t id, T (&pos)[dim])
1074
	{
1075
		dist.getSubSubDomainPosition(id, pos);
1076 1077
	}

1078
	//TODO fix in Parmetis distribution to get only the right amount of vertices
1079 1080
	/*! \brief Get the number of sub-sub-domains in this sub-graph
	 *
1081
	 * \return number of sub-sub-domains in this sub-graph
1082 1083 1084 1085 1086 1087
	 */
	size_t getNSubSubDomains()
	{
		return dist.getNSubSubDomains();
	}

1088 1089 1090 1091 1092 1093 1094
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline void setSubSubDomainComputationCost(size_t id, size_t weight)
	{
1095
		dist.setComputationCost(id, weight);
1096 1097
	}

1098 1099 1100 1101 1102 1103 1104
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline size_t getSubSubDomainComputationCost(size_t id)
	{
1105
		return dist.getComputationCost(id);
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	}

	/*! \brief Operator to access the size of the sub-graph
	 *
	 * \return the size of the subgraph
	 */
	size_t subSize()
	{
		return dist.subSize();
	}

1117
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
1118 1119 1120 1121
	 *
	 * \return the number of sub-domains
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1122
	size_t getNSubDomain()
incardon's avatar
incardon committed
1123 1124 1125 1126
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
1127
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
1128
	 *
incardon's avatar
incardon committed
1129 1130
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
1131 1132
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1133
	SpaceBox<dim, T> getSubDomain(size_t lc)
incardon's avatar
incardon committed
1134 1135
	{
		// Create a space box
1136
		SpaceBox<dim, T> sp;
incardon's avatar
incardon committed
1137 1138 1139

		// fill the space box

1140
		for (size_t k = 0; k < dim; k++)
incardon's avatar
incardon committed
1141 1142
		{
			// create the SpaceBox Low and High
1143 1144
			sp.setLow(k, sub_domains.template get<Box::p1>(lc)[k]);
			sp.setHigh(k, sub_domains.template get<Box::p2>(lc)[k]);
incardon's avatar
incardon committed
1145 1146 1147 1148 1149
		}

		return sp;
	}

incardon's avatar
incardon committed
1150 1151 1152 1153 1154 1155
	/*! \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
	 *
	 */
1156
	SpaceBox<dim, T> getSubDomainWithGhost(size_t lc)
incardon's avatar
incardon committed
1157 1158
	{
		// Create a space box
1159
		SpaceBox<dim, T> sp = sub_domains.get(lc);
incardon's avatar
incardon committed
1160 1161 1162 1163 1164 1165 1166

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

		return sp;
	}

1167
	/*! \brief Return the box of the physical domain
incardon's avatar
incardon committed
1168
	 *
1169
	 * \return The physical domain box
incardon's avatar
incardon committed
1170 1171
	 *
	 */
1172
	const ::Box<dim,T> & getDomain()
incardon's avatar
incardon committed
1173 1174 1175 1176
	{
		return domain;
	}

incardon's avatar
incardon committed
1177
	/*! \brief Check if the particle is local
1178 1179
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
1180 1181
	 *
	 * \param p object position
incardon's avatar
incardon committed
1182
	 *
incardon's avatar
incardon committed
1183
	 * \return true if it is local
incardon's avatar
incardon committed
1184 1185
	 *
	 */
1186
	template<typename Mem> bool isLocal(const encapc<1, Point<dim, T>, Mem> p) const
incardon's avatar
incardon committed
1187
	{
1188
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
1189
	}
incardon's avatar
incardon committed
1190

incardon's avatar
incardon committed
1191
	/*! \brief Check if the particle is local
1192 1193
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
1194
	 *
incardon's avatar
incardon committed
1195
	 * \param p object position
incardon's avatar
incardon committed
1196
	 *
incardon's avatar
incardon committed
1197
	 * \return true if it is local
incardon's avatar
incardon committed
1198 1199
	 *
	 */
1200
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
1201
	{
incardon's avatar
incardon committed
1202 1203
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
1204

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
	/*! \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();
	}

incardon's avatar
incardon committed
1249

1250
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
1251 1252 1253 1254
	 *
	 * \return The bounding box
	 *
	 */
1255
	::Box<dim, T> & getProcessorBounds()
incardon's avatar
incardon committed
1256 1257 1258
	{
		return bbox;
	}
incardon's avatar
incardon committed
1259

1260

1261 1262 1263 1264 1265 1266 1267 1268 1269
	/*! \brief Return the ghost
	 *
	 *
	 */
	const Ghost<dim,T> & getGhost() const
	{
		return ghost;
	}

1270 1271 1272 1273 1274 1275 1276 1277 1278
	/*! \brief Method to access to the grid information of the decomposition
	 *
	 * \return the grid
	 */
	const grid_sm<dim,void> getGrid()
	{
		return gr;
	}

1279 1280
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
1281 1282 1283 1284
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
1285 1286 1287 1288 1289 1290
	 * * 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
1291
	 *
incardon's avatar
incardon committed
1292
	 * where X is the local processor rank
incardon's avatar
incardon committed
1293 1294 1295 1296 1297 1298
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
1299
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
1300
		VTKWriter<openfpm::vector<::SpaceBox<dim, T>>, VECTOR_BOX> vtk_box1;
incardon's avatar
incardon committed
1301
		vtk_box1.add(sub_domains);
1302
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
1303

1304 1305 1306
		nn_prcs<dim, T>::write(output);
		ie_ghost<dim, T>::write(output, v_cl.getProcessUnitID());
		ie_loc_ghost<dim, T>::write(output, v_cl.getProcessUnitID());
incardon's avatar
incardon committed
1307

1308
		return true;
incardon's avatar
incardon committed
1309
	}
incardon's avatar
incardon committed
1310

1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
	/*! \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
1324 1325 1326 1327 1328 1329 1330
	/*! \brief function to check the consistency of the information of the decomposition
	 *
	 * \return false if is inconsistent
	 *
	 */
	bool check_consistency()
	{
Pietro Incardona's avatar
Pietro Incardona committed
1331
		if (ie_loc_ghost<dim, T>::check_consistency(getNSubDomain()) == false)
1332
			return false;
incardon's avatar
incardon committed
1333 1334 1335

		return true;
	}
1336

1337 1338 1339
	/*! \brief Print subdomains, external and internal ghost boxes
	 *
	 */
1340 1341
	void debugPrint()
	{
1342
		std::cout << "Subdomains\n";
1343
		for (size_t p = 0; p < sub_domains.size(); p++)
1344
		{
1345
			std::cout << ::SpaceBox<dim, T>(sub_domains.get(p)).toString() << "\n";
1346 1347
		}

1348
		std::cout << "External ghost box\n";
1349

1350
		for (size_t p = 0; p<nn_prcs < dim, T>::getNNProcessors(); p++)
1351
		{
1352
			for (size_t i = 0; i<ie_ghost < dim, T>::getProcessorNEGhost(p); i++)
1353
			{
1354
				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";
1355
			}
1356
		}
1357

1358
		std::cout << "Internal ghost box\n";
1359

1360
		for (size_t p = 0; p<nn_prcs < dim, T>::getNNProcessors(); p++)
1361
		{
1362
			for (size_t i = 0; i<ie_ghost < dim, T>::getProcessorNIGhost(p); i++)
1363
			{
1364
				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";
1365 1366
			}
		}
1367
	}
incardon's avatar
incardon committed
1368

incardon's avatar
incardon committed
1369
	/*! \brief Check if the CartDecomposition contain the same information
1370
	 *
incardon's avatar
incardon committed
1371
	 * \param ele Element to check
1372 1373
	 *
	 */
1374
	bool is_equal(CartDecomposition<dim,T,Memory> & cart)
1375
	{
Pietro Incardona's avatar
Pietro Incardona committed
1376 1377
		if (static_cast<ie_loc_ghost<dim,T>*>(this)->is_equal(static_cast<ie_loc_ghost<dim,T>&>(cart)) == false)
			return false;
1378

Pietro Incardona's avatar
Pietro Incardona committed
1379 1380 1381 1382 1383
		if (static_cast<nn_prcs<dim,T>*>(this)->is_equal(static_cast<nn_prcs<dim,T>&>(cart)) == false)
			return false;

		if (static_cast<ie_ghost<dim,T>*>(this)->is_equal(static_cast<ie_ghost<dim,T>&>(cart)) == false)
			return false;
incardon's avatar
incardon committed
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402

		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;

1403
		if (meta_compare<T[dim]>::meta_compare_f(cart.spacing,spacing) == false)
incardon's avatar
incardon committed
1404 1405 1406 1407 1408 1409
			return false;

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

		return true;
1410 1411
	}

1412 1413 1414 1415 1416 1417
	/*! \brief Check if the CartDecomposition contain the same information with the exception of the ghost part
	 * It is anyway required that the ghost come from the same sub-domains decomposition
	 *
	 * \param ele Element to check
	 *
	 */
1418
	bool is_equal_ng(CartDecomposition<dim,T,Memory> & cart)
1419
	{
Pietro Incardona's avatar
Pietro Incardona committed
1420 1421 1422 1423 1424 1425 1426 1427
		if (static_cast<ie_loc_ghost<dim,T>*>(this)->is_equal_ng(static_cast<ie_loc_ghost<dim,T>&>(cart)) == false)
			return false;

		if (static_cast<nn_prcs<dim,T>*>(this)->is_equal(static_cast<nn_prcs<dim,T>&>(cart)) == false)
			return false;

		if (static_cast<ie_ghost<dim,T>*>(this)->is_equal_ng(static_cast<ie_ghost<dim,T>&>(cart)) == false)
			return false;
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450

		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;

		if (meta_compare<T[dim]>::meta_compare_f(cart.spacing,spacing) == false)
			return false;

		return true;
1451 1452
	}

1453
	/*! \brief Return the distribution object
1454
	 *
1455
	 * \return the distribution object
1456 1457
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1458
	Distribution & getDistribution()
1459
	{
1460
		return dist;
1461
	}
1462

tonynsyde's avatar
tonynsyde committed
1463

1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
	/*! \brief Add computation cost i to the subsubdomain with global id gid
	 *
	 * \param gid global id of the subsubdomain to update
	 * \param i Cost increment
	 */
	inline void addComputationCost(size_t gid, size_t i)
	{
		size_t c = dist.getSubSubDomainComputationCost(gid);

		dist.setComputationCost(gid, c + i);
	}
tonynsyde's avatar
tonynsyde committed
1475

Pietro Incardona's avatar
Pietro Incardona committed
1476 1477 1478
	// friend classes

	friend extended_type;
tonynsyde's avatar
tonynsyde committed
1479