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"
tonynsyde's avatar
tonynsyde committed
15
#include "Graph/DistCartesianGraphFactory.hpp"
incardon's avatar
incardon committed
16
#include "Decomposition.hpp"
incardon's avatar
incardon committed
17
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
18 19 20 21 22
#include <vector>
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "dec_optimizer.hpp"
#include "Space/Shape/Box.hpp"
incardon's avatar
incardon committed
23
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
24
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
25 26
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
27
#include "Space/Ghost.hpp"
incardon's avatar
incardon committed
28 29
#include "common.hpp"
#include "ie_loc_ghost.hpp"
30 31
#include "ie_ghost.hpp"
#include "nn_processor.hpp"
32
#include "GraphMLWriter/GraphMLWriter.hpp"
33 34 35 36
#include "Distribution/ParMetisDistribution.hpp"
#include "Distribution/DistParMetisDistribution.hpp"
#include "Distribution/MetisDistribution.hpp"
#include "DLB/DLB.hpp"
37
#include "util/se_util.hpp"
38
#include "util/mathutil.hpp"
Pietro Incardona's avatar
Pietro Incardona committed
39
#include "CartDecomposition_ext.hpp"
incardon's avatar
incardon committed
40

41 42
#define CARTDEC_ERROR 2000lu

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

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

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

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

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

Pietro Incardona's avatar
Pietro Incardona committed
95 96 97 98 99 100 101
	//! 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
102

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

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

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

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

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

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

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

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

133
	//! Create distribution
134 135
	Distribution dist;

incardon's avatar
incardon committed
136 137 138 139
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

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

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

Pietro Incardona's avatar
Pietro Incardona committed
144
	// ghost info
145 146
	Ghost<dim,T> ghost;

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

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

	// Receive counter
	size_t recv_cnt;

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



public:

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

		int p_id = v_cl.getProcessUnitID();

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

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

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

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

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

incardon's avatar
incardon committed
200
		// optimize the decomposition
201
		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
202

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

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

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

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

Pietro Incardona's avatar
Pietro Incardona committed
224 225
				if (sub_dc.getLow(i) == 0)
					sub_d.setLow(i,domain.getLow(i));
226 227
			}

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

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

Pietro Incardona's avatar
Pietro Incardona committed
236 237 238 239
/*		if (loc_box.size())
		bbox.zero();
		ss_box = domain;*/

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

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

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

Pietro Incardona's avatar
Pietro Incardona committed
261 262
				if (sub_dc.getLow(i) == 0)
					sub_d.setLow(i,domain.getLow(i));
263 264
			}

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

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

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

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

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

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

			++it;
		}
294

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

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

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

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

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

324 325 326 327 328 329
	/*! \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
330
		float migration = 0;
331 332 333 334 335 336 337 338 339

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

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

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

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

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

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

			// add the iterator
			++gk_it;
		}
	}

public:

398 399 400 401
	static constexpr int dims = dim;

	typedef T stype;

incardon's avatar
incardon committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415
	//! 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
416 417
	/*! \brief Cartesian decomposition constructor
	 *
418
	 * \param v_cl Virtual cluster, used internally to handle or pipeline communication
incardon's avatar
incardon committed
419 420
	 *
	 */
421
	CartDecomposition(Vcluster & v_cl) :
