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

#ifndef CARTDECOMPOSITION_HPP
#define CARTDECOMPOSITION_HPP

#include "config.h"
#include "Decomposition.hpp"
incardon's avatar
incardon committed
13
#include "Vector/map_vector.hpp"
incardon's avatar
incardon committed
14 15 16 17 18 19 20
#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
21
#include "Space/Shape/Point.hpp"
incardon's avatar
incardon committed
22
#include "NN/CellList/CellDecomposer.hpp"
incardon's avatar
incardon committed
23 24
#include <unordered_map>
#include "NN/CellList/CellList.hpp"
incardon's avatar
incardon committed
25
#include "Space/Ghost.hpp"
incardon's avatar
incardon committed
26 27
#include "common.hpp"
#include "ie_loc_ghost.hpp"
28 29
#include "ie_ghost.hpp"
#include "nn_processor.hpp"
incardon's avatar
incardon committed
30 31 32 33 34 35 36 37 38 39

/**
 * \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 layout to use
 * \tparam Memory Memory factory used to allocate memory
 * \tparam Domain Structure that contain the information of your physical domain
 *
40 41
 * 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
42
 * going to take care of that part of space (in general the space assigned to a processor is
43 44 45 46 47 48 49 50 51 52 53 54 55 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
 *
 * * local sub-domain: all the sub-domain with id == local processor
 * * 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
62
 * * Local ghosts interal or external are all the ghosts that does not involve inter-processor communications
63 64
 *
 * \see calculateGhostBoxes() for a visualization of internal and external ghost boxes
incardon's avatar
incardon committed
65
 *
incardon's avatar
incardon committed
66 67
 */

