/usr/include/dune/geometry/type.hh is in libdune-geometry-dev 2.3.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 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GEOMETRY_TYPE_HH
#define DUNE_GEOMETRY_TYPE_HH
/** \file
* \brief A unique label for each type of element that can occur in a grid
*/
#include <cassert>
#include <dune/common/exceptions.hh>
#include <dune/common/unused.hh>
namespace Dune
{
/** \brief Unique label for each type of entities that can occur in DUNE grids
*
* This class has to be extended if a grid implementation with new entity types
* is added to DUNE.
*
* \ingroup GeometryType
*/
class GeometryType
{
public:
/** \brief Each entity can be tagged by one of these basic types
* plus its space dimension */
enum BasicType {
simplex, //!< Simplicial element in any nonnegative dimension
cube, //!< Cube element in any nonnegative dimension
pyramid, //!< Four sided pyramid in three dimensions
prism, //!< Prism element in three dimensions
extended, //!< Other, more general geometry, representable as topologyId
none //!< Generic element in any nonnegative dimension
};
/** \brief A few binary constants */
enum Binary {
b0001 = 1,
b0011 = 3,
b0101 = 5,
b0111 = 7
};
private:
/** \brief Topology Id element */
unsigned int topologyId_;
/** \brief Dimension of the element */
unsigned char dim_ : 7;
/** \brief bool if this is none-type */
bool none_ : 1;
public:
/** \brief Default constructor, not initializing anything */
GeometryType ()
: topologyId_(0), dim_(0), none_(true)
{}
/** \brief Constructor, using the basic type and the dimension */
GeometryType(BasicType basicType, unsigned int dim)
: topologyId_(0), dim_(dim), none_(false)
{
if (dim < 2)
return;
switch( basicType )
{
case GeometryType::simplex :
makeSimplex(dim);
break;
case GeometryType::cube :
makeCube(dim);
break;
case GeometryType::pyramid :
if (dim == 3)
makePyramid();
else
DUNE_THROW( RangeError,
"Invalid basic geometry type: no pyramids for dimension " << dim << "." );
break;
case GeometryType::prism :
if (dim == 3)
makePrism();
else
DUNE_THROW( RangeError,
"Invalid basic geometry type: no prisms for dimension " << dim << "." );
break;
case GeometryType::none :
makeNone(dim);
break;
default :
DUNE_THROW( RangeError,
"Invalid basic geometry type: " << basicType << " for dimension " << dim << "." );
}
}
/** \brief Constructor, using the topologyId (integer) and the dimension
* \note the topologyId is a binary encoded representation of
* the TypologyType, users are encouraged to use the
* GeometryType(TopologyType t) constructor.
*/
GeometryType(unsigned int topologyId, unsigned int dim)
: topologyId_(topologyId), dim_(dim), none_(false)
{}
/** \brief Constructor from static TopologyType class
*
* Constructs the GeometryType object from a static topology representation.
*
* \tparam TopologyType A class providing public static unsigned int members
* TopologyType::dimension and TopologyType::id.
* You can e.g. use the Point, Prism and Pyramid structs from
* topologytypes.hh in dune-grid.
* \param t Any object of type TopologyType. The object t itself is ignored.
*/
template<class TopologyType>
explicit GeometryType(TopologyType t)
: topologyId_(TopologyType::id), dim_(TopologyType::dimension), none_(false)
{
DUNE_UNUSED_PARAMETER(t);
}
/** \brief Constructor for vertices and segments */
explicit GeometryType(unsigned int dim)
: topologyId_(0), dim_(dim), none_(false)
{
assert(dim < 2);
}
/** \brief Constructor for vertices and segments */
// We need this constructor for "int" and "unsigned int",
// because otherwise GeometryType(int) would try to call the
// generic GeometryType(TopologyType) constructor
explicit GeometryType(int dim)
: topologyId_(0), dim_(dim), none_(false)
{
assert(dim < 2);
}
/** @name Setup Methods */
/*@{*/
/** \brief Make a vertex */
void makeVertex() {
none_ = false;
dim_ = 0;
topologyId_ = 0;
}
/** \brief Make a line segment */
void makeLine() {
none_ = false;
dim_ = 1;
topologyId_ = 0;
}
/** \brief Make a triangle */
void makeTriangle() {
makeSimplex(2);
}
/** \brief Make a quadrilateral */
void makeQuadrilateral() {
makeCube(2);
}
/** \brief Make a tetrahedron */
void makeTetrahedron() {
makeSimplex(3);
}
/** \brief Make a pyramid */
void makePyramid() {
none_ = false;
dim_ = 3;
topologyId_ = b0011;
}
/** \brief Make a prism */
void makePrism() {
none_ = false;
dim_ = 3;
topologyId_ = b0101; // (1 << (dim_-1)) - 1;
}
/** \brief Make a hexahedron */
void makeHexahedron() {
makeCube(3);
}
/** \brief Make a simplex of given dimension */
void makeSimplex(unsigned int dim) {
none_ = false;
dim_ = dim;
topologyId_ = 0;
}
/** \brief Make a hypercube of given dimension */
void makeCube(unsigned int dim) {
none_ = false;
dim_ = dim;
topologyId_ = ((dim>1) ? ((1 << dim) - 1) : 0);
}
/** \brief Make a singular of given dimension */
void makeNone(unsigned int dim) {
none_ = true;
dim_ = dim;
topologyId_ = 0;
}
/** \brief Construct the correct geometry type given the dimension and the number of vertices
* \note This code only works up to dimension 3.
* In higher dimensions the number of vertices does not uniquely identify the type of polyhedron.
*/
void makeFromVertices(unsigned int dim, unsigned int vertices)
{
switch (dim)
{
case 0 :
makeVertex();
return;
case 1 :
makeLine();
return;
case 2 :
switch (vertices) {
case 3 :
makeSimplex(2);
return;
case 4 :
makeCube(2);
return;
default :
DUNE_THROW(NotImplemented, "2d elements with " << vertices << " corners are not supported!");
}
case 3 :
switch (vertices) {
case 4 :
makeSimplex(3);
return;
case 5 :
makePyramid();
return;
case 6 :
makePrism();
return;
case 8 :
makeCube(3);
return;
default :
DUNE_THROW(NotImplemented, "3d elements with " << vertices << " corners are not supported!");
}
default :
DUNE_THROW(NotImplemented, "makeFromVertices only implemented up to 3d");
}
}
/*@}*/
/** @name Query Methods */
/*@{*/
/** \brief Return true if entity is a vertex */
bool isVertex() const {
return dim_==0;
}
/** \brief Return true if entity is a line segment */
bool isLine() const {
return dim_==1;
}
/** \brief Return true if entity is a triangle */
bool isTriangle() const {
return ! none_ && dim_==2 && (topologyId_ | 1) == b0001;
}
/** \brief Return true if entity is a quadrilateral */
bool isQuadrilateral() const {
return ! none_ && dim_==2 && (topologyId_ | 1) == b0011;
}
/** \brief Return true if entity is a tetrahedron */
bool isTetrahedron() const {
return ! none_ && dim_==3 && (topologyId_ | 1) == b0001;
}
/** \brief Return true if entity is a pyramid */
bool isPyramid() const {
return ! none_ && dim_==3 && (topologyId_ | 1) == b0011;
}
/** \brief Return true if entity is a prism */
bool isPrism() const {
return ! none_ && dim_==3 && (topologyId_ | 1) == b0101;
}
/** \brief Return true if entity is a hexahedron */
bool isHexahedron() const {
return ! none_ && dim_==3 && (topologyId_ | 1) == b0111;
}
/** \brief Return true if entity is a simplex of any dimension */
bool isSimplex() const {
return ! none_ && (topologyId_ | 1) == 1;
}
/** \brief Return true if entity is a cube of any dimension */
bool isCube() const {
return ! none_ && ((topologyId_ ^ ((1 << dim_)-1)) >> 1 == 0);
}
/** \brief Return true if entity is a singular of any dimension */
bool isNone() const {
return none_;
}
/** \brief Return dimension of the type */
unsigned int dim() const {
return dim_;
}
/** \brief Return the topology id the type */
unsigned int id() const {
return topologyId_;
}
/*@}*/
/** \brief Check for equality. This method knows that in dimension 0 and 1
* all BasicTypes are equal.
*/
bool operator==(const GeometryType& other) const {
return ( ( none_ == other.none_ )
&& ( ( none_ == true )
|| ( ( dim_ == other.dim_ )
&& ( (topologyId_ >> 1) == (other.topologyId_ >> 1) )
)
)
);
}
/** \brief Check for inequality */
bool operator!=(const GeometryType& other) const {
return ! ((*this)==other);
}
/** \brief less-than operation for use with maps */
bool operator < (const GeometryType& other) const {
return ( ( none_ < other.none_ )
|| ( !( other.none_ < none_ )
&& ( ( dim_ < other.dim_ )
|| ( (other.dim_ == dim_)
&& ((topologyId_ >> 1) < (other.topologyId_ >> 1) )
)
)
)
);
}
};
/** \brief Prints the type to an output stream */
inline std::ostream& operator<< (std::ostream& s, const GeometryType& a)
{
if (a.isSimplex())
{
s << "(simplex, " << a.dim() << ")";
return s;
}
if (a.isCube())
{
s << "(cube, " << a.dim() << ")";
return s;
}
if (a.isPyramid())
{
s << "(pyramid, 3)";
return s;
}
if (a.isPrism())
{
s << "(prism, 3)";
return s;
}
if (a.isNone())
{
s << "(none, " << a.dim() << ")";
return s;
}
s << "(other [" << a.id() << "], " << a.dim() << ")";
return s;
}
/** \brief Prints a GeometryType::BasicType to an output stream */
inline std::ostream& operator<< (std::ostream& s, GeometryType::BasicType type)
{
switch (type) {
case GeometryType::simplex :
s << "simplex";
break;
case GeometryType::cube :
s << "cube";
break;
case GeometryType::pyramid :
s << "pyramid";
break;
case GeometryType::prism :
s << "prism";
break;
case GeometryType::extended :
s << "other";
case GeometryType::none :
s << "none";
break;
default :
DUNE_THROW(Exception, "invalid GeometryType::BasicType");
}
return s;
}
} // namespace Dune
#endif // DUNE_GEOMETRY_TYPE_HH
|