CartDecomposition.hpp 29.2 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"
incardon's avatar
incardon committed
32

33 34
#define CARTDEC_ERROR 2000lu

incardon's avatar
incardon committed
35 36 37 38 39 40 41 42
/**
 * \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
 *
43 44
 * Given an N-dimensional space, this class decompose the space into a Cartesian grid of small
 * sub-sub-domain. At each sub-sub-domain is assigned  an id that identify which processor is
incardon's avatar
incardon committed
45
 * going to take care of that part of space (in general the space assigned to a processor is
46 47 48 49 50 51
 * simply connected), a second step merge several sub-sub-domain with same id into bigger region
 *  sub-domain with the id. Each sub-domain has an extended space called ghost part
 *
 * Assuming that VCluster.getProcessUnitID(), equivalent to the MPI processor rank, return the processor local
 * processor id, we define
 *
52 53
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
54 55 56 57 58 59 60 61 62 63 64 65
 * * 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
66
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
67 68
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
69
 *
70 71 72
 * ### 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
73 74
 */

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

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

incardon's avatar
incardon committed
81 82 83 84 85 86 87 88
	//! 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
89
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
90
	//! acc_key is size_t
91
	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
92 93

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

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

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

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

incardon's avatar
incardon committed
106 107 108
	//! 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
109 110 111 112 113 114 115 116 117 118

	//! 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
119 120 121 122
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

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

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
	// Heap memory receiver
	HeapMemory hp_recv;

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

	// Receive counter
	size_t recv_cnt;

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

	// Save the ghost boundaries
	Ghost<dim,T> ghost;

139
	/*! \brief Constructor, it decompose and distribute the sub-domains across the processors
incardon's avatar
incardon committed
140
	 *
141
     * \param v_cl Virtual cluster, used internally for communications
142
     *
incardon's avatar
incardon committed
143 144 145
	 */
	void CreateDecomposition(Vcluster & v_cl)
	{
146 147 148 149 150 151 152
#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
153 154 155 156 157 158 159 160
		// 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
161
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
162 163 164 165
		}

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

incardon's avatar
incardon committed
168
		// sub-sub-domain graph
incardon's avatar
incardon committed
169
		Graph_CSR<nm_part_v,nm_part_e> gp = g_factory_part.template construct<NO_EDGE,T,dim-1>(gr.getSize(),domain);
incardon's avatar
incardon committed
170 171 172 173 174 175 176 177

		// 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
178
		Metis<Graph_CSR<nm_part_v,nm_part_e>> met(gp,Np);
incardon's avatar
incardon committed
179 180

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

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

incardon's avatar
incardon committed
186 187
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
188
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
189 190 191 192

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

incardon's avatar
incardon committed
193
		// optimize the decomposition
incardon's avatar
incardon committed
194 195
		d_o.template optimize<nm_part_v::sub_id,nm_part_v::id>(gp,p_id,loc_box,box_nn_processor);

incardon's avatar
incardon committed
196 197 198
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
199 200
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
201 202 203
			sub_d.mul(spacing);
			sub_d.expand(spacing);

204 205 206 207 208 209 210 211 212 213 214 215 216
			// 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
217 218 219 220
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
221
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
222 223 224
			bbox = sub_d;
		}

incardon's avatar
incardon committed
225
		// convert into sub-domain
incardon's avatar
incardon committed
226
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
227
		{
228 229
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
230

incardon's avatar
incardon committed
231 232 233
			// 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
234

235 236 237 238 239 240 241 242 243 244 245 246 247
			// 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
248 249
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
250 251 252 253 254 255

			// 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
256
		}
incardon's avatar
incardon committed
257

258
		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);
incardon's avatar
incardon committed
259
		nn_prcs<dim,T>::refine_ss_box(ss_box);
260

incardon's avatar
incardon committed
261
		// fill fine_s structure
incardon's avatar
incardon committed
262 263 264
		// 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
265 266 267 268 269 270 271 272 273 274 275
		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;
		}
