CartDecomposition.hpp 38.5 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"
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 "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
tonynsyde's avatar
tonynsyde committed
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)
Pietro Incardona's avatar
Pietro Incardona committed
73
 * * Local ghosts internal 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
Pietro Incardona's avatar
Pietro Incardona committed
104 105 106 107 108 109
	typedef typename openfpm::vector<SpaceBox<dim, T>,
			Memory,
			typename memory_traits_lin<SpaceBox<dim, T>>::type,
			memory_traits_lin,
			openfpm::vector_grow_policy_default,
			openfpm::vect_isel<SpaceBox<dim, T>>::value>::access_key acc_key;
incardon's avatar
incardon committed
110 111

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

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

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

incardon's avatar
incardon committed
121
	//! Structure that store the cartesian grid information
122
	grid_sm<dim, void> gr;
incardon's avatar
incardon committed
123

incardon's avatar
incardon committed
124 125
	//! Structure that decompose your structure into cell without creating them
	//! useful to convert positions to CellId or sub-domain id in this case
126
	CellDecomposer_sm<dim, T, shift<dim,T>> cd;
incardon's avatar
incardon committed
127 128

	//! rectangular domain to decompose
Pietro Incardona's avatar
Pietro Incardona committed
129
	::Box<dim,T> domain;
incardon's avatar
incardon committed
130 131 132 133 134 135 136

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

137
	//! Create distribution
138 139
	Distribution dist;

140
	//! Smallest subdivision on each direction
incardon's avatar
incardon committed
141 142
	::Box<dim,T> ss_box;

143
	//! Processor bounding box
incardon's avatar
incardon committed
144
	::Box<dim,T> bbox;
incardon's avatar
incardon committed
145

146
	//! reference counter of the object in case is shared between object
147 148
	long int ref_cnt;

149
	//! ghost info
150 151
	Ghost<dim,T> ghost;

152
	//! Boundary condition info
Pietro Incardona's avatar
Pietro Incardona committed
153
	size_t bc[dim];
incardon's avatar
incardon committed
154

Pietro Incardona's avatar
Pietro Incardona committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
	/*! \brief It convert the box from the domain decomposition into sub-domain
	 *
	 * The decomposition box from the domain-decomposition contain the box in integer
	 * coordinates
	 *
	 * \param loc_box local box
	 *
	 * \return the corresponding sib-domain
	 *
	 */
	SpaceBox<dim,T> convertDecBoxIntoSubDomain(const SpaceBox<dim,size_t> & loc_box)
	{
		// A point with all coordinate to one
		size_t one[dim];
		for (size_t i = 0 ; i < dim ; i++)	{one[i] = 1;}

		SpaceBox<dim, size_t> sub_dc = loc_box;
		SpaceBox<dim, size_t> sub_dce = sub_dc;
		sub_dce.expand(one);
		SpaceBox<dim, T> sub_d(sub_dce);
		sub_d.mul(spacing);
		sub_d += domain.getP1();

		// we add the

		// Fixing sub-domains to cover all the domain

		// Fixing sub_d
		// if (loc_box) is at 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));

			if (sub_dc.getLow(i) == 0)
				sub_d.setLow(i,domain.getLow(i));
		}

		return sub_d;
	}

Pietro Incardona's avatar
Pietro Incardona committed
197 198 199 200 201 202
protected:



public:

203
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
204
	 *
205 206
	 * \param v_cl Virtual cluster, used internally for communications
	 *
incardon's avatar
incardon committed
207
	 */
Pietro Incardona's avatar
Pietro Incardona committed
208
	void createSubdomains(Vcluster & v_cl, const size_t (& bc)[dim])
