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

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
12
#include <cmath>
13 14
#include "VCluster.hpp"
#include "Graph/CartesianGraphFactory.hpp"
incardon's avatar
incardon committed
15
#include "Decomposition.hpp"
incardon's avatar
incardon committed
16
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
17 18 19 20 21
#include <vector>
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "dec_optimizer.hpp"
#include "Space/Shape/Box.hpp"
incardon's avatar
incardon committed
22
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
23
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
24 25
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
26
#include "Space/Ghost.hpp"
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> 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;

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

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

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

Pietro Incardona's avatar
Pietro Incardona committed
148
	// ghost info
149 150
	Ghost<dim,T> ghost;

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

154 155 156 157 158 159
	// Heap memory receiver
	HeapMemory hp_recv;

	// Receive counter
	size_t recv_cnt;

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



public:

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

		int p_id = v_cl.getProcessUnitID();

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

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

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

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

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

incardon's avatar
incardon committed
246
		// optimize the decomposition
247
		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
248

Pietro Incardona's avatar
Pietro Incardona committed
249 250 251 252
		// reset ss_box
		ss_box = domain;
		ss_box -= ss_box.getP1();

incardon's avatar
incardon committed
253 254
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
Pietro Incardona's avatar
Pietro Incardona committed
255
			bbox = convertDecBoxIntoSubDomain(loc_box.get(0));
Pietro Incardona's avatar
Pietro Incardona committed
256

incardon's avatar
incardon committed
257
		// convert into sub-domain
Pietro Incardona's avatar
Pietro Incardona committed
258
		for (size_t s = 0; s < loc_box.size(); s++)
incardon's avatar
incardon committed
259
		{
Pietro Incardona's avatar
Pietro Incardona committed
260
			SpaceBox<dim,T> sub_d = convertDecBoxIntoSubDomain(loc_box.get(s));
261

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

			// 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
270
		}
incardon's avatar
incardon committed
271

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

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

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

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

			++it;
		}
291

incardon's avatar
incardon committed
292 293 294 295 296 297 298 299 300 301
		Initialize_geo_cell_lists();
	}

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

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

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

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

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

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

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

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

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

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

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

			// add the iterator
			++gk_it;
		}
	}

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519

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

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


 \endverbatim

       and also
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)

      +----------------------------------------------------+
      |                 Processor 8                        |
      |                 Subdomain 0                        +-----------------------------------+
      |                                                    |                                   |
      |           +---------------------------------------------+                              |
      |           |         G8_0                           |    |                              |
+-----+---------------+------------------------------------+    |   Processor 9                |
|                 |   |                                    |    |   Subdomain 0                |
|                 |   |                                    |G9_0|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
|                 |   |        Local processor             |    |                              |
|  Processor 5    |   |        Sub+domain 0                |    |                              |
|  Subdomain 0    |   |                                    +-----------------------------------+
|                 |   |                                    |    |                              |
|                 | G |                                    |    |                              |
|                 | 5 |                                    |    |   Processor 9                |
|                 | | |                                    |    |   Subdomain 1                |
|                 | 0 |                                    |G9_1|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
+---------------------+------------------------------------+    |                              |
                  |                                        |    |                              |
                  +----------------------------------------+----+------------------------------+

	 \endverbatim

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

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

	 \endverbatim

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

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

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

		// create the internal structures that store ghost information
		ie_ghost<dim, T>::create_box_nn_processor_ext(v_cl, ghost, sub_domains, box_nn_processor, *this);
		ie_ghost<dim, T>::create_box_nn_processor_int(v_cl, ghost, sub_domains, box_nn_processor, *this);

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

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

incardon's avatar
incardon committed
520 521
public:

522 523 524 525
	static constexpr int dims = dim;

	typedef T stype;

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