incardon's avatar
incardon committed
68
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
69
class CartDecomposition : public ie_loc_ghost<dim,T>, public nn_prcs<dim,T> , public ie_ghost<dim,T>
incardon's avatar
incardon committed
70
{
incardon's avatar
incardon committed
71

incardon's avatar
incardon committed
72
public:
incardon's avatar
incardon committed
73

incardon's avatar
incardon committed
74 75 76 77 78 79 80 81
	//! 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
82
	//! This is the key type to access  data_s, for example in the case of vector
incardon's avatar
incardon committed
83
	//! acc_key is size_t
incardon's avatar
incardon committed
84
	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
85 86

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

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

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

incardon's avatar
incardon committed
96 97
	//! Structure that store the cartesian grid information
	grid_sm<dim,void> gr;
incardon's avatar
incardon committed
98

incardon's avatar
incardon committed
99 100 101
	//! 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
102 103 104 105 106 107 108 109 110 111

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

incardon's avatar
incardon committed
115

incardon's avatar
incardon committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
	/*! \brief Create internally the decomposition
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	void CreateDecomposition(Vcluster & v_cl)
	{
		// 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
131
			spacing[i] = (bs.getHigh(i) - bs.getLow(i)) / gr.size(i);
incardon's avatar
incardon committed
132 133 134 135
		}

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

		// Processor graph
incardon's avatar
incardon committed
139
		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
140 141 142 143 144 145 146 147

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

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

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

incardon's avatar
incardon committed
156 157
		// Optimize the decomposition creating bigger spaces
		// And reducing Ghost over-stress
incardon's avatar
incardon committed
158
		dec_optimizer<dim,Graph_CSR<nm_part_v,nm_part_e>> d_o(gp,gr.getSize());
incardon's avatar
incardon committed
159 160 161 162

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

incardon's avatar
incardon committed
163
		// optimize the decomposition
incardon's avatar
incardon committed
164 165
		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
166 167 168
		// Initialize ss_box and bbox
		if (loc_box.size() >= 0)
		{
169 170
			SpaceBox<dim,size_t> sub_dc = loc_box.get(0);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
171 172 173
			sub_d.mul(spacing);
			sub_d.expand(spacing);

174 175 176 177 178 179 180 181 182 183 184 185 186
			// 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
187 188 189 190
			// add the sub-domain
			sub_domains.add(sub_d);

			ss_box = sub_d;
incardon's avatar
incardon committed
191
			ss_box -= ss_box.getP1();
incardon's avatar
incardon committed
192 193 194
			bbox = sub_d;
		}

incardon's avatar
incardon committed
195
		// convert into sub-domain
incardon's avatar
incardon committed
196
		for (size_t s = 1 ; s < loc_box.size() ; s++)
incardon's avatar
incardon committed
197
		{
198 199
			SpaceBox<dim,size_t> sub_dc = loc_box.get(s);
			SpaceBox<dim,T> sub_d(sub_dc);
incardon's avatar
incardon committed
200

incardon's avatar
incardon committed
201 202 203
			// 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
204

205 206 207 208 209 210 211 212 213 214 215 216 217
			// 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
218 219
			// add the sub-domain
			sub_domains.add(sub_d);
incardon's avatar
incardon committed
220 221 222 223 224 225

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

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

incardon's avatar
incardon committed
230
		// fill fine_s structure
incardon's avatar
incardon committed
231 232 233
		// 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
234 235 236 237 238 239 240 241 242 243 244
		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;
		}
245 246 247 248 249 250

		// 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
251
		// calculate the sub-divisions
252 253
		size_t div[dim];
		for (size_t i = 0 ; i < dim ; i++)
incardon's avatar
incardon committed
254
			div[i] = (size_t)((bound.getHigh(i) - bound.getLow(i)) / unit.getHigh(i));
255 256 257 258 259 260 261 262 263

		// 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
264
		ie_ghost<dim,T>::Initialize_geo_cell(domain,div,orig);
incardon's avatar
incardon committed
265
		lgeo_cell.Initialize(domain,div,orig);
incardon's avatar
incardon committed
266 267
	}

incardon's avatar
incardon committed
268 269 270
	// Save the ghost boundaries
	Ghost<dim,T> ghost;

incardon's avatar
incardon committed
271

incardon's avatar
incardon committed
272 273 274 275 276 277 278 279 280
	/*! \brief Create the subspaces that decompose your domain
	 *
	 * Create the subspaces that decompose your domain
	 *
	 */

	void CreateSubspaces()
	{
		// Create a grid where each point is a space
281
		grid_sm<dim,void> g(div);
incardon's avatar
incardon committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

		// 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
310 311 312 313 314 315 316 317 318
	// 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
319 320 321 322 323 324 325 326
public:

	/*! \brief Cartesian decomposition constructor
	 *
     * \param v_cl Virtual cluster, used internally to handle or pipeline communication
	 *
	 */
	CartDecomposition(Vcluster & v_cl)
327
	:nn_prcs<dim,T>(v_cl),v_cl(v_cl)
incardon's avatar
incardon committed
328 329 330 331
	{
		// Reset the box to zero
		bbox.zero();
	}
incardon's avatar
incardon committed
332 333 334 335 336

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

incardon's avatar
incardon committed
337
//	openfpm::vector<size_t> ids;
incardon's avatar
incardon committed
338

339 340 341 342 343 344 345 346 347 348 349 350 351 352
	/*! \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
353
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
		{
			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
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 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
393
		inline static size_t id(p_box<dim,T> & p, size_t b_id)
394 395 396 397 398
		{
			return p.lc_proc;
		}
	};

incardon's avatar
incardon committed
399
	/*! It calculate the internal ghost boxes
incardon's avatar
incardon committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
	 *
	 * Example: Processor 10 calculate
	 * B8_0 B9_0 B9_1 and B5_0
	 *
	 *
+----------------------------------------------------+
|                                                    |
|                 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                |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 |              |   |                           |    |                                   |
 +--------------+---+---------------------------+----+                                   |
                                                     |                                   |
                                                     +-----------------------------------+

       and also
incardon's avatar
incardon committed
431
       G8_0 G9_0 G9_1 G5_0 (External ghost boxes)
incardon's avatar
incardon committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479

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


	 *
	 *
	 *
	 * \param ghost margins for each dimensions (p1 negative part) (p2 positive part)
	 *
                ^ p2[1]
                |
                |
           +----+----+
           |         |
           |         |
p1[0]<-----+         +----> p2[0]
           |         |
           |         |
           +----+----+
                |
                v  p1[1]

	 *
	 *
	 */
incardon's avatar
incardon committed
480
	void calculateGhostBoxes()
incardon's avatar
incardon committed
481 482 483 484 485 486 487
	{
#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
488
			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
489
			{
490
				std::cerr << "Error " << __FILE__ << ":" << __LINE__  << " : Ghost are bigger than one domain" << "\n";
incardon's avatar
incardon committed
491 492 493 494 495 496
			}
		}
#endif

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

incardon's avatar
incardon committed
497
		// create the internal structures that store ghost information
incardon's avatar
incardon committed
498 499
		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
500

incardon's avatar
incardon committed
501
		// ebox must come after ibox (in this case)
incardon's avatar
incardon committed
502 503 504

		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
505 506 507 508 509 510 511 512 513

		// 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
514 515
	}

incardon's avatar
incardon committed
516 517 518 519 520 521
	/*! \brief processorID return in which processor the particle should go
	 *
	 * \return processorID
	 *
	 */

incardon's avatar
incardon committed
522
	template<typename Mem> size_t inline processorID(encapc<1, Point<dim,T>, Mem> p)
incardon's avatar
incardon committed
523
	{
incardon's avatar
incardon committed
524
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
525 526
	}

incardon's avatar
incardon committed
527 528 529 530 531 532 533 534 535 536 537 538 539
	// 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;
	}

