CartDecomposition.hpp 40.2 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
 * ### Create a Cartesian decomposition object on a Box space, distribute, calculate internal and external ghost boxes
Pietro Incardona's avatar
Pietro Incardona committed
78
 *
79 80
 * \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
Pietro Incardona's avatar
Pietro Incardona committed
105 106 107 108 109 110
	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
111 112

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

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

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

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

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

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

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

138
	//! Create distribution
139 140
	Distribution dist;

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

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

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

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

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

Pietro Incardona's avatar
Pietro Incardona committed
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 197
	/*! \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
198 199 200 201 202 203
protected:



public:

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

		int p_id = v_cl.getProcessUnitID();

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

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

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

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

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

243 244 245 246 247 248 249 250 251 252
		// 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
253
		// optimize the decomposition
254
		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
255

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

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

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

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

			// 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
277
		}
incardon's avatar
incardon committed
278

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

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

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

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

			++it;
		}
298

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

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

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

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

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

328 329 330 331 332 333
	/*! \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
334
		float migration = 0;
335 336

		SpaceBox<dim, T> cellBox = cd.getCellBox();
incardon's avatar
incardon committed
337 338
		float b_s = static_cast<float>(cellBox.getHigh(0));
		float gh_s = static_cast<float>(ghost.getHigh(0));
339 340 341 342 343

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

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

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

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

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

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

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

			// add the iterator
			++gk_it;
		}
	}

400 401 402 403 404 405 406 407 408 409

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

Pietro Incardona's avatar
Pietro Incardona committed
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
	+----------------------------------------------------+
	|                                                    |
	|                 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                |
	 |              |   |                           |    |                                   |
	 |              |   |                           |    |                                   |
	 |              |   |                           |    |                                   |
	 +--------------+---+---------------------------+----+                                   |
														 |                                   |
														 +-----------------------------------+
434 435 436 437 438 439 440


 \endverbatim

       and also
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)

Pietro Incardona's avatar
Pietro Incardona committed
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
\verbatim

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

	 \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
507 508
public:

Pietro Incardona's avatar
Pietro Incardona committed
509
	//! Space dimensions
510 511
	static constexpr int dims = dim;

Pietro Incardona's avatar
Pietro Incardona committed
512
	//! Space type
513 514
	typedef T stype;

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

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

	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
557
	CartDecomposition(CartDecomposition<dim,T,Memory> && cart)
558
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),dist(v_cl),ref_cnt(0)
559 560 561 562
	{
		this->operator=(cart);
	}

incardon's avatar
incardon committed
563 564
	//! Cartesian decomposition destructor
	~CartDecomposition()
565 566
	{
	}
incardon's avatar
incardon committed
567

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

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
	/*! \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;
		}
	};

648 649
	/*! \brief Apply boundary condition to the point
	 *
Pietro Incardona's avatar
Pietro Incardona committed
650 651 652 653 654
	 * If the particle go out to the right, bring back the particle on the left
	 * in case of periodic, nothing in case of non periodic
	 *
	 * \param pt Point to apply the boundary condition. (it's coordinated are changed according the
	 *        the explanation before)
655 656 657 658 659 660 661 662 663 664 665 666 667
	 *
	 */
	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
	 *
Pietro Incardona's avatar
Pietro Incardona committed
668 669 670 671 672
	 * If the particle go out to the right, bring back the particle on the left
	 * in case of periodic, nothing in case of non periodic
	 *
	 * \param pt Point to apply the boundary conditions.(it's coordinated are changed according the
	 *        the explanation before)
673 674 675 676 677 678 679 680 681 682 683 684 685
	 *
	 */
	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
	 *
Pietro Incardona's avatar
Pietro Incardona committed
686 687 688 689 690
	 * If the particle go out to the right, bring back the particle on the left
	 * in case of periodic, nothing in case of non periodic
	 *
	 * \param pt encapsulated point object (it's coordinated are changed according the
	 *        the explanation before)
691 692 693 694 695 696 697 698 699 700 701
	 *
	 */
	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
