CartDecomposition.hpp 34.4 KB
Newer Older
incardon's avatar
incardon committed
1 2 3 4 5 6 7 8 9 10 11
/*
 * CartDecomposition.hpp
 *
 *  Created on: Aug 15, 2014
 *      Author: Pietro Incardona
 */

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
12 13
#include "VCluster.hpp"
#include "Graph/CartesianGraphFactory.hpp"
incardon's avatar
incardon committed
14
#include "Decomposition.hpp"
incardon's avatar
incardon committed
15
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
16 17 18 19 20 21
#include <vector>
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "metis_util.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 "util/se_util.hpp"
32
#include "util/mathutil.hpp"
incardon's avatar
incardon committed
33

34 35
#define CARTDEC_ERROR 2000lu

incardon's avatar
incardon committed
36 37 38 39 40 41 42 43
/**
 * \brief This class decompose a space into subspaces
 *
 * \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
 * \tparam Domain Structure that contain the information of your physical domain
 *
44
 * Given an N-dimensional space, this class decompose the space into a Cartesian grid of small
incardon's avatar
incardon committed
45 46 47 48
 * 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
49 50 51 52
 *
 * Assuming that VCluster.getProcessUnitID(), equivalent to the MPI processor rank, return the processor local
 * processor id, we define
 *
53 54
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
55 56 57 58 59 60 61 62 63 64 65 66
 * * 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
67
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
68 69
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
70
 *
71 72 73
 * ### 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
74 75
 */

76
template<unsigned int dim, typename T, typename Memory=HeapMemory, template<unsigned int, typename> class Domain=Box>
incardon's avatar
incardon committed
77
class CartDecomposition : public ie_loc_ghost<dim,T>, public nn_prcs<dim,T> , public ie_ghost<dim,T>
incardon's avatar
incardon committed
78
{
incardon's avatar
incardon committed
79

incardon's avatar
incardon committed
80
public:
incardon's avatar
incardon committed
81

incardon's avatar
incardon committed
82 83 84 85 86 87 88 89
	//! Type of the domain we are going to decompose
	typedef T domain_type;

	//! It simplify to access the SpaceBox element
	typedef SpaceBox<dim,T> Box;

private:

incardon's avatar
incardon committed
90
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
91
	//! acc_key is size_t
92
	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
93 94

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

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

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

incardon's avatar
incardon committed
104 105
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
106

incardon's avatar
incardon committed
107 108 109
	//! Structure that decompose your structure into cell without creating them
	//! useful to convert positions to CellId or sub-domain id in this case
	CellDecomposer_sm<dim,T> cd;
incardon's avatar
incardon committed
110 111 112 113 114 115 116 117 118 119

	//! rectangular domain to decompose
	Domain<dim,T> domain;

	//! Box Spacing
	T spacing[dim];

	//! Runtime virtual cluster machine
	Vcluster & v_cl;

incardon's avatar
incardon committed
120 121 122 123
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

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

125 126 127 128 129 130 131 132 133
	// Heap memory receiver
	HeapMemory hp_recv;

	// vector v_proc
	openfpm::vector<size_t> v_proc;

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

Pietro Incardona's avatar
Pietro Incardona committed
134
	// ghost info
135 136
	Ghost<dim,T> ghost;

Pietro Incardona's avatar
Pietro Incardona committed
137 138 139
	// Boundary condition info
	size_t bc[dim];

140
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
141
	 *
142
     * \param v_cl Virtual cluster, used internally for communications
143
     *
incardon's avatar
incardon committed
144
	 */
Pietro Incardona's avatar
Pietro Incardona committed
145
	void CreateDecomposition(Vcluster & v_cl, const size_t (& bc)[dim])
incardon's avatar
incardon committed
146
	{
147 148 149 150 151 152 153
#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
incardon's avatar
incardon committed
154 155 156 157 158 159 160 161
		// Calculate the total number of box and and the spacing
		// on each direction
		// Get the box containing the domain
		SpaceBox<dim,T> bs = domain.getBox();

		for (unsigned int i = 0; i < dim ; i++)
		{
			// Calculate the spacing
incardon's avatar
incardon committed
162
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
163 164 165 166
		}

		// Here we use METIS
		// Create a cartesian grid graph
incardon's avatar
incardon committed
167
		CartesianGraphFactory<dim,Graph_CSR<nm_part_v,nm_part_e>> g_factory_part;
incardon's avatar
incardon committed
168

Pietro Incardona's avatar
Pietro Incardona committed
169 170 171 172 173
		// the graph has only non perdiodic boundary conditions
		size_t bc_o[dim];
		for (size_t i = 0 ; i < dim ; i++)
			bc_o[i] = NON_PERIODIC;

incardon's avatar
incardon committed
174
		// sub-sub-domain graph
Pietro Incardona's avatar
Pietro Incardona committed
175
		Graph_CSR<nm_part_v,nm_part_e> gp = g_factory_part.template construct<NO_EDGE,T,dim-1>(gr.getSize(),domain,bc_o);
incardon's avatar
incardon committed
176 177 178 179 180 181 182 183

		// Get the number of processing units
		size_t Np = v_cl.getProcessingUnits();

		// Get the processor id
		long int p_id = v_cl.getProcessUnitID();

		// Convert the graph to metis
incardon's avatar
incardon committed
184
		Metis<Graph_CSR<nm_part_v,nm_part_e>> met(gp,Np);
incardon's avatar
incardon committed
185 186

		// decompose
incardon's avatar
incardon committed
187
		met.decompose<nm_part_v::id>();
incardon's avatar
incardon committed
188

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

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

		// set of Boxes produced by the decomposition optimizer
		openfpm::vector<::Box<dim,size_t>> loc_box;

incardon's avatar
incardon committed
199
		// optimize the decomposition
Pietro Incardona's avatar
Pietro Incardona committed
200
		d_o.template optimize<nm_part_v::sub_id,nm_part_v::id>(gp,p_id,loc_box,box_nn_processor,bc);
incardon's avatar
incardon committed
201

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

210 211 212 213 214 215 216 217 218 219 220 221 222
			// 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)
			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));
				}
			}