incardon's avatar
incardon committed
540 541 542 543 544 545
	/*! \brief processorID return in which processor the particle should go
	 *
	 * \return processorID
	 *
	 */

546
	size_t inline processorID(const T (&p)[dim]) const
incardon's avatar
incardon committed
547
	{
incardon's avatar
incardon committed
548
		return fine_s.get(cd.getCell(p));
incardon's avatar
incardon committed
549 550
	}

incardon's avatar
incardon committed
551 552
	/*! \brief Set the parameter of the decomposition
	 *
incardon's avatar
incardon committed
553
     * \param div_ storing into how many domain to decompose on each dimension
incardon's avatar
incardon committed
554 555 556
     * \param domain_ domain to decompose
	 *
	 */
incardon's avatar
incardon committed
557
	void setParameters(const size_t (& div_)[dim], Domain<dim,T> domain_, Ghost<dim,T> ghost = Ghost<dim,T>())
incardon's avatar
incardon committed
558
	{
incardon's avatar
incardon committed
559 560
		// set the ghost
		this->ghost = ghost;
incardon's avatar
incardon committed
561 562
		// Set the decomposition parameters

incardon's avatar
incardon committed
563
		gr.setDimensions(div_);
incardon's avatar
incardon committed
564
		domain = domain_;
incardon's avatar
incardon committed
565
		cd.setDimensions(domain,div_,0);
incardon's avatar
incardon committed
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

		//! Create the decomposition

		CreateDecomposition(v_cl);
	}

	/*! \brief Get the number of local local hyper-cubes or sub-domains
	 *
	 * \return the number of sub-domains
	 *
	 */
	size_t getNLocalHyperCube()
	{
		return sub_domains.size();
	}

	/*! \brief Get the number of one set of hyper-cube enclosing one particular
	 *         subspace, the hyper-cube enclose your space, even if one box is enough
	 *         can be more that one to increase occupancy
	 *
     * In case of Cartesian decomposition it just return 1, each subspace
	 * has one hyper-cube, and occupancy 1
	 *
	 * \param id of the subspace
	 * \return the number of hyper-cube enclosing your space
	 *
	 */
	size_t getNHyperCube(size_t id)
	{
		return 1;
	}

	/*! \brief Get the hyper-cube margins id_c has to be 0
	 *
	 * Get the hyper-cube margins id_c has to be 0, each subspace
	 * has one hyper-cube
	 *
	 * \param id of the subspace
	 * \param id_c
	 * \return The specified hyper-cube space
	 *
	 */
	SpaceBox<dim,T> & getHyperCubeMargins(size_t id, size_t id_c)
	{
#ifdef DEBUG
		// Check if this subspace exist
incardon's avatar
incardon committed
612
		if (id >= gr.size())
incardon's avatar
incardon committed
613 614 615 616 617 618 619 620 621 622 623 624 625
		{
			std::cerr << "Error CartDecomposition: id > N_tot";
		}
		else if (id_c > 0)
		{
			// Each subspace is an hyper-cube so return error if id_c > 0
			std::cerr << "Error CartDecomposition: id_c > 0";
		}
#endif

		return sub_domains.get<Object>(id);
	}

incardon's avatar
incardon committed
626
	/*! \brief Get the total number of sub-domain for the local processor
incardon's avatar
incardon committed
627
	 *
incardon's avatar
incardon committed
628
	 * \return The total number of sub-domains
incardon's avatar
incardon committed
629 630 631 632 633
	 *
	 */

	size_t getNHyperCube()
	{
incardon's avatar
incardon committed
634
		return gr.size();
incardon's avatar
incardon committed
635 636
	}

incardon's avatar
incardon committed
637
	/*! \brief Get the local sub-domain
incardon's avatar
incardon committed
638
	 *
incardon's avatar
incardon committed
639 640
	 * \param i (each local processor can have more than one sub-domain)
	 * \return the sub-domain
incardon's avatar
incardon committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
	 *
	 */
	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
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
	/*! \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
678 679 680 681 682 683 684 685 686 687 688 689 690
	/*! \brief Return the structure that store the physical domain
	 *
	 * Return the structure that store the physical domain
	 *
	 * \return The physical domain
	 *
	 */

	Domain<dim,T> & getDomain()
	{
		return domain;
	}

incardon's avatar
incardon committed
691 692 693
	/*! \brief Check if the particle is local
	 *
	 * \param p object position
incardon's avatar
incardon committed
694
	 *
incardon's avatar
incardon committed
695
	 * \return true if it is local
incardon's avatar
incardon committed
696 697
	 *
	 */
698
	template<typename Mem> bool isLocal(const encapc<1, Point<dim,T>, Mem> p) const