702 703 704 705 706 707 708
	/*! \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
709
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
710
	{
Pietro Incardona's avatar
Pietro Incardona committed
711
		CartDecomposition<dim,T,Memory> cart(v_cl);
incardon's avatar
incardon committed
712 713 714 715 716 717 718 719 720 721 722 723 724 725

		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;

726 727
		cart.dist = dist;

728 729 730
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

731 732
		(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
733

734 735
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
incardon's avatar
incardon committed
736 737 738 739 740

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
741
	 *
Pietro Incardona's avatar
Pietro Incardona committed
742
	 * \return a duplicated CartDecomposition object
743 744
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
745
	CartDecomposition<dim,T,Memory> duplicate() const
746
	{
Pietro Incardona's avatar
Pietro Incardona committed
747
		CartDecomposition<dim,T,Memory> cart(v_cl);
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762

		(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
763 764 765
		cart.bbox = bbox;
		cart.ss_box = ss_box;

766 767 768
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = this->bc[i];

769 770 771 772 773 774 775
		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
Pietro Incardona's avatar
Pietro Incardona committed
776 777
	 * \return itself
	 *
778
	 */
Pietro Incardona's avatar
Pietro Incardona committed
779
	CartDecomposition<dim,T,Memory> & operator=(const CartDecomposition & cart)
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
	{
		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
795 796 797
		bbox = cart.bbox;
		ss_box = cart.ss_box;

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

801 802 803 804 805 806 807
		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
Pietro Incardona's avatar
Pietro Incardona committed
808 809
	 * \return itself
	 *
810
	 */
Pietro Incardona's avatar
Pietro Incardona committed
811
	CartDecomposition<dim,T,Memory> & operator=(CartDecomposition && cart)
812
	{
Pietro Incardona's avatar
Pietro Incardona committed
813 814 815
		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));
816 817 818 819 820 821 822 823 824 825 826

		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;

827 828
		bbox = cart.bbox;
		ss_box = cart.ss_box;
incardon's avatar
incardon committed
829

830
		for (size_t i = 0 ; i < dim ; i++)
831 832 833
			bc[i] = cart.bc[i];

		return *this;
834

835 836 837
		return *this;
	}

838 839 840 841 842 843
	/*! \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
	 *
Pietro Incardona's avatar
Pietro Incardona committed
844 845 846 847
	 * \param n_sub number of subdomains per processors
	 *
	 * \return grid dimension (it is one number because on the other dimensions is the same)
	 *
848 849 850 851 852
	 */
	static size_t getDefaultGrid(size_t n_sub)
	{
		// Calculate the number of sub-sub-domain on
		// each dimension
853
		return openfpm::math::round_big_2(pow(n_sub, 1.0 / dim));
854 855
	}

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

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

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

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

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

909
	/*! \brief Given a point return in which processor the particle should go
910 911
	 *
	 * Boundary conditions are considered
incardon's avatar
incardon committed
912
	 *
Pietro Incardona's avatar
Pietro Incardona committed
913 914
	 * \param p point
	 *
incardon's avatar
incardon committed
915 916 917
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
918
	template<typename ofb> size_t inline processorIDBC(const Point<dim,T> &p) const
919 920 921
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);
incardon's avatar
incardon committed
922

923 924 925 926 927 928 929
		return fine_s.get(cd.getCell(p));
	}

	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary consition are considered
	 *
Pietro Incardona's avatar
Pietro Incardona committed
930 931
	 * \param p point position
	 *
932 933 934
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
935
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
incardon's avatar
incardon committed
936
	{
937 938 939
		Point<dim,T> pt = p;
		applyPointBC(pt);

incardon's avatar
incardon committed
940
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
941 942
	}

943 944 945 946 947 948 949 950 951 952
	/*! \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;
	}

953 954 955 956 957 958 959
	/*! \brief Get the periodicity on i dimension
	 *
	 * \param i dimension
	 *
	 * \return the periodicity in direction i
	 *
	 */
960
	inline size_t periodicity(size_t i)
961 962 963 964
	{
		return bc[i];
	}