incardon's avatar
incardon committed
223 224 225 226
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
227
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
228 229 230
			bbox = sub_d;
		}

incardon's avatar
incardon committed
231
		// convert into sub-domain
incardon's avatar
incardon committed
232
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
233
		{
234 235
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
236

incardon's avatar
incardon committed
237 238 239
			// re-scale and add spacing (the end is the starting point of the next domain + spacing)
			sub_d.mul(spacing);
			sub_d.expand(spacing);
incardon's avatar
incardon committed
240

241 242 243 244 245 246 247 248 249 250 251 252 253
			// 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)
			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));
				}
			}

incardon's avatar
incardon committed
254 255
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
256 257 258 259 260 261

			// 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
262
		}
incardon's avatar
incardon committed
263

264
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);
incardon's avatar
incardon committed
265
		nn_prcs<dim,T>::refine_ss_box(ss_box);
Pietro Incardona's avatar
Pietro Incardona committed
266
		nn_prcs<dim,T>::applyBC(domain,ghost,bc);
267

incardon's avatar
incardon committed
268
		// fill fine_s structure
incardon's avatar
incardon committed
269 270 271
		// 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)
incardon's avatar
incardon committed
272 273 274 275 276 277 278 279 280 281 282
		auto it = gp.getVertexIterator();

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

			// fill with the fine decomposition
			fine_s.get(key) = gp.template vertex_p<nm_part_v::id>(key);

			++it;
		}
283