276

incardon's avatar
incardon committed
277 278 279 280 281 282 283 284 285 286
		Initialize_geo_cell_lists();
	}

	/*! \brief Initialize geo_cell lists
	 *
	 *
	 *
	 */
	void Initialize_geo_cell_lists()
	{
287 288 289 290 291
		// Get the smallest sub-division on each direction
		::Box<dim,T> unit = getSmallestSubdivision();
		// Get the processor bounding Box
		::Box<dim,T> bound = getProcessorBounds();

incardon's avatar
incardon committed
292
		// calculate the sub-divisions
293 294
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
295
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
296 297 298 299 300 301 302 303 304

		// 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
incardon's avatar
incardon committed
305
		ie_ghost<dim,T>::Initialize_geo_cell(domain,div,orig);
incardon's avatar
incardon committed
306 307 308 309 310 311 312 313
	}

	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
314
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344

		// 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
345 346 347 348 349 350 351 352 353 354 355 356 357 358
	//! 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
359 360 361 362 363 364
	/*! \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
365
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl),ref_cnt(0)
incardon's avatar
incardon committed
366 367 368 369
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
370

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
	/*! \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
393 394 395 396
	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
397
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
398

399 400 401 402 403 404 405 406 407 408 409 410 411 412
	/*! \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
413
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
		{
			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
433
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
		{
			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
453
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
454 455 456 457 458
		{
			return p.lc_proc;
		}
	};

incardon's avatar
incardon committed
459
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
460 461 462 463 464
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
465 466 467
	 *
	 \verbatim

incardon's avatar
incardon committed
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
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
|                 Sub-domain 0                       +-----------------------------------+
|                                                    |                                   |
|                                                    |                                   |
++--------------+---+---------------------------+----+        Processor 9                |
 |              |   |     B8_0                  |    |        Subdomain 0                |
 |              +------------------------------------+                                   |
 |              |   |                           |    |                                   |
 |              |   |  XXXXXXXXXXXXX XX         |B9_0|                                   |
 |              | B |  X Processor 10 X         |    |                                   |
 | Processor 5  | 5 |  X Sub-domain 0 X         |    |                                   |
 | Subdomain 0  | _ |  X              X         +----------------------------------------+
 |              | 0 |  XXXXXXXXXXXXXXXX         |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |        Processor 9                |
 |              |   |                           |B9_1|        Subdomain 1                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

493 494
 \endverbatim

incardon's avatar
incardon committed
495
       and also
incardon's avatar
incardon committed
496
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
497

498 499
 \verbatim

incardon's avatar
incardon committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
+----------------------------------------------------+
|                                                    |
|                 Processor 8                        |
|                 Sub-domain 0                       +-----------------------------------+
|           +---------------------------------------------+                              |
|           |         G8_0                           |    |                              |
++--------------+------------------------------------+    |   Processor 9                |
 |          |   |                                    |    |   Subdomain 0                |
 |          |   |                                    |G9_0|                              |
 |          |   |                                    |    |                              |
 |          |   |      XXXXXXXXXXXXX XX              |    |                              |
 |          |   |      X Processor 10 X              |    |                              |
 | Processor|5  |      X Sub-domain 0 X              |    |                              |
 | Subdomain|0  |      X              X              +-----------------------------------+
 |          |   |      XXXXXXXXXXXXXXXX              |    |                              |
 |          | G |                                    |    |                              |
 |          | 5 |                                    |    |   Processor 9                |
 |          | | |                                    |    |   Subdomain 1                |
 |          | 0 |                                    |G9_1|                              |
 |          |   |                                    |    |                              |
 |          |   |                                    |    |                              |
 +--------------+------------------------------------+    |                              |
            |                                        |    |                              |
            +----------------------------------------+----+------------------------------+


526 527
 \endverbatim

incardon's avatar
incardon committed
528 529 530 531 532
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
533 534
	 *
	 \verbatim
incardon's avatar
incardon committed
535 536 537 538 539 540 541 542 543 544 545 546 547
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

548 549
     \endverbatim

incardon's avatar
incardon committed
550 551 552
	 *
	 *
	 */