552 553 554 555 556
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
557
	CartDecomposition(const 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 563 564 565 566 567
	{
		this->operator=(cart);
	}

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

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

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

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

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 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
	/*! \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
701 702 703 704 705 706 707
	/*! \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
708
	CartDecomposition<dim,T,Memory> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
709
	{
Pietro Incardona's avatar
Pietro Incardona committed
710
		CartDecomposition<dim,T,Memory> cart(v_cl);
incardon's avatar
incardon committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724

		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;

725 726
		cart.dist = dist;

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

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

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

		return cart;
	}

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

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

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

768 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
	CartDecomposition<dim,T,Memory> & operator=(const CartDecomposition & cart)
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
	{
		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
792 793 794
		bbox = cart.bbox;
		ss_box = cart.ss_box;

795 796 797
		for (size_t i = 0 ; i < dim ; i++)
			bc[i] = cart.bc[i];

798 799 800 801 802 803 804 805
		return *this;
	}

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

		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;

822 823
		bbox = cart.bbox;
		ss_box = cart.ss_box;
incardon's avatar
incardon committed
824

825
		for (size_t i = 0 ; i < dim ; i++)
826 827 828
			bc[i] = cart.bc[i];

		return *this;
829

830 831 832
		return *this;
	}

833 834 835 836 837 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
	 *
	 */
	static size_t getDefaultGrid(size_t n_sub)
	{
		// Calculate the number of sub-sub-domain on
		// each dimension
844
		return openfpm::math::round_big_2(pow(n_sub, 1.0 / dim));
845 846
	}

847
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
848 849 850 851
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
852
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
853
	{
Pietro Incardona's avatar
Pietro Incardona committed
854
		return fine_s.get(cd.template getCell<ofb>(p));
incardon's avatar
incardon committed
855 856
	}

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

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

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

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

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

904 905 906 907 908 909 910 911 912 913
		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
914
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
incardon's avatar
incardon committed
915
	{
916 917 918
		Point<dim,T> pt = p;
		applyPointBC(pt);

incardon's avatar
incardon committed
919
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
920 921
	}

922 923 924 925 926 927 928 929 930 931
	/*! \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;
	}

932 933 934 935 936 937 938
	/*! \brief Get the periodicity on i dimension
	 *
	 * \param i dimension
	 *
	 * \return the periodicity in direction i
	 *
	 */
939
	inline size_t periodicity(size_t i)
940 941 942 943
	{
		return bc[i];
	}

944 945 946 947 948 949 950 951 952 953 954
	/*! \brief Get the periodicity
	 *
	 *
	 * \return the periodicity
	 *
	 */
	inline const size_t (& periodicity() const) [dim]
	{
		return bc;
	}

incardon's avatar
incardon committed
955 956
	/*! \brief Set the parameter of the decomposition
	 *
957
	 * \param div_ storing into how many sub-sub-domains to decompose on each dimension
958
	 * \param domain_ domain to decompose
959 960
	 * \param bc_ boundary conditions
	 * \param ghost Ghost size
incardon's avatar
incardon committed
961 962
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
963
	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
964
	{
Pietro Incardona's avatar
Pietro Incardona committed
965 966 967 968
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

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

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

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

	}

982 983 984 985 986 987 988 989 990 991
	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();
	}

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

999 1000 1001
		computeCommunicationAndMigrationCosts(1);

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

1003
		createSubdomains(v_cl,bc);
1004 1005

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

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

		computeCommunicationAndMigrationCosts(ts);
1016 1017

		dist.refine();
1018 1019 1020 1021

		createSubdomains(v_cl,bc);

		calculateGhostBoxes();
1022 1023 1024 1025
	}

	/*! \brief Refine the decomposition, available only for ParMetis distribution, for Metis it is a null call
	 *
tonynsyde's avatar
tonynsyde committed
1026
	 * \return true if the re-balance has been executed, false otherwise
1027
	 */
tonynsyde's avatar
tonynsyde committed
1028
	bool rebalance(DLB & dlb)
1029
	{
tonynsyde's avatar
tonynsyde committed
1030 1031 1032 1033 1034 1035 1036
		// 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)
			{
1037
				std::cout << std::setprecision(3) << unbalance << "\n";
tonynsyde's avatar
tonynsyde committed
1038
			}
Pietro Incardona's avatar
Pietro Incardona committed
1039 1040 1041 1042

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

//			n_step++;
tonynsyde's avatar
tonynsyde committed
1043 1044
		}

1045 1046
		if (dlb.rebalanceNeeded())
		{
1047 1048
			rebalance(dlb.getNTimeStepSinceDLB());

tonynsyde's avatar
tonynsyde committed
1049
			return true;
1050
		}
tonynsyde's avatar
tonynsyde committed
1051 1052 1053
		return false;
	}

Pietro Incardona's avatar
Pietro Incardona committed
1054 1055
//	size_t n_step = 0;

tonynsyde's avatar
tonynsyde committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
	/*! \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();
1072 1073 1074 1075 1076 1077 1078 1079
	}

	/*! \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
1080
	inline void getSubSubDomainPosition(size_t id, T (&pos)[dim])
1081
	{
1082
		dist.getSubSubDomainPosition(id, pos);
1083 1084
	}

1085
	//TODO fix in Parmetis distribution to get only the right amount of vertices
tonynsyde's avatar
tonynsyde committed
1086 1087
	/*! \brief Get the number of sub-sub-domains in this sub-graph
	 *
1088
	 * \return number of sub-sub-domains in this sub-graph
tonynsyde's avatar
tonynsyde committed
1089 1090 1091 1092 1093 1094
	 */
	size_t getNSubSubDomains()
	{
		return dist.getNSubSubDomains();
	}

1095 1096 1097 1098 1099 1100 1101
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline void setSubSubDomainComputationCost(size_t id, size_t weight)
	{
1102
		dist.setComputationCost(id, weight);
1103 1104
	}

tonynsyde's avatar
tonynsyde committed
1105 1106 1107 1108 1109 1110 1111
	/*! \brief function that set the weight of the vertex
	 *
	 * \param id vertex id
	 *
	 */
	inline size_t getSubSubDomainComputationCost(size_t id)
	{
1112
		return dist.getComputationCost(id);
tonynsyde's avatar
tonynsyde committed
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
	}

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

1124
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
1125 1126 1127 1128
	 *
	 * \return the number of sub-domains
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1129
	size_t getNSubDomain()
incardon's avatar
incardon committed
1130 1131 1132 1133
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
1134
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
1135
	 *
incardon's avatar
incardon committed
1136 1137
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
1138 1139
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
1140
	SpaceBox<dim, T> getSubDomain(size_t lc)
incardon's avatar
incardon committed
1141 1142
	{
		// Create a space box
1143
		SpaceBox<dim, T> sp;
incardon's avatar
incardon committed
1144 1145 1146

		// fill the space box

1147
		for (size_t k = 0; k < dim; k++)
incardon's avatar
incardon committed
1148 1149
		{
			// create the SpaceBox Low and High
1150 1151
			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
1152 1153 1154 1155 1156
		}

		return sp;
	}

incardon's avatar
incardon committed
1157 1158 1159 1160 1161 1162
	/*! \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
	 *
	 */
1163
	SpaceBox<dim, T> getSubDomainWithGhost(size_t lc)
incardon's avatar
incardon committed
1164 1165
	{
		// Create a space box
1166
		SpaceBox<dim, T> sp = sub_domains.get(lc);
incardon's avatar
incardon committed
1167 1168 1169 1170 1171 1172 1173

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

		return sp;
	}

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