incardon's avatar
incardon committed
284 285 286 287 288 289 290 291 292 293
		Initialize_geo_cell_lists();
	}

	/*! \brief Initialize geo_cell lists
	 *
	 *
	 *
	 */
	void Initialize_geo_cell_lists()
	{
294 295 296 297
		// Get the smallest sub-division on each direction
		::Box<dim,T> unit = getSmallestSubdivision();
		// Get the processor bounding Box
		::Box<dim,T> bound = getProcessorBounds();
Pietro Incardona's avatar
Pietro Incardona committed
298 299
		// Not necessary, but I prefer
		bound.enlarge(ghost);
300

incardon's avatar
incardon committed
301
		// calculate the sub-divisions
302 303
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
304
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
305 306 307 308 309 310 311 312 313

		// Create shift
		Point<dim,T> orig;

		// p1 point of the Processor bound box is the shift
		for (size_t i = 0 ; i < dim ; i++)
			orig.get(i) = bound.getLow(i);

		// Initialize the geo_cell structure
Pietro Incardona's avatar
Pietro Incardona committed
314
		ie_ghost<dim,T>::Initialize_geo_cell(bound,div,orig);
315 316 317

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

	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
326
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

		// 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
			SpaceBox<dim,T> tmp;

			//! fill with the Margin of the box
			for (int i = 0 ; i < dim ; i++)
			{
				tmp.setHigh(i,(key.get(i)+1)*spacing[i]);
				tmp.setLow(i,key.get(i)*spacing[i]);
			}

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

			// add the iterator
			++gk_it;
		}
	}

public:

incardon's avatar
incardon committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370
	//! 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
371 372 373 374 375 376
	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
incardon's avatar
incardon committed
377
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
378 379 380 381
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
382

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
	/*! \brief Cartesian decomposition copy constructor
	 *
     * \param cart object to copy
	 *
	 */
	CartDecomposition(const CartDecomposition<dim,T,Memory,Domain> & cart)
	:nn_prcs<dim,T>(cart.v_cl),v_cl(cart.v_cl),ref_cnt(0)
	{
		this->operator=(cart);
	}

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

incardon's avatar
incardon committed
405 406 407 408
	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
409
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
410

411 412 413 414 415 416 417 418 419 420 421 422 423 424
	/*! \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
		 *
		 */