incardon's avatar
incardon committed
209
	{
210 211 212 213 214 215 216
#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
217 218 219

		int p_id = v_cl.getProcessUnitID();

incardon's avatar
incardon committed
220 221 222
		// Calculate the total number of box and and the spacing
		// on each direction
		// Get the box containing the domain
223
		SpaceBox<dim, T> bs = domain.getBox();
incardon's avatar
incardon committed
224

225
		for (unsigned int i = 0; i < dim; i++)
incardon's avatar
incardon committed
226 227
		{
			// Calculate the spacing
incardon's avatar
incardon committed
228
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
229 230
		}

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

incardon's avatar
incardon committed
234 235
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
236
		dec_optimizer<dim, Graph_CSR<nm_v, nm_e>> d_o(dist.getGraph(), gr.getSize());
incardon's avatar
incardon committed
237 238

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

241 242 243 244 245 246 247 248 249 250
		// Ghost
		Ghost<dim,long int> ghe;

		// Set the ghost
		for (size_t i = 0 ; i < dim ; i++)
		{
			ghe.setLow(i,static_cast<long int>(ghost.getLow(i)/spacing[i]) - 1);
			ghe.setHigh(i,static_cast<long int>(ghost.getHigh(i)/spacing[i]) + 1);
		}

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

Pietro Incardona's avatar
Pietro Incardona committed
254 255 256 257
		// reset ss_box
		ss_box = domain;
		ss_box -= ss_box.getP1();

incardon's avatar
incardon committed
258 259
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
Pietro Incardona's avatar
Pietro Incardona committed
260
			bbox = convertDecBoxIntoSubDomain(loc_box.get(0));
Pietro Incardona's avatar
Pietro Incardona committed
261

incardon's avatar
incardon committed
262
		// convert into sub-domain
Pietro Incardona's avatar
Pietro Incardona committed
263
		for (size_t s = 0; s < loc_box.size(); s++)
incardon's avatar
incardon committed
264
		{
Pietro Incardona's avatar
Pietro Incardona committed
265
			SpaceBox<dim,T> sub_d = convertDecBoxIntoSubDomain(loc_box.get(s));
266

incardon's avatar
incardon committed
267 268
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
269 270 271 272 273 274

			// 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
275
		}
incardon's avatar
incardon committed
276

277
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);
incardon's avatar
incardon committed
278
		nn_prcs<dim,T>::refine_ss_box(ss_box);
Pietro Incardona's avatar
Pietro Incardona committed
279
		nn_prcs<dim,T>::applyBC(domain,ghost,bc);
280

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

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

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

			++it;
		}
296

incardon's avatar
incardon committed
297 298 299 300 301 302 303 304 305 306
		Initialize_geo_cell_lists();
	}

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

incardon's avatar
incardon committed
314
		// calculate the sub-divisions
315
		size_t div[dim];
