/usr/include/dune/grid/utility/globalindexset.hh is in libdune-grid-dev 2.5.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 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 310 311 312 313 314 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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
/** \file
*
* \brief Provides a globally unique index for all entities of a distributed Dune grid
*
* Such functionality is relevant for a number of applications:
* - Map a degree of freedom associated with an entity to its
* location in a global matrix or global vector
* - Such indices for elements are needed as input to external mesh partitioners
* - Using matrix and vector routines from the PETSc or trilinos parallel linear algebra
* packages for distributed memory parallel computers.
*
* Method: (1) The UniqueEntityPartition class assigns an owner process to each entity
*
* (2) Compute the number of entities that are owned by each process
*
* (3) we communicate the index of entities that are owned by the process to processes
* that also contain these entities but do not own them, so that on a non-owner process
* we have information on the index of the entity that it got from the owner-process;
*
* \author Benedikt Oswald, Patrick Leidenberger, Oliver Sander
*
* \attention globally unique indices are ONLY provided for entities of the
* InteriorBorder_Partition type, NOT for the Ghost_Partition type !!!
*
* \bug This code will most likely not work on grids with more than one element type.
* Please ask on the mailing list if you need this feature.
* \note The interface in this file is experimental, and may change without prior notice.
*/
#ifndef DUNE_GRID_UTILITY_GLOBALINDEXSET_HH
#define DUNE_GRID_UTILITY_GLOBALINDEXSET_HH
/** \brief Include standard header files. */
#include <vector>
#include <iostream>
#include <fstream>
#include <memory>
#include <map>
#include <utility>
#include <algorithm>
/** include base class functionality for the communication interface */
#include <dune/grid/common/gridenums.hh>
#include <dune/grid/common/datahandleif.hh>
/** include parallel capability */
#if HAVE_MPI
#include <dune/common/parallel/mpihelper.hh>
#endif
namespace Dune
{
/** \brief Calculate globally unique index over all processes in a Dune grid
*/
template<class GridView>
class GlobalIndexSet
{
public:
/** \brief The number type used for global indices */
typedef int Index;
/** \brief Helper class to provide access to subentity PartitionTypes with a run-time codimension
*
* This class can be removed if there is ever a method 'subPartitionType' similar to 'subIndex',
* that takes a run-time codimension argument.
*/
template <class Entity, int Codim>
struct SubPartitionTypeProvider
{
/** \brief Get PartitionType of the i-th subentity of codimension 'codim' of entity 'entity'
*/
static PartitionType get(const Entity& entity, int codim, int i)
{
if (codim==Codim)
return entity.template subEntity<Codim>(i).partitionType();
else
return SubPartitionTypeProvider<Entity,Codim-1>::get(entity, codim, i);
}
};
template <class Entity>
struct SubPartitionTypeProvider<Entity,0>
{
static PartitionType get(const Entity& entity, int codim, int i)
{
return entity.template subEntity<0>(i).partitionType();
}
};
private:
/** define data types */
typedef typename GridView::Grid Grid;
typedef typename GridView::Grid::GlobalIdSet GlobalIdSet;
typedef typename GridView::Grid::GlobalIdSet::IdType IdType;
typedef typename GridView::Traits::template Codim<0>::Iterator Iterator;
typedef typename Grid::CollectiveCommunication CollectiveCommunication;
typedef std::map<IdType,Index> MapId2Index;
typedef std::map<Index,Index> IndexMap;
/*********************************************************************************************/
/* calculate unique partitioning for all entities of a given codim in a given GridView, */
/* assuming they all have the same geometry, i.e. codim, type */
/*********************************************************************************************/
class UniqueEntityPartition
{
private:
/* A DataHandle class to calculate the minimum of a std::vector which is accompanied by an index set */
template<class IS, class V> // mapper type and vector type
class MinimumExchange
: public Dune::CommDataHandleIF<MinimumExchange<IS,V>,typename V::value_type>
{
public:
//! export type of data for message buffer
typedef typename V::value_type DataType;
//! returns true if data for this codim should be communicated
bool contains (int dim, unsigned int codim) const
{
return codim==indexSetCodim_;
}
//! returns true if size per entity of given dim and codim is a constant
bool fixedSize (int dim, int codim) const
{
return true ;
}
/*! how many objects of type DataType have to be sent for a given entity
*
* Note: Only the sender side needs to know this size. */
template<class EntityType>
size_t size (EntityType& e) const
{
return 1 ;
}
/*! pack data from user to message buffer */
template<class MessageBuffer, class EntityType>
void gather (MessageBuffer& buff, const EntityType& e) const
{
buff.write(v_[indexset_.index(e)]);
}
/** \brief Unpack data from message buffer to user
*
* \param n The number of objects sent by the sender
*/
template<class MessageBuffer, class EntityType>
void scatter (MessageBuffer& buff, const EntityType& e, size_t n)
{
DataType x;
buff.read(x);
if (x>=0) // other is -1 means, he does not want it
v_[indexset_.index(e)] = std::min(x,v_[indexset_.index(e)]);
}
//! constructor
MinimumExchange (const IS& indexset, V& v, unsigned int indexSetCodim)
: indexset_(indexset),
v_(v),
indexSetCodim_(indexSetCodim)
{}
private:
const IS& indexset_;
V& v_;
unsigned int indexSetCodim_;
};
public:
/*! \brief Constructor needs to know the grid function space
*/
UniqueEntityPartition (const GridView& gridview, unsigned int codim)
: assignment_(gridview.size(codim))
{
/** extract types from the GridView data type */
typedef typename GridView::IndexSet IndexSet;
// assign own rank to entities that I might have
for (auto it = gridview.template begin<0>(); it!=gridview.template end<0>(); ++it)
for (unsigned int i=0; i<it->subEntities(codim); i++)
{
// Evil hack: I need to call subEntity, which needs the entity codimension as a static parameter.
// However, we only have it as a run-time parameter.
PartitionType subPartitionType = SubPartitionTypeProvider<typename GridView::template Codim<0>::Entity, GridView::dimension>::get(*it,codim,i);
assignment_[gridview.indexSet().subIndex(*it,i,codim)]
= ( subPartitionType==Dune::InteriorEntity or subPartitionType==Dune::BorderEntity )
? gridview.comm().rank() // set to own rank
: - 1; // it is a ghost entity, I will not possibly own it.
}
/** exchange entity index through communication */
MinimumExchange<IndexSet,std::vector<Index> > dh(gridview.indexSet(),assignment_,codim);
gridview.communicate(dh,Dune::All_All_Interface,Dune::ForwardCommunication);
}
/** \brief Which rank is the i-th entity assigned to? */
int owner(size_t i)
{
return assignment_[i];
}
/** \brief Report the number of entities assigned to the rank 'rank' */
size_t numOwners(int rank) const
{
return std::count(assignment_.begin(), assignment_.end(), rank);
}
private:
std::vector<int> assignment_;
};
private:
/* A DataHandle class to communicate the global index from the
* owning to the non-owning entity; the class is based on the MinimumExchange
* class in the parallelsolver.hh header file.
*/
class IndexExchange
: public Dune::CommDataHandleIF<IndexExchange,Index>
{
public:
//! returns true if data for this codim should be communicated
bool contains (int dim, unsigned int codim) const
{
return codim==indexSetCodim_;
}
//! returns true if size per entity of given dim and codim is a constant
bool fixedSize (int dim, int codim) const
{
return true;
}
/** \brief How many objects of type DataType have to be sent for a given entity
*
* \note Only the sender side needs to know this size.
*/
template<class EntityType>
size_t size (EntityType& e) const
{
return 1;
}
/*! pack data from user to message buffer */
template<class MessageBuffer, class EntityType>
void gather (MessageBuffer& buff, const EntityType& e) const
{
IdType id=globalidset_.id(e);
if (indexSetCodim_==0)
buff.write(mapid2entity_[id]);
else
buff.write((*mapid2entity_.find(id)).second);
}
/** \brief Unpack data from message buffer to user
*
* \param n The number of objects sent by the sender
*/
template<class MessageBuffer, class EntityType>
void scatter (MessageBuffer& buff, const EntityType& entity, size_t n)
{
Index x;
buff.read(x);
/** only if the incoming index is a valid one,
* i.e. if it is greater than zero, will it be
* inserted as the global index; it is made
* sure in the upper class, i.e. GlobalIndexSet,
* that non-owning processes use -1 to mark an entity
* that they do not own.
*/
if(x >= 0) {
const IdType id = globalidset_.id(entity);
if (indexSetCodim_==0)
mapid2entity_[id] = x;
else
{
mapid2entity_.erase(id);
mapid2entity_.insert(std::make_pair(id,x));
const Index lindex = indexSet_.index(entity);
localGlobalMap_[lindex] = x;
}
}
}
//! constructor
IndexExchange (const GlobalIdSet& globalidset, MapId2Index& mapid2entity,
const typename GridView::IndexSet& localIndexSet, IndexMap& localGlobal,
unsigned int indexSetCodim)
: globalidset_(globalidset),
mapid2entity_(mapid2entity),
indexSet_(localIndexSet),
localGlobalMap_(localGlobal),
indexSetCodim_(indexSetCodim)
{}
private:
const GlobalIdSet& globalidset_;
MapId2Index& mapid2entity_;
const typename GridView::IndexSet& indexSet_;
IndexMap& localGlobalMap_;
unsigned int indexSetCodim_;
};
public:
/** \brief Constructor for a given GridView
*
* This constructor calculates the complete set of global unique indices so that we can then
* later query the global index, by directly passing the entity in question.
*/
GlobalIndexSet(const GridView& gridview, int codim)
: gridview_(gridview),
codim_(codim)
{
int rank = gridview.comm().rank();
int size = gridview.comm().size();
const typename GridView::IndexSet& indexSet = gridview.indexSet();
std::unique_ptr<UniqueEntityPartition> uniqueEntityPartition;
if (codim_!=0)
uniqueEntityPartition = std::unique_ptr<UniqueEntityPartition>(new UniqueEntityPartition(gridview,codim_));
int nLocalEntity = (codim_==0)
? std::distance(gridview.template begin<0, Dune::Interior_Partition>(), gridview.template end<0, Dune::Interior_Partition>())
: uniqueEntityPartition->numOwners(rank);
// Compute the global, non-redundant number of entities, i.e. the number of entities in the set
// without double, aka. redundant entities, on the interprocessor boundary via global reduce. */
nGlobalEntity_ = gridview.comm().template sum<int>(nLocalEntity);
/* communicate the number of locally owned entities to all other processes so that the respective offset
* can be calculated on the respective processor; we use the Dune mpi collective communication facility
* for this; first, we gather the number of locally owned entities on the root process and, second, we
* broadcast the array to all processes where the respective offset can be calculated. */
std::vector<int> offset(size);
std::fill(offset.begin(), offset.end(), 0);
/** Share number of locally owned entities */
gridview_.comm().template allgather<int>(&nLocalEntity, 1, offset.data());
int myoffset = 0;
for (int i=1; i<rank+1; i++)
myoffset += offset[i-1];
/* compute globally unique index over all processes; the idea of the algorithm is as follows: if
* an entity is owned by the process, it is assigned an index that is the addition of the offset
* specific for this process and a consecutively incremented counter; if the entity is not owned
* by the process, it is assigned -1, which signals that this specific entity will get its global
* unique index through communication afterwards;
*
* thus, the calculation of the globally unique index is divided into 2 stages:
*
* (1) we calculate the global index independently;
*
* (2) we achieve parallel adjustment by communicating the index
* from the owning entity to the non-owning entity.
*
*/
// 1st stage of global index calculation: calculate global index for owned entities
// initialize map that stores an entity's global index via it's globally unique id as key
globalIndex_.clear();
const GlobalIdSet& globalIdSet = gridview_.grid().globalIdSet(); /** retrieve globally unique Id set */
Index globalcontrib = 0; /** initialize contribution for the global index */
if (codim_==0) // This case is simpler
{
for (Iterator iter = gridview_.template begin<0>(); iter!=gridview_.template end<0>(); ++iter)
{
const IdType id = globalIdSet.id(*iter); /** retrieve the entity's id */
/** if the entity is owned by the process, go ahead with computing the global index */
if (iter->partitionType() == Dune::InteriorEntity)
{
const Index gindex = myoffset + globalcontrib; /** compute global index */
globalIndex_[id] = gindex; /** insert pair (key, datum) into the map */
globalcontrib++; /** increment contribution to global index */
}
/** if entity is not owned, insert -1 to signal not yet calculated global index */
else
{
globalIndex_[id] = -1; /** insert pair (key, datum) into the map */
}
}
}
else // if (codim==0) else
{
std::vector<bool> firstTime(gridview_.size(codim_));
std::fill(firstTime.begin(), firstTime.end(), true);
for(Iterator iter = gridview_.template begin<0>();iter!=gridview_.template end<0>(); ++iter)
{
for (size_t i=0; i<iter->subEntities(codim_); i++)
{
IdType id=globalIdSet.subId(*iter,i,codim_);
Index idx = gridview_.indexSet().subIndex(*iter,i,codim_);
if (!firstTime[idx] )
continue;
firstTime[idx] = false;
if (uniqueEntityPartition->owner(idx) == rank) /** if the entity is owned by the process, go ahead with computing the global index */
{
const Index gindex = myoffset + globalcontrib; /** compute global index */
globalIndex_.insert(std::make_pair(id,gindex)); /** insert pair (key, value) into the map */
const Index lindex = idx;
localGlobalMap_[lindex] = gindex;
globalcontrib++; /** increment contribution to global index */
}
else /** if entity is not owned, insert -1 to signal not yet calculated global index */
{
globalIndex_.insert(std::make_pair(id,-1));
}
}
}
}
// 2nd stage of global index calculation: communicate global index for non-owned entities
// Create the data handle and communicate.
IndexExchange dataHandle(globalIdSet,globalIndex_,indexSet,localGlobalMap_,codim_);
gridview_.communicate(dataHandle, Dune::All_All_Interface, Dune::ForwardCommunication);
}
/** \brief Return the global index of a given entity */
template <class Entity>
Index index(const Entity& entity) const
{
if (codim_==0)
{
/** global unique index is only applicable for inter or border type entities */
const GlobalIdSet& globalIdSet = gridview_.grid().globalIdSet(); /** retrieve globally unique Id set */
const IdType id = globalIdSet.id(entity); /** obtain the entity's id */
const Index gindex = globalIndex_.find(id)->second; /** retrieve the global index in the map with the id as key */
return gindex;
}
else
return localGlobalMap_.find(gridview_.indexSet().index(entity))->second;
}
/** \brief Return the global index of a subentity of a given entity
*
* \param i Number of the requested subentity among all subentities of the given codimension
* \param codim Codimension of the requested subentity
*/
template <class Entity>
Index subIndex(const Entity& entity, unsigned int i, unsigned int codim) const
{
if (codim_==0)
{
/** global unique index is only applicable for inter or border type entities */
const GlobalIdSet& globalIdSet = gridview_.grid().globalIdSet(); /** retrieve globally unique Id set */
const IdType id = globalIdSet.subId(entity,i,codim); /** obtain the entity's id */
const Index gindex = globalIndex_.find(id)->second; /** retrieve the global index in the map with the id as key */
return gindex;
}
else
return localGlobalMap_.find(gridview_.indexSet().subIndex(entity,i,codim))->second;
}
/** \brief Return the total number of entities over all processes that we have indices for
*
* \param codim If this matches GlobalIndexSet codimension, the number of entities is returned.
* Otherwise, zero is returned.
*/
unsigned int size(unsigned int codim) const
{
return (codim_==codim) ? nGlobalEntity_ : 0;
}
protected:
const GridView gridview_;
/** \brief Codimension of the entities that we hold indices for */
unsigned int codim_;
//! Global number of entities, i.e. number of entities without rendundant entities on interprocessor boundaries
int nGlobalEntity_;
IndexMap localGlobalMap_;
/** \brief Stores global index of entities with entity's globally unique id as key
*/
MapId2Index globalIndex_;
};
} // namespace Dune
#endif /* DUNE_GRID_UTILITY_GLOBALINDEXSET_HH */
|