incardon's avatar
incardon committed
699
	{
700
		return processorID<Mem>(p) == v_cl.getProcessUnitID();
incardon's avatar
incardon committed
701
	}
incardon's avatar
incardon committed
702

incardon's avatar
incardon committed
703
	/*! \brief Check if the particle is local
incardon's avatar
incardon committed
704
	 *
incardon's avatar
incardon committed
705
	 * \param p object position
incardon's avatar
incardon committed
706
	 *
incardon's avatar
incardon committed
707
	 * \return true if it is local
incardon's avatar
incardon committed
708 709
	 *
	 */
710
	bool isLocal(const T (&pos)[dim]) const
incardon's avatar
incardon committed
711
	{
incardon's avatar
incardon committed
712 713
		return processorID(pos) == v_cl.getProcessUnitID();
	}
incardon's avatar
incardon committed
714 715 716 717 718 719 720 721 722 723 724 725

	::Box<dim,T> bbox;

	/*! \brief Return the bounding box containing the processor box + smallest subdomain spacing
	 *
	 * \return The bounding box
	 *
	 */
	::Box<dim,T> & getProcessorBounds()
	{
		return bbox;
	}
incardon's avatar
incardon committed
726 727 728 729 730 731 732 733

	/*! \brief if the point fall into the ghost of some near processor it return the processors id's in which
	 *  it fall
	 *
	 * \param p Point
	 * \return iterator of the processors id's
	 *
	 */
incardon's avatar
incardon committed
734
/*	inline auto labelPoint(Point<dim,T> & p) -> decltype(geo_cell.getIterator(geo_cell.getCell(p)))
incardon's avatar
incardon committed
735 736
	{
		return geo_cell.getIterator(geo_cell.getCell(p));
incardon's avatar
incardon committed
737
	}*/
incardon's avatar
incardon committed
738

739

740 741
	////////////// Functions to get decomposition information ///////////////

incardon's avatar
incardon committed
742 743 744 745
	/*! \brief Write the decomposition as VTK file
	 *
	 * The function generate several files
	 *
746 747 748 749 750 751
	 * 1) subdomains_X.vtk domain for the local processor (X) as union of sub-domain
	 * 2) subdomains_adjacent_X.vtk sub-domains adjacent to the local processor (X)
	 * 3) internal_ghost_X.vtk Internal ghost boxes for the local processor (X)
	 * 4) external_ghost_X.vtk External ghost boxes for the local processor (X)
	 * 5) local_internal_ghost_X.vtk internal local ghost boxes for the local processor (X)
	 * 6) local_external_ghost_X.vtk external local ghost boxes for the local processor (X)
incardon's avatar
incardon committed
752
	 *
incardon's avatar
incardon committed
753
	 * where X is the local processor rank
incardon's avatar
incardon committed
754 755 756 757 758 759
	 *
	 * \param output directory where to write the files
	 *
	 */
	bool write(std::string output) const
	{
760
		//! subdomains_X.vtk domain for the local processor (X) as union of sub-domain
incardon's avatar
incardon committed
761 762
		VTKWriter<openfpm::vector<::SpaceBox<dim,T>>,VECTOR_BOX> vtk_box1;
		vtk_box1.add(sub_domains);
763
		vtk_box1.write(output + std::string("subdomains_") + std::to_string(v_cl.getProcessUnitID()) + std::string(".vtk"));
incardon's avatar
incardon committed
764

765
		nn_prcs<dim,T>::write(output);
incardon's avatar
incardon committed
766
		ie_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
767
		ie_loc_ghost<dim,T>::write(output,v_cl.getProcessUnitID());
incardon's avatar
incardon committed
768

769
		return true;
incardon's avatar
incardon committed
770
	}
incardon's avatar
incardon committed
771 772 773 774 775 776 777 778

	/*! \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
779 780
		if (ie_loc_ghost<dim,T>::check_consistency(getNLocalHyperCube()) == false)
			return false;
incardon's avatar
incardon committed
781 782 783

		return true;
	}
784 785 786

	void debugPrint()
	{
787 788 789 790 791 792
		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";
		}

793
		std::cout << "External ghost box\n";
794

795 796
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
797
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNEGhost(p) ; i++)
798
			{
incardon's avatar
incardon committed
799
				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";
800
			}
801
		}
802

803
		std::cout << "Internal ghost box\n";
804

805 806
		for (size_t p = 0 ; p < nn_prcs<dim,T>::getNNProcessors() ; p++)
		{
incardon's avatar
incardon committed
807
			for (size_t i = 0 ; i < ie_ghost<dim,T>::getProcessorNIGhost(p) ; i++)
808
			{
incardon's avatar
incardon committed
809
				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";
810 811
			}
		}
812
	}
incardon's avatar
incardon committed
813 814 815 816
};


#endif