/usr/include/dune/grid/uggrid/uggridentity.hh is in libdune-grid-dev 2.2.1-2.
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 | #ifndef DUNE_UGGRIDENTITY_HH
#define DUNE_UGGRIDENTITY_HH
/** \file
* \brief The UGGridEntity class and its specializations
*/
#include <dune/grid/common/gridenums.hh>
#include "uggridrenumberer.hh"
namespace Dune {
// Forward declarations
template<int codim, int dim, class GridImp>
class UGGridEntity;
template<int dim>
class UGGrid;
template<int codim, class GridImp>
class UGGridEntityPointer;
template<int codim, class GridImp>
class UGGridEntitySeed;
template<int codim, PartitionIteratorType pitype, class GridImp>
class UGGridLevelIterator;
template<class GridImp>
class UGGridLevelIntersectionIterator;
template<class GridImp>
class UGGridLeafIntersectionIterator;
template<class GridImp>
class UGGridHierarchicIterator;
template<int codim, int dim, class GridImp>
class UGMakeableEntity :
public GridImp::template Codim<codim>::Entity
{
public:
UGMakeableEntity(typename UG_NS<dim>::template Entity<codim>::T* target, const GridImp* gridImp) :
GridImp::template Codim<codim>::Entity (UGGridEntity<codim, dim, const GridImp>())
{
this->realEntity.setToTarget(target,gridImp);
}
UGMakeableEntity() :
GridImp::template Codim<codim>::Entity (UGGridEntity<codim, dim, const GridImp>())
{}
void setToTarget(typename UG_NS<dim>::template Entity<codim>::T* target, const GridImp* gridImp) {
this->realEntity.setToTarget(target,gridImp);
}
typename UG_NS<dim>::template Entity<codim>::T* getTarget() {
return this->realEntity.target_;
}
};
//**********************************************************************
//
// --UGGridEntity
// --Entity
//
/** \brief The implementation of entities in a UGGrid
\ingroup UGGrid
A Grid is a container of grid entities. An entity is parametrized by the codimension.
An entity of codimension c in dimension d is a d-c dimensional object.
*/
template<int codim, int dim, class GridImp>
class UGGridEntity
{
template <int codim_, PartitionIteratorType PiType_, class GridImp_>
friend class UGGridLevelIterator;
friend class UGMakeableEntity<codim,dim,const UGGrid<dim> >;
friend class UGMakeableEntity<codim,dim,UGGrid<dim> >;
friend class UGGrid<dim>;
template <class GridImp_>
friend class UGGridLevelIndexSet;
template <class GridImp_>
friend class UGGridLeafIndexSet;
template <class GridImp_, bool Local>
friend class UGGridIdSet;
friend class UGGridEntityPointer<codim, GridImp>;
friend class UGGridEntitySeed<codim, GridImp>;
typedef typename GridImp::ctype UGCtype;
typedef typename GridImp::Traits::template Codim<codim>::GeometryImpl GeometryImpl;
public:
UGGridEntity()
{}
typedef typename GridImp::template Codim<codim>::Geometry Geometry;
/** \brief The type of UGGrid Entity seeds */
typedef typename GridImp::Traits::template Codim<codim>::EntitySeed EntitySeed;
//! level of this element
int level () const {
return UG_NS<dim>::myLevel(target_);
}
/** \brief Return the entity type identifier */
GeometryType type() const;
/** \brief The partition type for parallel computing */
PartitionType partitionType () const
{
#ifndef ModelP
return InteriorEntity;
#else
if (codim != dim) {
/** \todo faces (elements and edges are done below) */
return InteriorEntity;
}
typename UG_NS<dim>::Node *node =
static_cast<typename UG_NS<dim>::Node *>(target_);
if (UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioHGhost
|| UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioVGhost
|| UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioVHGhost)
return GhostEntity;
else if (UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioBorder || hasBorderCopy_(node))
return BorderEntity;
else if (UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioMaster || UG_NS<dim>::Priority(node) == UG_NS<dim>::PrioNone)
return InteriorEntity;
else
DUNE_THROW(GridError, "Unknown priority " << UG_NS<dim>::Priority(node));
#endif
}
protected:
#ifdef ModelP
bool hasBorderCopy_(typename UG_NS<dim>::Node *node) const {
int *plist = UG_NS<dim>::DDD_InfoProcList(UG_NS<dim>::ParHdr(node));
for (int i = 0; plist[i] >= 0; i += 2)
if (plist[i + 1] == UG_NS<dim>::PrioBorder)
return true;
return false;
}
#endif
public:
/*! Intra-element access to entities of codimension cc > codim. Return number of entities
with codimension cc.
*/
//!< Default codim 1 Faces and codim == dim Vertices
template<int cc> int count () const;
//! geometry of this entity
Geometry geometry () const { return Geometry( geo_ ); }
/** \brief Get the seed corresponding to this entity */
EntitySeed seed () const { return EntitySeed( *this ); }
private:
/** \brief Set this entity to a particular UG entity */
void setToTarget(typename UG_NS<dim>::template Entity<codim>::T* target,const GridImp* gridImp) {
target_ = target;
geo_.setToTarget(target);
gridImp_ = gridImp;
}
//! the current geometry
GeometryImpl geo_;
typename UG_NS<dim>::template Entity<codim>::T* target_;
/** \brief gridImp Not actually used, only the codim-0 specialization needs it
* But code is simpler if we just keep it everywhere.
*/
const GridImp* gridImp_;
};
/*! \brief Edge entity
* \ingroup UGGrid
*/
template<int dim, class GridImp>
class UGEdgeEntity
{
enum {codim = dim - 1};
template <int codim_, PartitionIteratorType PiType_, class GridImp_>
friend class UGGridLevelIterator;
friend class UGMakeableEntity<codim,dim,const UGGrid<dim> >;
friend class UGMakeableEntity<codim,dim,UGGrid<dim> >;
friend class UGGrid<dim>;
template <class GridImp_>
friend class UGGridLevelIndexSet;
template <class GridImp_>
friend class UGGridLeafIndexSet;
template <class GridImp_, bool Local>
friend class UGGridIdSet;
friend class UGGridEntityPointer<codim, GridImp>;
friend class UGGridEntitySeed<codim, GridImp>;
typedef typename GridImp::ctype UGCtype;
public:
typedef typename GridImp::template Codim<codim>::Geometry Geometry;
/** \brief The type of UGGrid Entity seeds */
typedef typename GridImp::Traits::template Codim<codim>::EntitySeed EntitySeed;
//! level of this element
int level () const {
return UG_NS<dim>::myLevel(target_);
}
/** \brief Return the entity type identifier */
GeometryType type() const
{
return GeometryType(1);
}
/** \brief The partition type for parallel computing
* \todo So far it always returns InteriorEntity */
PartitionType partitionType () const
{
#ifndef ModelP
return InteriorEntity;
#else
typename UG_NS<dim>::Edge *edge =
static_cast<typename UG_NS<dim>::Edge *>(target_);
if (UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioHGhost
|| UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioVGhost
|| UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioVHGhost)
return GhostEntity;
else if (UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioBorder || hasBorderCopy_(edge))
return BorderEntity;
else if (UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioMaster || UG_NS<dim>::Priority(edge) == UG_NS<dim>::PrioNone)
return InteriorEntity;
else
DUNE_THROW(GridError, "Unknown priority " << UG_NS<dim>::Priority(edge));
#endif
}
/*! Intra-element access to entities of codimension cc > codim. Return number of entities
with codimension cc.
*/
//!< Default codim 1 Faces and codim == dim Vertices
template<int cc> int count () const;
/** \brief Get the seed corresponding to this entity */
EntitySeed seed () const { return EntitySeed( *this ); }
protected:
#ifdef ModelP
bool hasBorderCopy_(typename UG_NS<dim>::Edge *edge) const {
int *plist = UG_NS<dim>::DDD_InfoProcList(UG_NS<dim>::ParHdr(edge));
for (int i = 0; plist[i] >= 0; i += 2)
if (plist[i + 1] == UG_NS<dim>::PrioBorder)
return true;
return false;
}
#endif
void setToTarget(typename UG_NS<dim>::template Entity<codim>::T* target, const GridImp* gridImp) {
target_ = target;
gridImp_ = gridImp;
}
typename UG_NS<dim>::template Entity<codim>::T* target_;
/** \brief gridImp Not actually used, only the codim-0 specialization needs it
* But code is simpler if we just keep it everywhere.
*/
const GridImp* gridImp_;
};
/*! \brief Specialization for edge in 2D
* \ingroup UGGrid
*/
template<class GridImp>
class UGGridEntity<1,2,GridImp>
: public UGEdgeEntity<2,GridImp>
{};
/*! \brief Specialization for edge in 3D
* \ingroup UGGrid
*/
template<class GridImp>
class UGGridEntity<2,3,GridImp>
: public UGEdgeEntity<3,GridImp>
{};
/*! \brief UGGrid face entity
* \ingroup UGGrid
*/
template<int dim, class GridImp>
class UGFaceEntity
{
enum {codim = 1};
public:
/** \brief Return the entity type identifier */
GeometryType type() const
{
DUNE_THROW(NotImplemented, "UGGridEntity::type() for faces");
}
/** \brief The partition type for parallel computing
* \todo So far it always returns InteriorEntity */
PartitionType partitionType () const
{
DUNE_THROW(NotImplemented, "UGGridEntity::partitionType() for faces");
}
void setToTarget(typename UG_NS<dim>::template Entity<codim>::T* target, const GridImp* gridImp) {
target_ = target;
gridImp_ = gridImp;
}
/** \brief The corresponding UG object */
typename UG_NS<dim>::template Entity<codim>::T* target_;
/** \brief The geometry type cannot be retrieved from the UG object.
* We have to store it separately.
* \bug This member isn't initialized yet
*/
GeometryType type_;
/** \brief gridImp Not actually used, only the codim-0 specialization needs it
* But code is simpler if we just keep it everywhere.
*/
const GridImp* gridImp_;
};
/*! \brief Specialization for faces in 3D
* \ingroup UGGrid
*/
template<class GridImp>
class UGGridEntity<1,3,GridImp>
: public UGFaceEntity<3,GridImp>
{};
//***********************
//
// --UGGridEntity
// --0Entity
//
//***********************
/** \brief Specialization for codim-0-entities.
* \ingroup UGGrid
*
* This class embodies the topological parts of elements of the grid.
* It has an extended interface compared to the general entity class.
* For example, Entities of codimension 0 allow to visit all neighbors.
*
* UGGrid only implements the cases dim==dimworld==2 and dim=dimworld==3.
*/
template<int dim, class GridImp>
class UGGridEntity<0,dim,GridImp>
{
friend class UGGrid<dim>;
friend class UGGridLeafIntersectionIterator <GridImp>;
friend class UGGridHierarchicIterator <GridImp>;
template <int codim_, PartitionIteratorType PiType_, class GridImp_>
friend class UGGridLevelIterator;
friend class UGMakeableEntity<0,dim,GridImp>;
friend class UGGridEntityPointer<0, GridImp>;
typedef typename GridImp::ctype UGCtype;
typedef typename GridImp::Traits::template Codim< 0 >::GeometryImpl GeometryImpl;
typedef typename GridImp::Traits::template Codim< 0 >::LocalGeometryImpl LocalGeometryImpl;
public:
typedef typename GridImp::template Codim<0>::Geometry Geometry;
typedef typename GridImp::template Codim<0>::LocalGeometry LocalGeometry;
//! The Iterator over neighbors on this level
typedef UGGridLevelIntersectionIterator<GridImp> LevelIntersectionIterator;
//! The Iterator over neighbors on the leaf level
typedef UGGridLeafIntersectionIterator<GridImp> LeafIntersectionIterator;
//! Iterator over descendants of the entity
typedef UGGridHierarchicIterator<GridImp> HierarchicIterator;
/** \brief The type of UGGrid Entity seeds */
typedef typename GridImp::Traits::template Codim<0>::EntitySeed EntitySeed;
UGGridEntity()
: gridImp_(NULL)
{}
//! Level of this element
int level () const {
return UG_NS<dim>::myLevel(target_);
}
/** \brief Return the entity type identifier */
GeometryType type() const;
/** \brief The partition type for parallel computing */
PartitionType partitionType () const {
#ifndef ModelP
return InteriorEntity;
#else
if (UG_NS<dim>::EPriority(target_) == UG_NS<dim>::PrioHGhost
|| UG_NS<dim>::EPriority(target_) == UG_NS<dim>::PrioVGhost
|| UG_NS<dim>::EPriority(target_) == UG_NS<dim>::PrioVHGhost)
return GhostEntity;
else
return InteriorEntity;
#endif
}
//! Geometry of this entity
Geometry geometry () const { return Geometry( geo_ ); }
/** \brief Get the seed corresponding to this entity */
EntitySeed seed () const { return EntitySeed( *this ); }
/** \brief Return the number of subEntities of codimension cc.
*/
template<int cc>
int count () const;
/** \brief Provide access to sub entity i of given codimension. Entities
* are numbered 0 ... count<cc>()-1
*/
template<int cc>
typename GridImp::template Codim<cc>::EntityPointer subEntity (int i) const;
/** \todo It would be faster to not use -1 as the end marker but
number of sides instead */
UGGridLeafIntersectionIterator<GridImp> ileafbegin () const {
return UGGridLeafIntersectionIterator<GridImp>(target_, (isLeaf()) ? 0 : UG_NS<dim>::Sides_Of_Elem(target_),gridImp_);
}
UGGridLevelIntersectionIterator<GridImp> ilevelbegin () const {
return UGGridLevelIntersectionIterator<GridImp>(target_, 0, gridImp_);
}
//! Reference to one past the last leaf neighbor
UGGridLeafIntersectionIterator<GridImp> ileafend () const {
return UGGridLeafIntersectionIterator<GridImp>(target_, UG_NS<dim>::Sides_Of_Elem(target_), gridImp_);
}
//! Reference to one past the last level neighbor
UGGridLevelIntersectionIterator<GridImp> ilevelend () const {
return UGGridLevelIntersectionIterator<GridImp>(target_, UG_NS<dim>::Sides_Of_Elem(target_),gridImp_);
}
//! returns true if Entity has NO children
bool isLeaf() const {
return UG_NS<dim>::isLeaf(target_);
}
//! returns true if element is of regular type
bool isRegular() const {
return UG_NS<dim>::isRegular(target_);
}
/** \brief Returns true if the entity has intersections with the boundary
*/
bool hasBoundaryIntersections() const {
return UG_NS<dim>::isBoundaryElement(target_);
}
//! Inter-level access to father element on coarser grid.
//! Assumes that meshes are nested.
typename GridImp::template Codim<0>::EntityPointer father () const {
return typename GridImp::template Codim<0>::EntityPointer (UGGridEntityPointer<0,GridImp>(UG_NS<dim>::EFather(target_),gridImp_));
}
//! returns true if father entity exists
bool hasFather () const
{
return UG_NS<dim>::EFather(target_) != NULL;
}
/*! Location of this element relative to the reference element element of the father.
*/
LocalGeometry geometryInFather () const;
/*! Inter-level access to son elements on higher levels<=maxlevel.
This is provided for sparsely stored nested unstructured meshes.
Returns iterator to first son.
*/
UGGridHierarchicIterator<GridImp> hbegin (int maxlevel) const;
//! Returns iterator to one past the last son
UGGridHierarchicIterator<GridImp> hend (int maxlevel) const;
//***************************************************************
// Interface for Adaptation
//***************************************************************
//! returns true, if entity was refined during last adaptation cycle
bool isNew() const;
/*! \brief
returns true, if entity might be coarsened during next adaptation
cycle, which is true for entities that have been marked for
coarsening or for entities that are not regular (i.e. isRegular
returns false) */
bool mightVanish() const;
//!
void setToTarget(typename UG_NS<dim>::Element* target, const GridImp* gridImp);
//! the current geometry
GeometryImpl geo_;
/** \brief The corresponding UG-internal data structure */
typename UG_NS<dim>::Element* target_;
/** \brief Pointer to the grid that we are part of.
*
* We need that only to hand it over to the intersections,
* which need it.
*/
const GridImp* gridImp_;
}; // end of UGGridEntity codim = 0
} // namespace Dune
#endif
|