incardon's avatar
incardon committed
425
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
		{
			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
		 *
		 */
incardon's avatar
incardon committed
445
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
		{
			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
		 *
		 */
incardon's avatar
incardon committed
465
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
466 467 468 469 470
		{
			return p.lc_proc;
		}
	};

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
	/*! \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;
		}
	};

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
	/*! \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
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
510
	bool applyPointBC(Point<dim,T> & pt) const
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
	{
		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
533
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
534 535 536 537 538
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
539 540 541
	 *
	 \verbatim

incardon's avatar
incardon committed
542 543 544
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
incardon's avatar
incardon committed
545
|                 Sub+domain 0                       +-----------------------------------+
incardon's avatar
incardon committed
546 547 548 549 550 551
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
incardon's avatar
incardon committed
552 553 554 555 556
 |              |   |                           |B9_0|                                   |
 |              | B |    Local processor        |    |                                   |
 | Processor 5  | 5 |    Subdomain 0            |    |                                   |
 | Subdomain 0  | _ |                           +----------------------------------------+
 |              | 0 |                           |    |                                   |
incardon's avatar
incardon committed
557 558 559 560 561 562 563 564 565 566
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

incardon's avatar
incardon committed
567

568 569
 \endverbatim

incardon's avatar
incardon committed
570
       and also
incardon's avatar
incardon committed
571
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
572

incardon's avatar
incardon committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
      +----------------------------------------------------+
      |                 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|                              |
|                 |   |                                    |    |                              |
|                 |   |                                    |    |                              |
+---------------------+------------------------------------+    |                              |
                  |                                        |    |                              |
                  +----------------------------------------+----+------------------------------+
incardon's avatar
incardon committed
597 598


599 600
 \endverbatim

incardon's avatar
incardon committed
601 602 603 604 605
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
606 607
	 *
	 \verbatim
incardon's avatar
incardon committed
608 609 610 611 612 613 614 615 616 617 618 619 620
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

621 622
     \endverbatim

incardon's avatar
incardon committed
623 624 625
	 *
	 *
	 */
incardon's avatar
incardon committed
626
	void calculateGhostBoxes()
incardon's avatar
incardon committed
627 628 629 630 631 632 633
	{
#ifdef DEBUG
		// the ghost margins are assumed to be smaller
		// than one sub-domain

		for (size_t i = 0 ; i < dim ; i++)
		{
incardon's avatar
incardon committed
634
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
incardon's avatar
incardon committed
635
			{
636
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
637 638 639 640 641 642
			}
		}
#endif

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

incardon's avatar
incardon committed
643
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
644 645
		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
646

incardon's avatar
incardon committed
647
		// ebox must come after ibox (in this case)
648
		ie_loc_ghost<dim,T>::create(sub_domains,domain,ghost,bc);
incardon's avatar
incardon committed
649 650 651 652

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

incardon's avatar
incardon committed
660 661 662 663 664 665 666
	/*! \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
	 *
	 */
667
	CartDecomposition<dim,T,Memory,Domain> duplicate(const Ghost<dim,T> & g) const
incardon's avatar
incardon committed
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
	{
		CartDecomposition<dim,T,Memory,Domain> cart(v_cl);

		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;

687 688 689
		for (size_t i = 0 ; i < dim ; i++)
			cart.bc[i] = bc[i];

690 691
		(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
692

Pietro Incardona's avatar
Pietro Incardona committed
693 694
		cart.Initialize_geo_cell_lists();
		cart.calculateGhostBoxes();
incardon's avatar
incardon committed
695 696 697 698 699

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
700 701 702 703
	 *
	 * \return a duplicated decomposition
	 *
	 */
704
	CartDecomposition<dim,T,Memory,Domain> duplicate() const
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
	{
		CartDecomposition<dim,T,Memory,Domain> cart(v_cl);

		(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
725 726 727
		cart.bbox = bbox;
		cart.ss_box = ss_box;

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

731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
		return cart;
	}

	/*! \brief Copy the element
	 *
	 * \param cart element to copy
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> & operator=(const CartDecomposition & cart)
	{
		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
758 759 760
		bbox = cart.bbox;
		ss_box = cart.ss_box;

761 762 763
		for (size_t i = 0 ; i < dim ; i++)
			bc[i] = cart.bc[i];

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
		return *this;
	}

	/*! \brief Copy the element, move semantic
	 *
	 * \param cart element to copy
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> & operator=(CartDecomposition && cart)
	{
		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.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
791 792 793
		cart.bbox = bbox;
		cart.ss_box = ss_box;

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

797 798 799
		return *this;
	}

800 801 802 803 804 805 806 807 808 809 810 811 812 813
	/*! \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
		return openfpm::math::round_big_2(pow(n_sub,1.0/dim));
	}

814
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
815 816 817 818
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
819
	template<typename Mem, typename ofb> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
820
	{
Pietro Incardona's avatar
Pietro Incardona committed
821
		return fine_s.get(cd.template getCell<ofb>(p));
incardon's avatar
incardon committed
822 823
	}

824
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
825
	 *
826
	 * \return processorID
incardon's avatar
incardon committed
827 828
	 *
	 */
829
	size_t inline processorID(const Point<dim,T> &p) const
incardon's avatar
incardon committed
830
	{
831
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
832 833
	}

834
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
835 836 837 838
	 *
	 * \return processorID
	 *
	 */
839
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
840
	{
incardon's avatar
incardon committed
841
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
842 843
	}

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary conditions are considered
	 *
	 * \return processorID
	 *
	 */
	template<typename Mem> size_t inline processorIDBC(encapc<1, Point<dim,T>, Mem> p)
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(pt));
	}

	/*! \brief Given a point return in which processor the particle should go
	 *
	 * Boundary conditions are considered
	 *
	 * \return processorID
	 *
	 */
Pietro Incardona's avatar
Pietro Incardona committed
866
	template<typename ofb> size_t inline processorIDBC(const Point<dim,T> &p) const
867 868 869 870 871 872 873 874 875 876 877 878 879 880
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		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
881
	template<typename ofb> size_t inline processorIDBC(const T (&p)[dim]) const
882 883 884 885 886 887 888
	{
		Point<dim,T> pt = p;
		applyPointBC(pt);

		return fine_s.get(cd.getCell(p));
	}

889 890 891 892 893 894 895 896 897 898
	/*! \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;
	}

incardon's avatar
incardon committed
899 900
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
901
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
902 903 904
     * \param domain_ domain to decompose
	 *
	 */
905
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, const size_t (& bc)[dim] ,const Ghost<dim,T> & ghost)
incardon's avatar
incardon committed
906
	{
Pietro Incardona's avatar
Pietro Incardona committed
907 908 909 910
		// set the boundary conditions
		for (size_t i = 0 ; i < dim ; i++)
			this->bc[i] = bc[i];

incardon's avatar
incardon committed
911 912
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
913 914
		// Set the decomposition parameters

incardon's avatar
incardon committed
915
		gr.setDimensions(div_);
incardon's avatar
incardon committed
916
		domain = domain_;
incardon's avatar
incardon committed
917
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
918 919 920

		//! Create the decomposition

Pietro Incardona's avatar
Pietro Incardona committed
921
		CreateDecomposition(v_cl,bc);
incardon's avatar
incardon committed
922 923
	}

924
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
925 926 927 928 929 930 931 932 933
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
934
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
935
	 *
incardon's avatar
incardon committed
936 937
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
	 *
	 */
	SpaceBox<dim,T> getLocalHyperCube(size_t lc)
	{
		// Create a space box
		SpaceBox<dim,T> sp;

		// fill the space box

		for (size_t k = 0 ; k < dim ; k++)
		{
			// create the SpaceBox Low and High
			sp.setLow(k,sub_domains.template get<Box::p1>(lc)[k]);
			sp.setHigh(k,sub_domains.template get<Box::p2>(lc)[k]);
		}

		return sp;
	}

incardon's avatar
incardon committed
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
	/*! \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
	 *
	 */
	SpaceBox<dim,T> getSubDomainWithGhost(size_t lc)
	{
		// Create a space box
		SpaceBox<dim,T> sp = sub_domains.get(lc);

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

		return sp;
	}

974
	/*! \brief Return the box of the physical domain
incardon's avatar
incardon committed
975
	 *
976
	 * \return The physical domain box
incardon's avatar
incardon committed
977 978
	 *
	 */
979
	const Domain<dim,T> & getDomain()
incardon's avatar
incardon committed
980 981 982 983
	{
		return domain;
	}

incardon's avatar
incardon committed
984
	/*! \brief Check if the particle is local
985 986
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
987 988
	 *
	 * \param p object position
incardon's avatar
incardon committed
989
	 *
incardon's avatar
incardon committed
990
	 * \return true if it is local
incardon's avatar
incardon committed
991 992
	 *
	 */
993
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
994
	{
995
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
996
	}
incardon's avatar
incardon committed
997

incardon's avatar
incardon committed
998
	/*! \brief Check if the particle is local
999 1000
	 *
	 * \warning if the particle id outside the domain the result is unreliable
incardon's avatar
incardon committed
1001
	 *
incardon's avatar
incardon committed
1002
	 * \param p object position
incardon's avatar
incardon committed
1003
	 *
incardon's avatar
incardon committed
1004
	 * \return true if it is local
incardon's avatar
incardon committed
1005 1006
	 *
	 */
1007
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
1008
	{
incardon's avatar
incardon committed
1009 1010
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
1011

1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
	/*! \brief Check if the particle is local considering boundary conditions
	 *
	 * \warning if the particle id outside the domain and non periodic the result
	 *          is unreliable
	 *
	 *
	 * \param p object position
	 *
	 * \return true if it is local
	 *
	 */
	template<typename Mem> bool isLocalBC(const encapc<1, Point<dim,T>, Mem> p, const size_t (& bc)[dim]) const
	{
		Point<dim,T> pt = p;

		for (size_t i = 0 ; i < dim ; i++)
		{
			if (bc[i] == PERIODIC)
				pt.get(i) = openfpm::math::periodic_l(p.template get<0>()[i],domain.getHigh(i),domain.getLow(i));
		}

		return processorID<Mem>(pt) == v_cl.getProcessUnitID();
	}

	/*! \brief Check if the particle is local considering boundary conditions
	 *
	 * \param p object position
	 *
	 * \return true if it is local
	 *
	 */
	bool isLocalBC(const T (&p)[dim], const size_t (& bc)[dim]) const
	{
		Point<dim,T> pt = p;

		for (size_t i = 0 ; i < dim ; i++)
		{
			if (pt.get(0) < -0.1)
			{
				int debug = 0;
				debug++;
			}

			if (bc[i] == PERIODIC)
				pt.get(i) = openfpm::math::periodic_l(p[i],domain.getHigh(i),domain.getLow(i));
		}

		return processorID(pt) == v_cl.getProcessUnitID();
	}

1062
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
1063 1064 1065 1066 1067 1068 1069 1070
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
1071

1072

1073 1074 1075 1076 1077 1078 1079 1080 1081
	/*! \brief Return the ghost
	 *
	 *
	 */
	const Ghost<dim,T> & getGhost() const
	{
		return ghost;
	}

1082 1083
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
1084 1085 1086 1087
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
1088 1089 1090 1091 1092 1093
	 * * subdomains_X.vtk domain for the local processor (X) as union of sub-domain
	 * * subdomains_adjacent_X.vtk sub-domains adjacent to the local processor (X)
	 * * internal_ghost_X.vtk Internal ghost boxes for the local processor (X)
	 * * external_ghost_X.vtk External ghost boxes for the local processor (X)
	 * * local_internal_ghost_X.vtk internal local ghost boxes for the local processor (X)
	 * * local_external_ghost_X.vtk external local ghost boxes for the local processor (X)
incardon's avatar
incardon committed
1094
	 *
incardon's avatar
incardon committed
1095
	 * where X is the local processor rank
incardon's avatar
incardon committed
1096 1097 1098 1099 1100 1101
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
1102
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
1103 1104
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
1105
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
1106

1107
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
1108
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
1109
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
1110

1111
		return true;
incardon's avatar
incardon committed
1112
	}
incardon's avatar
incardon committed
1113

Pietro Incardona's avatar
Pietro Incardona committed
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
	/*! \brief Get the Virtual Cluster machine
	 *
	 * \return the Virtual cluster machine
	 *
	 */
	Vcluster & getVC() const
	{
#ifdef SE_CLASS2
		check_valid(this,8);
#endif
		return v_cl;
	}

incardon's avatar
incardon committed
1127 1128 1129 1130 1131 1132 1133
	/*! \brief function to check the consistency of the information of the decomposition
	 *
	 * \return false if is inconsistent
	 *
	 */
	bool check_consistency()
	{
incardon's avatar
incardon committed
1134 1135
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
1136 1137 1138

		return true;
	}
1139 1140 1141

	void debugPrint()
	{
1142 1143 1144 1145 1146 1147
		std::cout << "Subdomains\n";
		for (size_t p = 0 ; p < sub_domains.size() ; p++)
		{
			std::cout << ::SpaceBox<dim,T>(sub_domains.get(p)).toString() << "\n";
		}

1148
		std::cout << "External ghost box\n";
1149

1150 1151
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
1152
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
1153
			{
incardon's avatar
incardon committed
1154
				std::cout << ie_ghost<dim,T>::getProcessorEGhostBox(p,i).toString() << "