incardon's avatar
incardon committed
553
	void calculateGhostBoxes()
incardon's avatar
incardon committed
554 555 556 557 558 559 560
	{
#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
561
			if (fabs(ghost.template getLow(i)) >= ss_box.getHigh(i) || ghost.template getHigh(i) >= ss_box.getHigh(i))
incardon's avatar
incardon committed
562
			{
563
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one sub-domain" << "\n";
incardon's avatar
incardon committed
564 565 566 567 568 569
			}
		}
#endif

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

incardon's avatar
incardon committed
570
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
571 572
		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
573

incardon's avatar
incardon committed
574
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
575 576 577

		ie_loc_ghost<dim,T>::create_loc_ghost_ibox(ghost,sub_domains);
		ie_loc_ghost<dim,T>::create_loc_ghost_ebox(ghost,sub_domains);
incardon's avatar
incardon committed
578 579 580 581

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

incardon's avatar
incardon committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
	/*! \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
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> duplicate(Ghost<dim,T> & g)
	{
		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;

		nn_prcs<dim,T>::create(box_nn_processor, sub_domains);

		calculateGhostBoxes();
		Initialize_geo_cell_lists();

		return cart;
	}

	/*! \brief It create another object that contain the same information and act in the same way
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
	 *
	 * \return a duplicated decomposition
	 *
	 */
	CartDecomposition<dim,T,Memory,Domain> duplicate()
	{
		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
650 651 652
		cart.bbox = bbox;
		cart.ss_box = ss_box;

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
		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
680 681 682
		bbox = cart.bbox;
		ss_box = cart.ss_box;

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
		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
710 711 712
		cart.bbox = bbox;
		cart.ss_box = ss_box;

713 714 715
		return *this;
	}

716 717 718 719 720 721 722 723 724 725 726 727 728 729
	/*! \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));
	}

730
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
731 732 733 734
	 *
	 * \return processorID
	 *
	 */
incardon's avatar
incardon committed
735
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
736
	{
incardon's avatar
incardon committed
737
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
738 739
	}

incardon's avatar
incardon committed
740 741 742 743 744 745 746 747 748 749
	/*! \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;
	}

750
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
751 752 753 754 755
	 *
	 * \return processorID
	 *
	 */

756
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
757
	{
incardon's avatar
incardon committed
758
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
759 760
	}

