/usr/include/dune/grid/uggrid.hh is in libdune-grid-dev 2.4.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 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 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 612 613 614 615 616 617 618 619 620 621 622 623 624 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 650 651 652 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 680 681 682 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 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 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 980 981 982 983 984 985 986 987 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 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_UGGRID_HH
#define DUNE_UGGRID_HH
/** \file
* \brief The UGGrid class
*/
#include <dune/common/classname.hh>
#include <dune/common/parallel/collectivecommunication.hh>
#include <dune/common/exceptions.hh>
#include <dune/common/parallel/mpihelper.hh>
#include <dune/common/deprecated.hh>
#include <dune/grid/common/boundarysegment.hh>
#include <dune/grid/common/capabilities.hh>
#include <dune/grid/common/grid.hh>
#if HAVE_UG || DOXYGEN
#ifdef ModelP
#include <dune/common/parallel/mpicollectivecommunication.hh>
#endif
/* The following lines including the necessary UG headers are somewhat
tricky. Here's what's happening:
UG can support two- and three-dimensional grids. You choose be setting
either _2 oder _3 while compiling. This changes all sorts of stuff, in
particular data structures in the headers.
UG was never supposed to provide 2d and 3d grids at the same time.
However, when compiling it as c++, the dimension-dependent parts are
wrapped up cleanly in the namespaces UG::D2 and UG::D3, respectively. That
way it is possible to link together the UG lib for 2d and the one for 3d.
But we also need the headers twice! Once with _2 set and once with _3!
So here we go:*/
/* The following define tells the UG headers that we want access to a few
special fields, for example the extra index fields in the element data structures. */
#define FOR_DUNE
// Set UG's space-dimension flag to 2d
#define _2
// And include all necessary UG headers
#include "uggrid/ugincludes.hh"
// Wrap a few large UG macros by functions before they get undef'ed away.
// Here: The 2d-version of the macros
#define UG_DIM 2
#include "uggrid/ugwrapper.hh"
#undef UG_DIM
// UG defines a whole load of preprocessor macros. ug_undefs.hh undefines
// them all, so we don't get name clashes.
#include "uggrid/ug_undefs.hh"
#undef _2
/* Now we're done with 2d, and we can do the whole thing over again for 3d */
/* All macros set by UG have been unset. This includes the macros that ensure
single inclusion of headers. We can thus include them again. However, we
only want to include those headers again that contain dimension-dependent stuff.
Therefore, we set a few single-inclusion defines manually before including
ugincludes.hh again.
*/
#define UGTYPES_H
#define __HEAPS__
#define __UGENV__
#define __DEVICESH__
#ifdef ModelP
#define __PPIF__
#endif
#define _3
#include "uggrid/ugincludes.hh"
// Wrap a few large UG macros by functions before they get undef'ed away.
// This time it's the 3d-versions.
#define UG_DIM 3
#include "uggrid/ugwrapper.hh"
#undef UG_DIM
// undef all macros defined by UG
#include "uggrid/ug_undefs.hh"
#undef _3
#undef FOR_DUNE
// The components of the UGGrid interface
#include "uggrid/uggridgeometry.hh"
#include "uggrid/uggridlocalgeometry.hh"
#include "uggrid/uggridentity.hh"
#include "uggrid/uggridentitypointer.hh"
#include "uggrid/uggridentityseed.hh"
#include "uggrid/uggridintersections.hh"
#include "uggrid/uggridintersectioniterators.hh"
#include "uggrid/uggridleveliterator.hh"
#include "uggrid/uggridleafiterator.hh"
#include "uggrid/uggridhieriterator.hh"
#include "uggrid/uggridindexsets.hh"
#include <dune/grid/uggrid/uggridviews.hh>
#ifdef ModelP
#include "uggrid/ugmessagebuffer.hh"
#include "uggrid/uglbgatherscatter.hh"
#endif
// Not needed here, but included for user convenience
#include "uggrid/uggridfactory.hh"
#ifdef ModelP
template <class DataHandle, int GridDim, int codim>
DataHandle *Dune::UGMessageBufferBase<DataHandle,GridDim,codim>::duneDataHandle_ = 0;
template <class DataHandle, int GridDim, int codim>
int Dune::UGMessageBufferBase<DataHandle,GridDim,codim>::level = -1;
#endif // ModelP
namespace Dune {
#ifdef ModelP
template <int dim>
class CollectiveCommunication<Dune::UGGrid<dim> > :
public CollectiveCommunication< Dune::MPIHelper::MPICommunicator >
{
typedef CollectiveCommunication< Dune::MPIHelper::MPICommunicator > ParentType;
public:
CollectiveCommunication()
: ParentType(MPIHelper::getCommunicator())
{}
};
#endif // ModelP
template<int dim>
struct UGGridFamily
{
typedef GridTraits<dim,dim,Dune::UGGrid<dim>,
UGGridGeometry,
UGGridEntity,
UGGridEntityPointer,
UGGridLevelIterator,
UGGridLeafIntersection,
UGGridLevelIntersection,
UGGridLeafIntersectionIterator,
UGGridLevelIntersectionIterator,
UGGridHierarchicIterator,
UGGridLeafIterator,
UGGridLevelIndexSet< const UGGrid<dim> >,
UGGridLeafIndexSet< const UGGrid<dim> >,
UGGridIdSet< const UGGrid<dim> >,
typename UG_NS<dim>::UG_ID_TYPE,
UGGridIdSet< const UGGrid<dim> >,
typename UG_NS<dim>::UG_ID_TYPE,
CollectiveCommunication<Dune::UGGrid<dim> >,
UGGridLevelGridViewTraits,
UGGridLeafGridViewTraits,
UGGridEntitySeed,
UGGridLocalGeometry>
Traits;
};
//**********************************************************************
//
// --UGGrid
//
//**********************************************************************
/**
\brief Front-end for the grid manager of the finite element toolbox
<a href="http://www.iwr.uni-heidelberg.de/frame/iwrwikiequipment/software/ug">UG</a>.
\ingroup GridImplementations
This is the implementation of the grid interface
using the UG grid management system (http://www.iwr.uni-heidelberg.de/frame/iwrwikiequipment/software/ug).
UG provides conforming grids
in two and three space dimensions. The grids can be mixed, i.e.
2d grids can contain triangles and quadrilaterals and 3d grids can
contain tetrahedra and hexahedra and also pyramids and prisms.
The grid refinement rules are very flexible. Local adaptive red/green
refinement is the default, but a special method in the UGGrid class
allows you to directly access a number of anisotropic refinements rules.
Last but not least, the UG grid manager is completely parallelized,
and you can use boundaries parametrized by either analytical expressions
or high-resolution piecewise linear surfaces.
To use this module you need the UG library. See the
DUNE installation notes
on how to obtain and install it.
In your %Dune application, you can now instantiate objects of the
type UGGrid<2> or UGGrid<3>. You can have more than one, if
you choose. It is even possible to have 2d and 3d grids at the same
time, even though the original UG system never intended to support
this!
See the documentation for the factory class GridFactory<UGGrid<dimworld> >
to learn how to create UGGrid objects.
Please send any questions, suggestions, or bug reports to the Dune mailing list
dune@dune-project.org
For installation instructions see http://www.dune-project.org/external_libraries/install_ug.html .
*/
template <int dim>
class UGGrid : public GridDefaultImplementation <dim, dim, double, UGGridFamily<dim> >
{
typedef GridDefaultImplementation <dim, dim, double, UGGridFamily<dim> > Base;
friend class UGGridGeometry<0,dim,const UGGrid<dim> >;
friend class UGGridGeometry<dim,dim,const UGGrid<dim> >;
friend class UGGridGeometry<1,2,const UGGrid<dim> >;
friend class UGGridGeometry<2,3,const UGGrid<dim> >;
friend class UGGridEntity <0,dim,const UGGrid<dim> >;
friend class UGGridEntity <dim,dim,const UGGrid<dim> >;
friend class UGGridHierarchicIterator<const UGGrid<dim> >;
friend class UGGridLeafIntersection<const UGGrid<dim> >;
friend class UGGridLevelIntersection<const UGGrid<dim> >;
friend class UGGridLeafIntersectionIterator<const UGGrid<dim> >;
friend class UGGridLevelIntersectionIterator<const UGGrid<dim> >;
friend class UGGridLevelIndexSet<const UGGrid<dim> >;
friend class UGGridLeafIndexSet<const UGGrid<dim> >;
friend class UGGridIdSet<const UGGrid<dim> >;
template <class GridImp_, PartitionIteratorType PiType_>
friend class UGGridLeafGridView;
template <class GridImp_, PartitionIteratorType PiType_>
friend class UGGridLevelGridView;
friend class GridFactory<UGGrid<dim> >;
#ifdef ModelP
friend class UGLBGatherScatter;
#endif
template <int codim_, PartitionIteratorType PiType_, class GridImp_>
friend class UGGridLeafIterator;
template <int codim_, PartitionIteratorType PiType_, class GridImp_>
friend class UGGridLevelIterator;
template <int codim_, class GridImp_>
friend class UGGridEntityPointer;
/** \brief UGGrid is only implemented for 2 and 3 dimension */
static_assert(dim==2 || dim==3, "Use UGGrid only for 2d and 3d!");
// The different instantiations are mutual friends so they can access
// each others numOfUGGrids field
friend class UGGrid<2>;
friend class UGGrid<3>;
//**********************************************************
// The Interface Methods
//**********************************************************
public:
//! type of the used GridFamily for this grid
typedef UGGridFamily<dim> GridFamily;
// the Traits
typedef typename UGGridFamily<dim>::Traits Traits;
//! The type used to store coordinates
typedef UG::DOUBLE ctype;
/** \brief Default constructor
*
* Uses the default heapsize, which can be set using the static method
* setDefaultHeapSize().
*/
UGGrid();
//! Destructor
~UGGrid()
#if HAVE_NOEXCEPT_SPECIFIER
noexcept(false)
#endif
;
//! Return maximum level defined in this grid. Levels are numbered
//! 0 ... maxlevel with 0 the coarsest level.
int maxLevel() const;
//! Iterator to first entity of given codim on level
template<int codim>
typename Traits::template Codim<codim>::LevelIterator lbegin (int level) const;
//! one past the end on this level
template<int codim>
typename Traits::template Codim<codim>::LevelIterator lend (int level) const;
//! Iterator to first entity of given codim on level
template<int codim, PartitionIteratorType PiType>
typename Traits::template Codim<codim>::template Partition<PiType>::LevelIterator lbegin (int level) const;
//! one past the end on this level
template<int codim, PartitionIteratorType PiType>
typename Traits::template Codim<codim>::template Partition<PiType>::LevelIterator lend (int level) const;
//! Iterator to first leaf entity of given codim
template<int codim>
typename Traits::template Codim<codim>::LeafIterator leafbegin() const {
return typename Traits::template Codim<codim>::template Partition<All_Partition>::LeafIterator(*this);
}
//! one past the end of the sequence of leaf entities
template<int codim>
typename Traits::template Codim<codim>::LeafIterator leafend() const {
return UGGridLeafIterator<codim,All_Partition, const UGGrid<dim> >();
}
//! Iterator to first leaf entity of given codim
template<int codim, PartitionIteratorType PiType>
typename Traits::template Codim<codim>::template Partition<PiType>::LeafIterator leafbegin() const {
return typename Traits::template Codim<codim>::template Partition<PiType>::LeafIterator(*this);
}
//! one past the end of the sequence of leaf entities
template<int codim, PartitionIteratorType PiType>
typename Traits::template Codim<codim>::template Partition<PiType>::LeafIterator leafend() const {
return UGGridLeafIterator<codim,PiType, const UGGrid<dim> >();
}
/** \brief Create an EntityPointer from an EntitySeed */
template <typename Seed>
DUNE_DEPRECATED_MSG("entityPointer() is deprecated and will be removed after the release of dune-grid 2.4. Use entity() instead to directly obtain an Entity object.")
typename Traits::template Codim<Seed::codimension>::EntityPointer
entityPointer(const Seed& seed) const
{
enum {codim = Seed::codimension};
return typename Traits::template Codim<codim>::EntityPointer(UGGridEntityPointer<codim,const UGGrid<dim> >(this->getRealImplementation(seed).target(),this));
}
/** \brief Create an Entity from an EntitySeed */
template <typename Seed>
typename Traits::template Codim<Seed::codimension>::Entity
entity(const Seed& seed) const
{
const int codim = Seed::codimension;
return typename Traits::template Codim<codim>::Entity(UGGridEntity<codim,dim,const UGGrid<dim> >(this->getRealImplementation(seed).target(),this));
}
/** \brief Number of grid entities per level and codim
*/
int size (int level, int codim) const;
//! number of leaf entities per codim in this process
int size (int codim) const
{
return leafIndexSet().size(codim);
}
//! number of entities per level and geometry type in this process
int size (int level, GeometryType type) const
{
return this->levelIndexSet(level).size(type);
}
//! number of leaf entities per geometry type in this process
int size (GeometryType type) const
{
return this->leafIndexSet().size(type);
}
/** \brief Return the number of boundary segments */
size_t numBoundarySegments() const {
// The number is stored as a member of UGGrid upon grid creation.
// The corresponding data structure is not exported by UG. (It is in ug/dom/std/std_internal.h)
return numBoundarySegments_;
}
/** \brief Access to the GlobalIdSet */
const typename Traits::GlobalIdSet& globalIdSet() const
{
return idSet_;
}
/** \brief Access to the LocalIdSet */
const typename Traits::LocalIdSet& localIdSet() const
{
return idSet_;
}
/** \brief Access to the LevelIndexSets */
const typename Traits::LevelIndexSet& levelIndexSet(int level) const
{
if (level<0 || level>maxLevel())
DUNE_THROW(GridError, "levelIndexSet of nonexisting level " << level << " requested!");
return *levelIndexSets_[level];
}
/** \brief Access to the LeafIndexSet */
const typename Traits::LeafIndexSet& leafIndexSet() const
{
return leafIndexSet_;
}
/** @name Grid Refinement Methods */
/*@{*/
/** \brief Mark element for refinement
\param refCount <ul>
<li> 1: mark for red refinement </li>
<li> -1: mark for coarsening </li>
<li> 0: delete a possible refinement mark </li>
</ul>
\param e Element to be marked
\return <ul>
<li> true, if element was marked </li>
<li> false, if nothing changed </li>
</ul>
*/
bool mark(int refCount, const typename Traits::template Codim<0>::Entity & e );
/** \brief Mark method accepting a UG refinement rule
\param e Pointer to the element to be marked for refinement
\param rule One of the UG refinement rules
\param side If rule==UG::%D2::%BLUE (one quadrilateral is split into two rectangles)
you can choose the orientation of the cut by setting side==0 or side==1
The available values for RefinementRule are: (see the RefinementRule enum in ug/gm/gm.h)
<h3>2D</h3>
- NO_REFINEMENT
- COPY
- RED
- BLUE
- COARSE
- BISECTION_1
- BISECTION_2_Q
- BISECTION_2_T1
- BISECTION_2_T2
- BISECTION_3
<h3>3D</h3>
- NO_REFINEMENT
- COPY
- RED
- BLUE
- COARSE
- TETRA_RED_HEX
- PRISM_BISECT_1_2
- PRISM_QUADSECT
- PRISM_BISECT_HEX0
- PRISM_BISECT_HEX1
- PRISM_BISECT_HEX2
- PRISM_ROTATE_LEFT
- PRISM_ROTATE_RGHT
- PRISM_QUADSECT_HEXPRI0
- PRISM_RED_HEX
- PRISM_BISECT_0_1
- PRISM_BISECT_0_2
- PRISM_BISECT_0_3
- HEX_BISECT_0_1
- HEX_BISECT_0_2
- HEX_BISECT_0_3
- HEX_TRISECT_0
- HEX_TRISECT_5
- HEX_QUADSECT_0
- HEX_QUADSECT_1
- HEX_QUADSECT_2
- HEX_BISECT_HEXPRI0
- HEX_BISECT_HEXPRI1
*/
bool mark(const typename Traits::template Codim<0>::Entity & e,
typename UG_NS<dim>::RefinementRule rule,
int side=0);
/** \brief Query whether element is marked for refinement */
int getMark(const typename Traits::template Codim<0>::Entity& e) const;
/** \brief returns true, if some elements might be coarsend during grid
adaption, here always returns true */
bool preAdapt();
//! Triggers the grid refinement process
bool adapt();
/** \brief Clean up refinement markers */
void postAdapt();
/*@}*/
/** \brief Size of the overlap on the leaf level */
unsigned int overlapSize(int codim) const {
return 0;
}
/** \brief Size of the ghost cell layer on the leaf level */
unsigned int ghostSize(int codim) const {
return (codim==0) ? 1 : 0;
}
/** \brief Size of the overlap on a given level */
unsigned int overlapSize(int level, int codim) const {
return 0;
}
/** \brief Size of the ghost cell layer on a given level */
unsigned int ghostSize(int level, int codim) const {
return (codim==0) ? 1 : 0;
}
/** \brief Distributes the grid and some data over the available nodes in a distributed machine
\tparam DataHandle works like the data handle for the communicate
methods.
\return True, if grid has changed, false otherwise
*/
template<class DataHandle>
bool loadBalance (DataHandle& dataHandle)
{
#ifdef ModelP
// gather element data
// UGLBGatherScatter::template gather<0>(this->leafGridView(), dataHandle);
// gather node data
UGLBGatherScatter::template gather<dim>(this->leafGridView(), dataHandle);
#endif
// the load balancing step now also attaches
// the data to the entities and distributes it
loadBalance();
#ifdef ModelP
// scatter element data
// UGLBGatherScatter::template scatter<0>(this->leafGridView(), dataHandle);
// scatter node data
UGLBGatherScatter::template scatter<dim>(this->leafGridView(), dataHandle);
#endif
return true;
}
/** \brief Distributes this grid over the available nodes in a distributed machine
\bug The return value is always 'true'
\param minlevel The coarsest grid level that gets distributed
*/
bool loadBalance(int minlevel=0);
/** \brief Distribute this grid over a distributed machine
*
* \param[in] targetProcessors For each leaf element the rank of the process the element shall be sent to
* \param[in] fromLevel The lowest level that gets redistributed (set to 0 when in doubt)
*
* This method allows to (re-)distribute the grid controlled by an external grid repartitioning library.
* You need to get that library to assign a target rank to each interior element in the leaf grid. With this
* information in a std::vector, call this method, and UG will do the actual repartitioning.
* Each leaf element will be sent to the assigned target rank. For all other elements we look at
* where there children are being sent to. The parent is then sent to where most of its children are
* (Familienzusammenfuehrung).
*
* The size of the input array targetProcessors is expected to be equal to the number of elements in
* the 'all'-partition, i.e., the number Interior elements plus the number of Ghost elements.
* To get the array entry corresponding to an Interior element, a MultipleCodimMultipleGeomTypeMapper
* with layout class MCMGElementLayout is used. Array entries corresponding to Ghost elements are ignored.
*
* In some cases you may also want to leave the lowest levels on one process, to have them all together
* for multigrid coarse grid corrections. In that case, use the fromLevel parameter with a value other
* than zero, to redistribute only elements above a certain level.
*
* The fromLevel argument is also needed to allow the compiler to distinguish this method from
* the loadBalance method with a single template DataHandle argument.
*
* \note In theory you can assign a target rank to any element on any level, and UG will magically transfer
* the element to that rank and make everything come out right. This is not supported by the UGGrid interface,
* because I didn't see a use case for it. If you do need it please ask on the Dune mailing list.
*
* \return true
*/
bool loadBalance(const std::vector<unsigned int>& targetProcessors, unsigned int fromLevel);
/** \brief Distributes the grid over the processes of a parallel machine, and sends data along with it
*
* \param[in] targetProcessors For each leaf element the rank of the process the element shall be sent to
* \param[in] fromLevel The lowest level that gets redistributed (set to 0 when in doubt)
* \param[in,out] dataHandle A data handle object that does the gathering and scattering of data
* \tparam DataHandle works like the data handle for the communicate methods.
*
* \return true
*/
template<class DataHandle>
bool loadBalance (const std::vector<unsigned int>& targetProcessors, unsigned int fromLevel, DataHandle& dataHandle)
{
#ifdef ModelP
// gather element data
// UGLBGatherScatter::template gather<0>(this->leafGridView(), dataHandle);
// gather node data
UGLBGatherScatter::template gather<dim>(this->leafGridView(), dataHandle);
#endif
// the load balancing step now also attaches
// the data to the entities and distributes it
loadBalance(targetProcessors,fromLevel);
#ifdef ModelP
// scatter element data
// UGLBGatherScatter::template scatter<0>(this->leafGridView(), dataHandle);
// scatter node data
UGLBGatherScatter::template scatter<dim>(this->leafGridView(), dataHandle);
#endif
return true;
}
/** \brief The communication interface for all codims on a given level
@param dataHandle type used to gather/scatter data in and out of the message buffer
@param iftype one of the predifined interface types, throws error if it is not implemented
@param dir choose beetween forward and backward communication
@param level communicate for entities on the given level
Implements a generic communication function sending an object of type P for each entity
in the intersection of two processors. P has two methods gather and scatter that implement
the protocol. Therefore P is called the "protocol class".
*/
template<class DataHandle>
void communicate (DataHandle& dataHandle, InterfaceType iftype, CommunicationDirection dir, int level) const
{
#ifdef ModelP
typedef typename UGGrid::LevelGridView LevelGridView;
for (int curCodim = 0; curCodim <= dim; ++curCodim) {
if (!dataHandle.contains(dim, curCodim))
continue;
if (curCodim == 0)
communicateUG_<LevelGridView, DataHandle, 0>(this->levelGridView(level), level, dataHandle, iftype, dir);
else if (curCodim == dim)
communicateUG_<LevelGridView, DataHandle, dim>(this->levelGridView(level), level, dataHandle, iftype, dir);
else if (curCodim == dim - 1)
communicateUG_<LevelGridView, DataHandle, dim-1>(this->levelGridView(level), level, dataHandle, iftype, dir);
else if (curCodim == 1)
communicateUG_<LevelGridView, DataHandle, 1>(this->levelGridView(level), level, dataHandle, iftype, dir);
else
DUNE_THROW(NotImplemented,
className(*this) << "::communicate(): Not "
"supported for dim " << dim << " and codim " << curCodim);
}
#endif // ModelP
}
/** \brief The communication interface for all codims on the leaf level
@param dataHandle type used to gather/scatter data in and out of the message buffer
@param iftype one of the predifined interface types, throws error if it is not implemented
@param dir choose beetween forward and backward communication
Implements a generic communication function sending an object of type P for each entity
in the intersection of two processors. P has two methods gather and scatter that implement
the protocol. Therefore P is called the "protocol class".
*/
template<class DataHandle>
void communicate(DataHandle& dataHandle, InterfaceType iftype, CommunicationDirection dir) const
{
#ifdef ModelP
typedef typename UGGrid::LeafGridView LeafGridView;
for (int curCodim = 0; curCodim <= dim; ++curCodim) {
if (!dataHandle.contains(dim, curCodim))
continue;
int level = -1;
if (curCodim == 0)
communicateUG_<LeafGridView, DataHandle, 0>(this->leafGridView(), level, dataHandle, iftype, dir);
else if (curCodim == dim)
communicateUG_<LeafGridView, DataHandle, dim>(this->leafGridView(), level, dataHandle, iftype, dir);
else if (curCodim == dim - 1)
communicateUG_<LeafGridView, DataHandle, dim-1>(this->leafGridView(), level, dataHandle, iftype, dir);
else if (curCodim == 1)
communicateUG_<LeafGridView, DataHandle, 1>(this->leafGridView(), level, dataHandle, iftype, dir);
else
DUNE_THROW(NotImplemented,
className(*this) << "::communicate(): Not "
"supported for dim " << dim << " and codim " << curCodim);
}
#endif // ModelP
}
/** the collective communication */
const CollectiveCommunication<UGGrid>& comm () const
{
return ccobj_;
}
protected:
#ifdef ModelP
template <class GridView, class DataHandle, int codim>
void communicateUG_(const GridView& gv, int level,
DataHandle &dataHandle,
InterfaceType iftype,
CommunicationDirection dir) const
{
typename UG_NS<dim>::DDD_IF_DIR ugIfDir;
// Translate the communication direction from Dune-Speak to UG-Speak
if (dir==ForwardCommunication)
ugIfDir = UG_NS<dim>::IF_FORWARD();
else
ugIfDir = UG_NS<dim>::IF_BACKWARD();
typedef UGMessageBuffer<DataHandle,dim,codim> UGMsgBuf;
UGMsgBuf::duneDataHandle_ = &dataHandle;
UGMsgBuf::level = level;
std::vector<typename UG_NS<dim>::DDD_IF> ugIfs;
findDDDInterfaces_(ugIfs, iftype, codim);
unsigned bufSize = UGMsgBuf::ugBufferSize_(gv);
if (!bufSize)
return; // we don't need to communicate if we don't have any data!
for (unsigned i=0; i < ugIfs.size(); ++i)
UG_NS<dim>::DDD_IFOneway(ugIfs[i],
ugIfDir,
bufSize,
&UGMsgBuf::ugGather_,
&UGMsgBuf::ugScatter_);
}
void findDDDInterfaces_(std::vector<typename UG_NS<dim>::DDD_IF > &dddIfaces,
InterfaceType iftype,
int codim) const
{
dddIfaces.clear();
if (codim == 0)
{
switch (iftype) {
case InteriorBorder_InteriorBorder_Interface :
// do not communicate anything: Elements can not be in
// the interior of two processes at the same time
return;
case InteriorBorder_All_Interface :
// The communicated elements are in the sender's
// interior and it does not matter what they are for
// the receiver
dddIfaces.push_back(UG_NS<dim>::ElementVHIF());
return;
case All_All_Interface :
// It does neither matter what the communicated
// elements are for sender nor for the receiver. If
// they are seen by these two processes, data is send
// and received.
dddIfaces.push_back(UG_NS<dim>::ElementSymmVHIF());
return;
default :
DUNE_THROW(GridError,
"Element communication not supported for "
"interfaces of type "
<< iftype);
}
}
else if (codim == dim)
{
switch (iftype)
{
case InteriorBorder_InteriorBorder_Interface :
dddIfaces.push_back(UG_NS<dim>::BorderNodeSymmIF());
return;
case InteriorBorder_All_Interface :
dddIfaces.push_back(UG_NS<dim>::BorderNodeSymmIF());
dddIfaces.push_back(UG_NS<dim>::NodeIF());
return;
case All_All_Interface :
dddIfaces.push_back(UG_NS<dim>::NodeAllIF());
return;
default :
DUNE_THROW(GridError,
"Node communication not supported for "
"interfaces of type "
<< iftype);
}
}
else if (codim == dim-1)
{
switch (iftype)
{
case InteriorBorder_InteriorBorder_Interface :
dddIfaces.push_back(UG_NS<dim>::BorderEdgeSymmIF());
return;
case InteriorBorder_All_Interface :
dddIfaces.push_back(UG_NS<dim>::BorderEdgeSymmIF());
// Is the following line needed or not?
// dddIfaces.push_back(UG_NS<dim>::EdgeIF());
return;
case All_All_Interface :
dddIfaces.push_back(UG_NS<dim>::EdgeSymmVHIF());
return;
default :
DUNE_THROW(GridError,
"Edge communication not supported for "
"interfaces of type "
<< iftype);
}
}
else if (codim == 1)
{
switch (iftype)
{
case InteriorBorder_InteriorBorder_Interface :
case InteriorBorder_All_Interface :
dddIfaces.push_back(UG_NS<dim>::BorderVectorSymmIF());
return;
default :
DUNE_THROW(GridError,
"Face communication not supported for "
"interfaces of type "
<< iftype);
}
}
else
{
DUNE_THROW(GridError,
"Communication for codim "
<< codim
<< " entities is not yet supported "
<< " by the DUNE UGGrid interface!");
}
};
#endif // ModelP
public:
// **********************************************************
// End of Interface Methods
// **********************************************************
#ifdef DOXYGEN
/** \brief Rudimentary substitute for a hierarchic iterator on faces
\param e, elementSide Grid face specified by an element and one of its sides
\param maxl The finest level that should be traversed by the iterator
\param[out] childElements For each subface: element index, elementSide, and level
\param[out] childElementSides Indices for transformation because Dune numbers the
faces of several elements differently than UG
\deprecated This method is deprecated and will be removed after the release of Dune
2.4. Please use the corresponding method that uses entities instead of
EntityPointers.
*/
void getChildrenOfSubface(const typename Traits::template Codim<0>::EntityPointer & e,
int elementSide,
int maxl,
std::vector<typename Traits::template Codim<0>::EntityPointer>& childElements,
std::vector<unsigned char>& childElementSides) const;
#else
// This is the actual implementation of the deprecated method. We need this ugly trick of turning
// it into a template to avoid triggering a deprecation warning every time UGGrid is used.
template< typename T >
DUNE_DEPRECATED_MSG("This version of getChildrenOfSubface() uses EntityPointer and is deprecated. It will be removed after the release of Dune 2.4. Please use the new version with entities instead.")
typename std::enable_if<
std::is_same<
T,
typename UGGrid<dim>::Traits::template Codim<0>::EntityPointer
>::value
>::type
getChildrenOfSubface(const T & e,
int elementSide,
int maxl,
std::vector<typename Traits::template Codim<0>::EntityPointer>& childElements,
std::vector<unsigned char>& childElementSides) const
{
typedef std::pair<typename UG_NS<dim>::Element*,int> ListEntryType;
SLList<ListEntryType> list;
// //////////////////////////////////////////////////////////////////////
// Change the input face number from Dune numbering to UG numbering
// //////////////////////////////////////////////////////////////////////
elementSide = UGGridRenumberer<dim>::facesDUNEtoUG(elementSide, e->type());
// ///////////////
// init list
// ///////////////
if (!e->isLeaf() // Get_Sons_of_ElementSide returns GM_FATAL when called for a leaf !?!
&& e->level() < maxl) {
typename UG_NS<dim>::Element* theElement = this->getRealImplementation(*e).target_;
int Sons_of_Side = 0;
typename UG_NS<dim>::Element* SonList[UG_NS<dim>::MAX_SONS];
int SonSides[UG_NS<dim>::MAX_SONS];
int rv = Get_Sons_of_ElementSide(theElement,
elementSide,
&Sons_of_Side,
SonList, // the output elements
SonSides, // Output element side numbers
true, // Element sons are not precomputed
true); // ioflag: I have no idea what this is supposed to do
if (rv!=0)
DUNE_THROW(GridError, "Get_Sons_of_ElementSide returned with error value " << rv);
for (int i=0; i<Sons_of_Side; i++)
list.push_back(ListEntryType(SonList[i],SonSides[i]));
}
// //////////////////////////////////////////////////
// Traverse and collect all children of the side
// //////////////////////////////////////////////////
typename SLList<ListEntryType>::iterator f = list.begin();
for (; f!=list.end(); ++f) {
typename UG_NS<dim>::Element* theElement = f->first;
int side = f->second;
int Sons_of_Side = 0;
typename UG_NS<dim>::Element* SonList[UG_NS<dim>::MAX_SONS];
int SonSides[UG_NS<dim>::MAX_SONS];
if (UG_NS<dim>::myLevel(theElement) < maxl) {
Get_Sons_of_ElementSide(theElement,
side, // Input element side number
&Sons_of_Side, // Number of topological sons of the element side
SonList, // Output elements
SonSides, // Output element side numbers
true,
true);
for (int i=0; i<Sons_of_Side; i++)
list.push_back(ListEntryType(SonList[i],SonSides[i]));
}
}
// //////////////////////////////
// Extract result from stack
// //////////////////////////////
// Use reserve / push_back since EntityPointer is not default constructable
childElements.clear();
childElements.reserve( list.size() );
childElementSides.resize(list.size());
int i=0;
for (f = list.begin(); f!=list.end(); ++f, ++i)
{
// Set element
typedef typename Traits::template Codim< 0 >::EntityPointer EntityPointer;
childElements.push_back( EntityPointer( UGGridEntityPointer< 0, const UGGrid< dim > >( f->first, this ) ) );
int side = f->second;
// Dune numbers the faces of several elements differently than UG.
// The following switch does the transformation
childElementSides[i] = UGGridRenumberer<dim>::facesUGtoDUNE(side, childElements[i]->type());
}
}
#endif
/** \brief Rudimentary substitute for a hierarchic iterator on faces
\param e, elementSide Grid face specified by an element and one of its sides
\param maxl The finest level that should be traversed by the iterator
\param[out] childElements For each subface: element index, elementSide, and level
\param[out] childElementSides Indices for transformation because Dune numbers the
faces of several elements differently than UG
*/
void getChildrenOfSubface(const typename Traits::template Codim<0>::Entity & e,
int elementSide,
int maxl,
std::vector<typename Traits::template Codim<0>::Entity>& childElements,
std::vector<unsigned char>& childElementSides) const;
/** \brief The different forms of grid refinement that UG supports */
enum RefinementType {
/** \brief New level consists only of the refined elements and the closure*/
LOCAL,
/** \brief New level consists of the refined elements and the unrefined ones, too */
COPY
};
/** \brief Decide whether to add a green closure to locally refined grid sections or not */
enum ClosureType {
/** \brief Standard red/green refinement */
GREEN,
/** \brief No closure, results in nonconforming meshes */
NONE
};
/** \brief Sets the type of grid refinement */
void setRefinementType(RefinementType type) {
refinementType_ = type;
}
/** \brief Sets the type of grid refinement closure */
void setClosureType(ClosureType type) {
closureType_ = type;
}
/** \brief Sets the default heap size
*
* UGGrid keeps an internal heap to allocate memory from, which must be
* specified on grid creation (at the latest). This sets the default heap
* size, which is used when no heap size is given to the constructor.
*/
static void setDefaultHeapSize(unsigned size) {
heapSize_ = size;
}
#ifdef DOXYGEN
/** \brief Sets a vertex to a new position
Changing a vertex' position changes its position on all grid levels!
\deprecated This method is deprecated and will be removed after the release of Dune
2.4. Please use the corresponding method that uses entities instead of
EntityPointers.
*/
void setPosition(const typename Traits::template Codim<dim>::EntityPointer& e,
const FieldVector<double, dim>& pos);
#else
// This is the actual implementation of the deprecated method. We need this ugly trick of turning
// it into a template to avoid triggering a deprecation warning every time UGGrid is used.
template< typename T >
DUNE_DEPRECATED_MSG("This version of setPosition() uses EntityPointer and is deprecated. It will be removed after the release of Dune 2.4. Please use the new version with entities instead.")
typename std::enable_if<
std::is_same<
T,
typename UGGrid<dim>::Traits::template Codim<dim>::EntityPointer
>::value
>::type
setPosition(const T& e,
const FieldVector<double, dim>& pos)
{
typename UG_NS<dim>::Node* target = this->getRealImplementation(*e).target_;
for (int i=0; i<dim; i++)
target->myvertex->iv.x[i] = pos[i];
}
#endif
/** \brief Sets a vertex to a new position
Changing a vertex' position changes its position on all grid levels!*/
void setPosition(const typename Traits::template Codim<dim>::Entity& e,
const FieldVector<double, dim>& pos);
/** \brief Does uniform refinement
*
* \param n Number of uniform refinement steps
*/
void globalRefine(int n);
/** \brief Save entire grid hierarchy to disk
Test implementation -- not working!
*/
void saveState(const std::string& filename) const;
/** \brief Read entire grid hierarchy from disk
Test implementation -- not working!
*/
void loadState(const std::string& filename);
private:
/** \brief UG multigrid, which contains the actual grid hierarchy structure */
typename UG_NS<dim>::MultiGrid* multigrid_;
/** \brief The collective communication object. */
CollectiveCommunication<UGGrid> ccobj_;
/** \brief Recomputes entity indices after the grid was changed
\param setLevelZero If this is false, level indices of the level 0 are not touched
\param nodePermutation Permutation array for the vertex level 0 indices. If this is NULL,
the identity is used.
*/
void setIndices(bool setLevelZero,
std::vector<unsigned int>* nodePermutation);
// Each UGGrid object has a unique name to identify it in the
// UG environment structure
std::string name_;
// Our set of level indices
std::vector<shared_ptr<UGGridLevelIndexSet<const UGGrid<dim> > > > levelIndexSets_;
UGGridLeafIndexSet<const UGGrid<dim> > leafIndexSet_;
// One id set implementation
// Used for both the local and the global UGGrid id sets
UGGridIdSet<const UGGrid<dim> > idSet_;
//! The type of grid refinement currently in use
RefinementType refinementType_;
//! The type of grid refinement closure currently in use
ClosureType closureType_;
/** \brief Number of UGGrids currently in use.
*
* This counts the number of UGGrids currently instantiated. All
* constructors of UGGrid look at this variable. If it is zero, they
* initialize UG before proceeding. Destructors use the same mechanism
* to safely shut down UG after deleting the last UGGrid object.
*/
static int numOfUGGrids;
/** \brief Remember whether some element has been marked for refinement
ever since the last call to adapt().
This is here to implement the return value of adapt().
*/
bool someElementHasBeenMarkedForRefinement_;
/** \brief Remember whether some element has been marked for coarsening
ever since the last call to adapt().
This is here to implement the return value of preAdapt().
*/
bool someElementHasBeenMarkedForCoarsening_;
/** \brief The size of UG's internal heap in megabytes
*
* It is handed over to UG for each new multigrid.
*/
static unsigned int heapSize_;
/** \brief The classes implementing the geometry of the boundary segments, if requested */
std::vector<shared_ptr<BoundarySegment<dim> > > boundarySegments_;
/** \brief Overall number of coarse grid boundary segments.
This includes the number of linear segments.
Hence numBoundarySegments_ >= boundarySegments_.size() (greater than or equal)
*/
unsigned int numBoundarySegments_;
}; // end Class UGGrid
namespace Capabilities
{
/** \struct hasEntity
\ingroup UGGrid
*/
/** \struct hasBackupRestoreFacilities
\ingroup UGGrid
*/
/** \struct IsUnstructured
\ingroup UGGrid
*/
/** \brief UGGrid has codim=0 entities (elements)
\ingroup UGGrid
*/
template<int dim>
struct hasEntity< UGGrid<dim>, 0>
{
static const bool v = true;
};
/** \brief UGGrid has codim=dim entities (vertices)
\ingroup UGGrid
*/
template<int dim>
struct hasEntity< UGGrid<dim>, dim>
{
static const bool v = true;
};
/** \brief UGGrid is parallel
\ingroup UGGrid
*/
template<int dim>
struct DUNE_DEPRECATED_MSG("Capabilities::isParallel will be removed after dune-grid-2.4.") isParallel< UGGrid<dim> >
{
#ifdef ModelP
static const bool DUNE_DEPRECATED_MSG("Capabilities::isParallel will be removed after dune-grid-2.4.") v = true;
#else // !ModelP
static const bool DUNE_DEPRECATED_MSG("Capabilities::isParallel will be removed after dune-grid-2.4.") v = false;
#endif // !ModelP
};
/** \brief UGGrid is levelwise conforming
\ingroup UGGrid
*/
template<int dim>
struct isLevelwiseConforming< UGGrid<dim> >
{
static const bool v = true;
};
/** \brief UGGrid may not be leafwise conforming
\ingroup UGGrid
*/
template<int dim>
struct isLeafwiseConforming< UGGrid<dim> >
{
static const bool v = false;
};
}
} // namespace Dune
#endif // HAVE_UG || DOXYGEN
#endif // DUNE_UGGRID_HH
|