CartDecomposition.hpp 23.3 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 22
#include <vector>
#include "global_const.hpp"
#include <initializer_list>
#include "SubdomainGraphNodes.hpp"
#include "metis_util.hpp"
#include "dec_optimizer.hpp"
#include "Space/Shape/Box.hpp"
incardon's avatar
incardon committed
23
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
24
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
25 26
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
27
#include "Space/Ghost.hpp"
incardon's avatar
incardon committed
28 29
#include "common.hpp"
#include "ie_loc_ghost.hpp"
30 31
#include "ie_ghost.hpp"
#include "nn_processor.hpp"
incardon's avatar
incardon committed
32

33 34 35 36 37 38 39 40 41 42 43
#define CARTDEC_ERROR 2000lu

// Macro that decide what to do in case of error
#ifdef STOP_ON_ERROR
#define ACTION_ON_ERROR() exit(1);
#elif defined(THROW_ON_ERROR)
#define ACTION_ON_ERROR() throw CARTDEC_ERROR;
#else
#define ACTION_ON_ERROR()
#endif

incardon's avatar
incardon committed
44 45 46 47 48
/**
 * \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 ...
49
 * \tparam device_l layout to use
incardon's avatar
incardon committed
50 51 52
 * \tparam Memory Memory factory used to allocate memory
 * \tparam Domain Structure that contain the information of your physical domain
 *
53 54
 * 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
55
 * going to take care of that part of space (in general the space assigned to a processor is
56 57 58 59 60 61
 * 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
 *
62 63
 * * local processor: processor rank
 * * local sub-domain: sub-domain given to the local processor
64 65 66 67 68 69 70 71 72 73 74 75
 * * 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
76
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
77 78
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
79
 *
80 81 82
 * ### 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
83 84
 */

incardon's avatar
incardon committed
85
template<unsigned int dim, typename T, template<typename> class device_l=openfpm::device_cpu, typename Memory=HeapMemory, template<unsigned int, typename> class Domain=Box>
incardon's avatar
incardon committed
86
class CartDecomposition : public ie_loc_ghost<dim,T>, public nn_prcs<dim,T> , public ie_ghost<dim,T>
incardon's avatar
incardon committed
87
{
incardon's avatar
incardon committed
88

incardon's avatar
incardon committed
89
public:
incardon's avatar
incardon committed
90

incardon's avatar
incardon committed
91 92 93 94 95 96 97 98
	//! 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
99
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
100
	//! acc_key is size_t
incardon's avatar
incardon committed
101
	typedef typename openfpm::vector<SpaceBox<dim,T>,device_l<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
102 103

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

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

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

incardon's avatar
incardon committed
113 114
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
115

incardon's avatar
incardon committed
116 117 118
	//! 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
119 120 121 122 123 124 125 126 127 128

	//! 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
129 130 131
	//! Cell-list that store the geometrical information of the local internal ghost boxes
	CellList<dim,T,FAST> lgeo_cell;

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

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

		// Processor graph
incardon's avatar
incardon committed
162
		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
163 164 165 166 167 168 169 170

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

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

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

incardon's avatar
incardon committed
179 180
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
181
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
182 183 184 185

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

incardon's avatar
incardon committed
186
		// optimize the decomposition
incardon's avatar
incardon committed
187 188
		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
189 190 191
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
192 193
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
194 195 196
			sub_d.mul(spacing);
			sub_d.expand(spacing);

197 198 199 200 201 202 203 204 205 206 207 208 209
			// 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
210 211 212 213
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
214
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
215 216 217
			bbox = sub_d;
		}

incardon's avatar
incardon committed
218
		// convert into sub-domain
incardon's avatar
incardon committed
219
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
220
		{
221 222
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
223

incardon's avatar
incardon committed
224 225 226
			// 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
227

228 229 230 231 232 233 234 235 236 237 238 239 240
			// 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
241 242
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
243 244 245 246 247 248

			// 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
249
		}
incardon's avatar
incardon committed
250

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

incardon's avatar
incardon committed
253
		// fill fine_s structure
incardon's avatar
incardon committed
254 255 256
		// 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
257 258 259 260 261 262 263 264 265 266 267
		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;
		}
268 269 270 271 272 273

		// 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
274
		// calculate the sub-divisions
275 276
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
277
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
278 279 280 281 282 283 284 285 286

		// 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
287
		ie_ghost<dim,T>::Initialize_geo_cell(domain,div,orig);
incardon's avatar
incardon committed
288
		lgeo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
289 290
	}

incardon's avatar
incardon committed
291 292 293
	// Save the ghost boundaries
	Ghost<dim,T> ghost;

incardon's avatar
incardon committed
294

incardon's avatar
incardon committed
295 296 297 298 299 300
	/*! \brief Create the subspaces that decompose your domain
	 *
	 */
	void CreateSubspaces()
	{
		// Create a grid where each point is a space
301
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329

		// 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;
		}
	}

incardon's avatar
incardon committed
330 331 332 333 334 335 336 337 338
	// Heap memory receiver
	HeapMemory hp_recv;

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

	// Receive counter
	size_t recv_cnt;

incardon's avatar
incardon committed
339 340 341 342 343 344 345 346
public:

	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
347
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl)
incardon's avatar
incardon committed
348 349 350 351
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
352 353 354 355 356

	//! Cartesian decomposition destructor
	~CartDecomposition()
	{}