965 966 967 968 969 970 971 972 973 974 975
	/*! \brief Get the periodicity
	 *
	 *
	 * \return the periodicity
	 *
	 */
	inline const size_t (& periodicity() const) [dim]
	{
		return bc;
	}

incardon's avatar
incardon committed
976 977
	/*! \brief Set the parameter of the decomposition
	 *
978
	 * \param div_ storing into how many sub-sub-domains to decompose on each dimension
979
	 * \param domain_ domain to decompose
Pietro Incardona's avatar
Pietro Incardona committed
980
	 * \param bc boundary conditions
981
	 * \param ghost Ghost size
incardon's avatar
incardon committed
982 983
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
984
	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
985
	{
Pietro Incardona's avatar
Pietro Incardona committed
986 987 988 989
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

incardon's avatar
incardon committed
990 991
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
992

993
		// Set the decomposition parameters
incardon's avatar
incardon committed
994
		gr.setDimensions(div_);
incardon's avatar
incardon committed
995
		domain = domain_;
996
		cd.setDimensions(domain, div_, 0);
incardon's avatar
incardon committed
997

998
		// init distribution
999
		dist.createCartGraph(gr, domain);
1000 1001 1002

	}

Pietro Incardona's avatar
Pietro Incardona committed
1003 1004 1005 1006
	/*! \brief Delete the decomposition and reset the data-structure
	 *
	 *
	 */
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
	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();
	}

1017 1018 1019 1020 1021
	/*! \brief Start decomposition
	 *
	 */
	void decompose()
	{
1022 1023
		reset();

1024 1025 1026
		computeCommunicationAndMigrationCosts(1);

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

1028
		createSubdomains(v_cl,bc);
1029 1030

		calculateGhostBoxes();
incardon's avatar
incardon committed
1031 1032
	}

1033
	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
Pietro Incardona's avatar
Pietro Incardona committed
1034 1035
	 *
	 * \param ts number of time step from the previous load balancing
1036 1037
	 *
	 */
1038
	void rebalance(size_t ts)
1039
	{
1040 1041 1042
		reset();

		computeCommunicationAndMigrationCosts(ts);
1043 1044

		dist.refine();
1045 1046 1047 1048

		createSubdomains(v_cl,bc);

		calculateGhostBoxes();
1049 1050 1051
	}

	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
Pietro Incardona's avatar
Pietro Incardona committed
1052 1053
	 *
	 * \param dlb Dynamic load balancing object
1054
	 *
tonynsyde's avatar
tonynsyde committed
1055
	 * \return true if the re-balance has been executed, false otherwise
1056
	 */
tonynsyde's avatar
tonynsyde committed
1057
	bool rebalance(DLB & dlb)
1058
	{
tonynsyde's avatar
tonynsyde committed
1059 1060 1061 1062 1063 1064 1065
		// 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)
			{
1066
				std::cout << std::setprecision(3) << unbalance << "\n";
tonynsyde's avatar
tonynsyde committed
1067
			}
Pietro Incardona's avatar
Pietro Incardona committed
1068 1069 1070 1071

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

//			n_step++;
tonynsyde's avatar
tonynsyde committed
1072 1073
		}

1074 1075
		if (dlb.rebalanceNeeded())
		{
1076 1077
			rebalance(dlb.getNTimeStepSinceDLB());

tonynsyde's avatar
tonynsyde committed
1078
			return true;
1079
		}
tonynsyde's avatar
tonynsyde committed
1080 1081 1082
		return false;
	}

Pietro Incardona's avatar
Pietro Incardona committed
1083 1084
//	size_t n_step = 0;

tonynsyde's avatar
tonynsyde committed
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
	/*! \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();
1101 1102 1103 1104 1105 1106 1107 1108
	}

	/*! \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
1109
	inline void getSubSubDomainPosition(size_t id, T (&pos)[dim])
1110
	{
1111
		dist.getSubSubDomainPosition(id, pos);
1112 1113
	}

1114
	//TODO fix in Parmetis distribution to get only the right amount of vertices
tonynsyde's avatar
tonynsyde committed
1115 1116
	/*! \brief Get the number of sub-sub-domains in this sub-graph
	 *