422
			nn_prcs<dim, T>(v_cl), v_cl(v_cl), dist(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
423 424 425 426
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
427

428 429 430 431 432
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
433
	CartDecomposition(const CartDecomposition<dim,T,Memory> & cart)
434
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
435 436 437 438 439 440 441 442 443
	{
		this->operator=(cart);
	}

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
444
	CartDecomposition(CartDecomposition<dim,T,Memory> && cart)
445
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
446 447 448 449
	{
		this->operator=(cart);
	}

incardon's avatar
incardon committed
450 451
	//! Cartesian decomposition destructor
	~CartDecomposition()
452 453
	{
	}
incardon's avatar
incardon committed
454

455 456 457 458 459 460 461 462 463 464 465 466 467 468
	/*! \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
		 *
		 */
469
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
		{
			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
		 *
		 */
489
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
		{
			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
		 *
		 */
509
		inline static size_t id(p_box<dim, T> & p, size_t b_id)
510 511 512 513 514
		{
			return p.lc_proc;
		}
	};

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
	/*! \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;
		}
	};

535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
	/*! \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
577
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
578 579 580 581 582
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
583 584 585
	 *
	 \verbatim

incardon's avatar
incardon committed
586 587 588
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
incardon's avatar
incardon committed
589
|                 Sub+domain 0                       +-----------------------------------+
incardon's avatar
incardon committed
590 591 592 593 594 595
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
incardon's avatar
incardon committed
596 597 598 599 600
 |              |   |                           |B9_0|                                   |
 |              | B |    Local processor        |    |                                   |
 | Processor 5  | 5 |    Subdomain 0            |    |                                   |
 | Subdomain 0  | _ |                           +----------------------------------------+
 |              | 0 |                           |    |                                   |
incardon's avatar
incardon committed
601 602 603 604 605 606 607 608 609 610
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

incardon's avatar
incardon committed
611

612 613
 \endverbatim

incardon's avatar
incardon committed
614
       and also
incardon's avatar
incardon committed
615
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
616

incardon's avatar
incardon committed
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
      +----------------------------------------------------+
      |                 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|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
+---------------------+------------------------------------+    |                              |
                  |                                        |    |                              |
                  +----------------------------------------+----+------------------------------+
641 642

	 \endverbatim
643

incardon's avatar
incardon committed
644 645 646 647 648
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
649 650
	 *
	 \verbatim
tonynsyde's avatar
tonynsyde committed
651

652 653 654 655 656 657
	 	 	 	 	 ^ p2[1]
	 	 	 	 	 |
	 	 	 	 	 |
	 	 	 	+----+----+
	 	 	 	|         |
	 	 	 	|         |
658
	 p1[0]<-----+         +----> p2[0]
659 660 661 662 663
	 	 	 	|         |
	 	 	 	|         |
	 	 	 	+----+----+
	 	 	 	 	 |
	 	 	 	 	 v  p1[1]
incardon's avatar
incardon committed
664

665
	 \endverbatim
666

incardon's avatar
incardon committed
667 668 669
	 *
	 *
	 */
incardon's avatar
incardon committed
670
	void calculateGhostBoxes()
incardon's avatar
incardon committed
671 672 673 674 675
	{
#ifdef DEBUG
		// the ghost margins are assumed to be smaller
		// than one sub-domain

676
		for (size_t i = 0; i < dim; i++)
incardon's avatar
incardon committed
677
		{
incardon's avatar
incardon committed
678
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
incardon's avatar
incardon committed
679
			{
680
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
681 682 683 684 685 686
			}
		}
#endif

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

incardon's avatar
incardon committed
687
		// create the internal structures that store ghost information
688 689
		ie_ghost<dim, T>::create_box_nn_processor_ext(v_cl, ghost, sub_domains, box_nn_processor, *this);
		ie_ghost<dim, T>::create_box_nn_processor_int(v_cl, ghost, sub_domains, box_nn_processor, *this);
incardon's avatar
incardon committed
690

691
		ie_loc_ghost<dim,T>::create(sub_domains,domain,ghost,bc);
incardon's avatar
incardon committed
692 693

		// get the smallest sub-domain dimension on each direction
694
		for (size_t i = 0; i < dim; i++)
incardon's avatar
incardon committed
695
		{
incardon's avatar
incardon committed
696
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
incardon's avatar
incardon committed
697
			{
698
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
699 700
			}
		}
incardon's avatar
incardon committed
701 702
	}

incardon's avatar
incardon committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
710
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
711
	{
Pietro Incardona's avatar
Pietro Incardona committed
712
		CartDecomposition<dim,T,Memory> cart(v_cl);
incardon's avatar
incardon committed
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);
incardon's avatar
incardon committed
737

738 739
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
incardon's avatar
incardon committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
749
	CartDecomposition<dim,T,Memory> duplicate() const
750
	{
Pietro Incardona's avatar
Pietro Incardona committed
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;

incardon's avatar
incardon committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
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;

incardon's avatar
incardon committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
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;

incardon's avatar
incardon committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
864
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
865
	{
Pietro Incardona's avatar
Pietro Incardona committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
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
	{
Pietro Incardona's avatar
Pietro Incardona committed
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
	 *
tonynsyde's avatar
tonynsyde committed
1025
	 * \return true if the re-balance has been executed, false otherwise
1026
	 */
tonynsyde's avatar
tonynsyde committed
1027
	bool rebalance(DLB & dlb)
1028
	{
tonynsyde's avatar
tonynsyde committed
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";
tonynsyde's avatar
tonynsyde committed
1037 1038 1039
			}
		}

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

tonynsyde's avatar
tonynsyde committed
1044
			return true;
1045
		}
tonynsyde's avatar
tonynsyde committed
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
	 *
	 */
tonynsyde's avatar
tonynsyde committed
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