incardon's avatar
incardon committed
357
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
358

359 360 361 362 363 364 365 366 367 368 369 370 371 372
	/*! \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
373
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
		{
			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
393
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
		{
			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
413
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
414 415 416 417 418
		{
			return p.lc_proc;
		}
	};

incardon's avatar
incardon committed
419
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
420 421 422 423 424
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
425 426 427
	 *
	 \verbatim

incardon's avatar
incardon committed
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
+----------------------------------------------------+
|                                                    |
|                 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                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

453 454
 \endverbatim

incardon's avatar
incardon committed
455
       and also
incardon's avatar
incardon committed
456
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
457

458 459
 \verbatim

incardon's avatar
incardon committed
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
+----------------------------------------------------+
|                                                    |
|                 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|                              |
 |          |   |                                    |    |                              |
 |          |   |                                    |    |                              |
 +--------------+------------------------------------+    |                              |
            |                                        |    |                              |
            +----------------------------------------+----+------------------------------+


486 487
 \endverbatim

incardon's avatar
incardon committed
488 489 490 491 492
	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
493 494
	 *
	 \verbatim
incardon's avatar
incardon committed
495 496 497 498 499 500 501 502 503 504 505 506 507
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

508 509
     \endverbatim

incardon's avatar
incardon committed
510 511 512
	 *
	 *
	 */
incardon's avatar
incardon committed
513
	void calculateGhostBoxes()
incardon's avatar
incardon committed
514 515 516 517 518 519 520
	{
#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
521
			if (ghost.template getLow(i) >= domain.template getHigh(i) / gr.size(i) || ghost.template getHigh(i)  >= domain.template getHigh(i) / gr.size(i))
incardon's avatar
incardon committed
522
			{
523
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one domain" << "\n";
incardon's avatar
incardon committed
524 525 526 527 528 529
			}
		}
#endif

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

incardon's avatar
incardon committed
530
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
531 532
		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
533

incardon's avatar
incardon committed
534
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
535 536 537

		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
538 539 540 541 542 543 544 545 546

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

549
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
550 551 552 553
	 *
	 * \return processorID
	 *
	 */
incardon's avatar
incardon committed
554
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
555
	{
incardon's avatar
incardon committed
556
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
557 558
	}

incardon's avatar
incardon committed
559 560 561 562 563 564 565 566 567 568 569 570 571
	// Smallest subdivision on each direction
	::Box<dim,T> ss_box;

	/*! \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;
	}

572
	/*! \brief Given a point return in which processor the particle should go
incardon's avatar
incardon committed
573 574 575 576 577
	 *
	 * \return processorID
	 *
	 */

578
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
579
	{
incardon's avatar
incardon committed
580
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
581 582
	}

incardon's avatar
incardon committed
583 584
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
585
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
586 587 588
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
589
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
590
	{
incardon's avatar
incardon committed
591 592
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
593 594
		// Set the decomposition parameters

incardon's avatar
incardon committed
595
		gr.setDimensions(div_);
incardon's avatar
incardon committed
596
		domain = domain_;
incardon's avatar
incardon committed
597
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
598 599 600 601 602 603

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

604
	/*! \brief Get the number of local sub-domains
incardon's avatar
incardon committed
605 606 607 608 609 610 611 612 613
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

incardon's avatar
incardon committed
614
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
615
	 *
incardon's avatar
incardon committed
616 617
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
	 *
	 */
	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
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
	/*! \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
654 655 656 657 658 659 660 661 662 663
	/*! \brief Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */
	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
664 665 666
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
667
	 *
incardon's avatar
incardon committed
668
	 * \return true if it is local
incardon's avatar
incardon committed
669 670
	 *
	 */
671
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
672
	{
673
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
674
	}
incardon's avatar
incardon committed
675

incardon's avatar
incardon committed
676
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
677
	 *
incardon's avatar
incardon committed
678
	 * \param p object position
incardon's avatar
incardon committed
679
	 *
incardon's avatar
incardon committed
680
	 * \return true if it is local
incardon's avatar
incardon committed
681 682
	 *
	 */
683
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
684
	{
incardon's avatar
incardon committed
685 686
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
687 688 689

	::Box<dim,T> bbox;

690
	/*! \brief Return the bounding box containing union of all the sub-domains for the local processor
incardon's avatar
incardon committed
691 692 693 694 695 696 697 698
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
699

700

701 702
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
703 704 705 706
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
707 708 709 710 711 712
	 * * 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
713
	 *
incardon's avatar
incardon committed
714
	 * where X is the local processor rank
incardon's avatar
incardon committed
715 716 717 718 719 720
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
721
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
722 723
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
724
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
725

726
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
727
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
728
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
729

730
		return true;
incardon's avatar
incardon committed
731
	}
incardon's avatar
incardon committed
732 733 734 735 736 737 738 739

	/*! \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
740 741
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
742 743 744

		return true;
	}
745 746 747

	void debugPrint()
	{
748 749 750 751 752 753
		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";
		}

754
		std::cout << "External ghost box\n";
755

756 757
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
758
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
759
			{
incardon's avatar
incardon committed
760
				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";
761
			}
762
		}
763

764
		std::cout << "Internal ghost box\n";
765

766 767
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
768
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNIGhost(p) ; i++)
769
			{
incardon's avatar
incardon committed
770
				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";
771 772
			}
		}
773
	}
incardon's avatar
incardon committed
774 775 776 777
};


#endif