316 317
		for (size_t i = 0; i < dim; i++)
			div[i] = (size_t) ((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
318 319

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

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

326 327 328 329 330 331
	/*! \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)
	{
tonynsyde's avatar
tonynsyde committed
332
		float migration = 0;
333 334 335 336 337 338 339 340 341

		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
342
		for (size_t i = 2; i < dim; i++)
343 344 345 346 347 348 349 350 351 352
			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++)
		{
353
			dist.setMigrationCost(i, norm * migration * dist.getSubSubDomainComputationCost(i));
354 355 356

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

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

		// 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
381
			SpaceBox<dim, T> tmp;
incardon's avatar
incardon committed
382 383

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

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

			// add the iterator
			++gk_it;
		}
	}

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

	/*! 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()
	{
		// 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);
	}

incardon's avatar
incardon committed
503 504
public:

505 506 507 508
	static constexpr int dims = dim;

	typedef T stype;

incardon's avatar
incardon committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522
	//! 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
523 524
	/*! \brief Cartesian decomposition constructor
	 *
525
	 * \param v_cl Virtual cluster, used internally to handle or pipeline communication
incardon's avatar
incardon committed
526 527
	 *
	 */
528
	CartDecomposition(Vcluster & v_cl) :
529
			nn_prcs<dim, T>(v_cl), v_cl(v_cl), dist(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
530 531 532 533
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
534

535 536 537 538 539
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
540
	CartDecomposition(const CartDecomposition<dim,T,Memory> & cart)
541
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
542 543 544 545 546 547 548 549 550
	{
		this->operator=(cart);
	}

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
551
	CartDecomposition(CartDecomposition<dim,T,Memory> && cart)
552
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
553 554 555 556
	{
		this->operator=(cart);
	}

incardon's avatar
incardon committed
557 558
	//! Cartesian decomposition destructor
	~CartDecomposition()
559 560
	{
	}
incardon's avatar
incardon committed
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575
	/*! \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
		 *
		 */
576
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
		{
			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
		 *
		 */
596
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
		{
			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
		 *
		 */
616
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
617 618 619 620 621
		{
			return p.lc_proc;
		}
	};

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
	/*! \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;
		}
	};

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
	/*! \brief Apply boundary condition to the point
	 *
	 * \param p Point to apply the boundary condition
	 *
	 */
	void applyPointBC(float (& pt)[dim]) const
	{
		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt[i] = openfpm::math::periodic_l(pt[i],domain.getHigh(i),domain.getLow(i));
		}
	}

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

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

incardon's avatar
incardon committed
684 685 686 687 688 689 690
	/*! \brief It create another object that contain the same decomposition information but with different ghost boxes
	 *
	 * \param g ghost
	 *
	 * \return a duplicated decomposition with different ghost boxes
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
691
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
692
	{
Pietro Incardona's avatar
Pietro Incardona committed
693
		CartDecomposition<dim,T,Memory> cart(v_cl);
incardon's avatar
incardon committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707

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

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

708 709
		cart.dist = dist;

710 711 712
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

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

716 717
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
incardon's avatar
incardon committed
718 719 720 721 722

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
723 724 725 726
	 *
	 * \return a duplicated decomposition
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
727
	CartDecomposition<dim,T,Memory> duplicate() const
728
	{
Pietro Incardona's avatar
Pietro Incardona committed
729
		CartDecomposition<dim,T,Memory> cart(v_cl);
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

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

		cart.ghost = ghost;

incardon's avatar
incardon committed
745 746 747
		cart.bbox = bbox;
		cart.ss_box = ss_box;

748 749 750
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = this->bc[i];

751 752 753 754 755 756 757 758
		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
759
	CartDecomposition<dim,T,Memory> & operator=(const CartDecomposition & cart)
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
	{
		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);

		ghost = cart.ghost;

incardon's avatar
incardon committed
775 776 777
		bbox = cart.bbox;
		ss_box = cart.ss_box;

778 779 780
		for (size_t i = 0 ; i < dim ; i++)
			bc[i] = cart.bc[i];

781 782 783 784 785 786 787 788
		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
789
	CartDecomposition<dim,T,Memory> & operator=(CartDecomposition && cart)
790
	{
Pietro Incardona's avatar
Pietro Incardona committed
791 792 793
		static_cast<ie_loc_ghost<dim,T>*>(this)->operator=(static_cast<ie_loc_ghost<dim,T>>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->operator=(static_cast<nn_prcs<dim,T>>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->operator=(static_cast<ie_ghost<dim,T>>(cart));
794 795 796 797 798 799 800 801 802 803 804

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

		ghost = cart.ghost;

805 806
		bbox = cart.bbox;
		ss_box = cart.ss_box;
incardon's avatar
incardon committed
807

808
		for (size_t i = 0 ; i < dim ; i++)
809 810 811
			bc[i] = cart.bc[i];

		return *this;
812

813 814 815
		return *this;
	}

816 817 818 819 820 821 822 823 824 825 826
	/*! \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
827
		return openfpm::math::round_big_2(pow(n_sub, 1.0 / dim));
828 829
	}

830
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
831 832 833 834
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
835
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
836
	{
Pietro Incardona's avatar
Pietro Incardona committed
837
		return fine_s.get(cd.template getCell<ofb>(p));
incardon's avatar
incardon committed
838 839
	}

840
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
841
	 *
842
	 * \return processorID
incardon's avatar
incardon committed
843 844
	 *
	 */
845
	size_t inline processorID(const Point<dim,T> &p) const
incardon's avatar
incardon committed
846
	{
incardon's avatar
incardon committed
847
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
848 849
	}

850
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
851 852 853 854
	 *
	 * \return processorID
	 *
	 */
855
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
856
	{
incardon's avatar
incardon committed
857
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
858
	}
incardon's avatar
incardon committed
859

860
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
861
	 *
862 863 864
	 * Boundary conditions are considered
	 *
	 * \return processorID
incardon's avatar
incardon committed
865 866
	 *
	 */
867
	template<typename Mem> size_t inline processorIDBC(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
868
	{
869 870 871 872
		Point<dim,T> pt = p;
		applyPointBC(pt);

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

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

887 888 889 890 891 892 893 894 895 896
		return fine_s.get(cd.getCell(p));
	}

	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary consition are considered
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
897
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
incardon's avatar
incardon committed
898
	{
899 900 901
		Point<dim,T> pt = p;
		applyPointBC(pt);

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

905 906 907 908 909 910 911 912 913 914
	/*! \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;
	}

915 916 917 918 919 920 921
	/*! \brief Get the periodicity on i dimension
	 *
	 * \param i dimension
	 *
	 * \return the periodicity in direction i
	 *
	 */
922
	inline size_t periodicity(size_t i)
923 924 925 926
	{
		return bc[i];
	}

927 928 929 930 931 932 933 934 935 936 937
	/*! \brief Get the periodicity
	 *
	 *
	 * \return the periodicity
	 *
	 */
	inline const size_t (& periodicity() const) [dim]
	{
		return bc;
	}

incardon's avatar
incardon committed
938 939
	/*! \brief Set the parameter of the decomposition
	 *
940
	 * \param div_ storing into how many sub-sub-domains to decompose on each dimension
941
	 * \param domain_ domain to decompose
942 943
	 * \param bc_ boundary conditions
	 * \param ghost Ghost size
incardon's avatar
incardon committed
944 945
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
946
	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
947
	{
Pietro Incardona's avatar
Pietro Incardona committed
948 949 950 951
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

incardon's avatar
incardon committed
952 953
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
954

955
		// Set the decomposition parameters
incardon's avatar
incardon committed
956
		gr.setDimensions(div_);
incardon's avatar
incardon committed
957
		domain = domain_;
958
		cd.setDimensions(domain, div_, 0);
incardon's avatar
incardon committed
959

960
		// init distribution
961
		dist.createCartGraph(gr, domain);
962 963 964

	}

965 966 967 968 969 970 971 972 973 974
	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();
	}

975 976 977 978 979
	/*! \brief Start decomposition
	 *
	 */
	void decompose()
	{
980 981
		reset();

982 983 984
		computeCommunicationAndMigrationCosts(1);

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

986
		createSubdomains(v_cl,bc);
987 988

		calculateGhostBoxes();
incardon's avatar
incardon committed
989 990
	}

991 992 993
	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
	 *
	 */
994
	void rebalance(size_t ts)
995
	{
996 997 998
		reset();

		computeCommunicationAndMigrationCosts(ts);
999 1000

		dist.refine();
1001 1002 1003 1004

		createSubdomains(v_cl,bc);

		calculateGhostBoxes();
1005 1006 1007 1008
	}

	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
	 *
tonynsyde's avatar
tonynsyde committed
1009
	 * \return true if the re-balance has been executed, false otherwise
1010
	 */
tonynsyde's avatar
tonynsyde committed
1011
	bool rebalance(DLB & dlb)
1012
	{
tonynsyde's avatar
tonynsyde committed
1013 1014 1015 1016 1017 1018 1019
		// 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)
			{
1020
				std::cout << std::setprecision(3) << unbalance << "\n";
tonynsyde's avatar
tonynsyde committed
1021
			}
Pietro Incardona's avatar
Pietro Incardona committed
1022 1023 1024 1025

//			write(v_cl.getProcessUnitID() + "_"+ std::to_string(n_step) + "_AAAAAA");

//			n_step++;
tonynsyde's avatar
tonynsyde committed
1026 1027
		}

1028 1029
		if (dlb.rebalanceNeeded())
		{
1030 1031
			rebalance(dlb.getNTimeStepSinceDLB());

tonynsyde's avatar
tonynsyde committed
1032
			return true;
1033
		}
tonynsyde's avatar
tonynsyde committed
1034 1035 1036
		return false;
	}

Pietro Incardona's avatar
Pietro Incardona committed
1037 1038
//	size_t n_step = 0;

tonynsyde's avatar
tonynsyde committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
	/*! \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();
1055 1056 1057 1058 1059 1060 1061 1062
	}

	/*! \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
	 *
	 */
tonynsyde's avatar
tonynsyde committed
1063
	inline void getSubSubDomainPosition(size_t id, T (&pos)[dim])
1064
	{
1065
		dist.getSubSubDomainPosition(id, pos);
1066 1067
	}

1068
	//TODO fix in Parmetis distribution to get only the right amount of vertices
tonynsyde's avatar
tonynsyde committed
1069 1070
	/*! \brief Get the number of sub-sub-domains in this sub-graph
	 *
1071
	 * \return number of sub-sub-domains in this sub-graph
tonynsyde's avatar
tonynsyde committed
1072 1073 1074 1075 1076 1077
	 */
	size_t getNSubSubDomains()
	{
		return dist.getNSubSubDomains();
	}

1078 1079 1080 1081 1082 1083 1084
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline void setSubSubDomainComputationCost(size_t id, size_t weight)
	{
1085
		dist.setComputationCost(id, weight);
1086 1087
	}

tonynsyde's avatar
tonynsyde committed
1088 1089 1090 1091 1092 1093 1094
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline size_t getSubSubDomainComputationCost(size_t id)
	{
1095
		return dist.getComputationCost(id);
tonynsyde's avatar
tonynsyde committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	}

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

1107
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
1108 1109 1110 1111
	 *
	 * \return the number of sub-domains
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1112
	size_t getNSubDomain()
incardon's avatar
incardon committed
1113 1114 1115 1116
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
1117
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
1118
	 *
incardon's avatar
incardon committed
1119 1120
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
1121 1122
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1123
	SpaceBox<dim, T> getSubDomain(size_t lc)
incardon's avatar
incardon committed
1124 1125
	{
		// Create a space box
1126
		SpaceBox<dim, T> sp;
incardon's avatar
incardon committed
1127 1128 1129

		// fill the space box

1130
		for (size_t k = 0; k < dim; k++)
incardon's avatar
incardon committed
1131 1132
		{
			// create the SpaceBox Low and High
1133 1134
			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
1135 1136 1137 1138 1139
		}

		return sp;
	}

incardon's avatar
incardon committed
1140 1141 1142 1143 1144 1145
	/*! \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
	 *
	 */
1146
	SpaceBox<dim, T> getSubDomainWithGhost(size_t lc)
incardon's avatar
incardon committed
1147 1148
	{
		// Create a space box
1149
		SpaceBox<dim, T> sp = sub_domains.get(lc);
incardon's avatar
incardon committed
1150 1151 1152 1153 1154 1155 1156

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

		return sp;
	}

1157
	/*! \brief Return the box of the physical domain
incardon's avatar
incardon committed
1158
	 *