incardon's avatar
incardon committed
761 762
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
763
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
764 765 766
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
767
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
768
	{
incardon's avatar
incardon committed
769 770
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
771 772
		// Set the decomposition parameters

incardon's avatar
incardon committed
773
		gr.setDimensions(div_);
incardon's avatar
incardon committed
774
		domain = domain_;
incardon's avatar
incardon committed
775
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
776 777 778 779 780 781

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

782
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
783 784 785 786 787 788 789 790 791
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
792
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
793
	 *
incardon's avatar
incardon committed
794 795
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
	 *
	 */
	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
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
	/*! \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;
	}

incardon's avatar
incardon committed
832 833 834 835 836 837 838 839 840 841
	/*! \brief Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */
	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
842 843 844
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
845
	 *
incardon's avatar
incardon committed
846
	 * \return true if it is local
incardon's avatar
incardon committed
847 848
	 *
	 */
849
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
850
	{
851
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
852
	}
incardon's avatar
incardon committed
853

incardon's avatar
incardon committed
854
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
855
	 *
incardon's avatar
incardon committed
856
	 * \param p object position
incardon's avatar
incardon committed
857
	 *
incardon's avatar
incardon committed
858
	 * \return true if it is local
incardon's avatar
incardon committed
859 860
	 *
	 */
861
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
862
	{
incardon's avatar
incardon committed
863 864
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
865

866
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
867 868 869 870 871 872 873 874
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
875

876

877 878
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
879 880 881 882
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
883 884 885 886 887 888
	 * * 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
889
	 *
incardon's avatar
incardon committed
890
	 * where X is the local processor rank
incardon's avatar
incardon committed
891 892 893 894 895 896
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
897
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
898 899
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
900
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
901

902
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
903
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
904
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
905

906
		return true;
incardon's avatar
incardon committed
907
	}
incardon's avatar
incardon committed
908 909 910 911 912 913 914 915

	/*! \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
916 917
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
918 919 920

		return true;
	}
921 922 923

	void debugPrint()
	{
924 925 926 927 928 929
		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";
		}

930
		std::cout << "External ghost box\n";
931

932 933
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
934
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
935
			{
incardon's avatar
incardon committed
936
				std::cout << ie_ghost<dim,T>::getProcessorEGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p) << "   id=" << ie_ghost<dim,T>::getProcessorEGhostId(p,i) << "\n";
937
			}
938
		}
939

940
		std::cout << "Internal ghost box\n";
941

942 943
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
944
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNIGhost(p) ; i++)
945
			{
incardon's avatar
incardon committed
946
				std::cout << ie_ghost<dim,T>::getProcessorIGhostBox(p,i).toString() << "   prc=" << nn_prcs<dim,T>::IDtoProc(p)  << "   id=" << ie_ghost<dim,T>::getProcessorIGhostId(p,i) <<  "\n";
947 948
			}
		}
949
	}
incardon's avatar
incardon committed
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979

	/*! \brief Check if the CartDecomposition contain the same information
	 *
	 * \param ele Element to check
	 *
	 */
	bool is_equal(CartDecomposition<dim,T,Memory,Domain> & cart)
	{
		static_cast<ie_loc_ghost<dim,T>*>(this)->is_equal(static_cast<ie_loc_ghost<dim,T>&>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->is_equal(static_cast<nn_prcs<dim,T>&>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->is_equal(static_cast<ie_ghost<dim,T>&>(cart));

		if (sub_domains != cart.sub_domains)
			return false;

		if (box_nn_processor != cart.box_nn_processor)
			return false;

		if (fine_s != cart.fine_s)
			return false;

		if (gr != cart.gr)
			return false;

		if (cd != cart.cd)
			return false;

		if (domain != cart.domain)
			return false;

incardon's avatar
incardon committed
980
		if (meta_compare<T[dim]>::meta_compare_f(cart.spacing,spacing) == false)
incardon's avatar
incardon committed
981 982 983 984 985 986 987
			return false;

		if (ghost != cart.ghost)
			return false;

		return true;
	}
incardon's avatar
incardon committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

	/*! \brief Check if the CartDecomposition contain the same information with the exception of the ghost part
	 * It is anyway required that the ghost come from the same sub-domains decomposition
	 *
	 * \param ele Element to check
	 *
	 */
	bool is_equal_ng(CartDecomposition<dim,T,Memory,Domain> & cart)
	{
		static_cast<ie_loc_ghost<dim,T>*>(this)->is_equal_ng(static_cast<ie_loc_ghost<dim,T>&>(cart));
		static_cast<nn_prcs<dim,T>*>(this)->is_equal(static_cast<nn_prcs<dim,T>&>(cart));
		static_cast<ie_ghost<dim,T>*>(this)->is_equal(static_cast<ie_ghost<dim,T>&>(cart));

		if (sub_domains != cart.sub_domains)
			return false;

		if (box_nn_processor != cart.box_nn_processor)
			return false;

		if (fine_s != cart.fine_s)
			return false;

		if (gr != cart.gr)
			return false;

		if (cd != cart.cd)
			return false;

		if (domain != cart.domain)
			return false;

		if (meta_compare<T[dim]>::meta_compare_f(cart.spacing,spacing) == false)
			return false;

		return true;
	}
incardon's avatar
incardon committed
1024 1025 1026 1027
};


#endif