Reference documentation for deal.II version Git 7f58f27 2017-09-20 15:35:49 -0600
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
internal::SubfaceCase< dim > Class Template Reference

#include <deal.II/base/geometry_info.h>

Inheritance diagram for internal::SubfaceCase< dim >:
[legend]

Public Member Functions

 SubfaceCase (const typename SubfacePossibilities< dim >::Possibilities subface_possibility)
 
 operator unsigned char () const
 

Static Public Member Functions

static std::size_t memory_consumption ()
 
static::ExceptionBase & ExcInvalidSubfaceCase (int arg1)
 

Private Attributes

unsigned char value: (dim == 3 ? 4 : 1)
 

Additional Inherited Members

- Public Types inherited from internal::SubfacePossibilities< dim >
enum  Possibilities { case_none = 0, case_isotropic = static_cast<unsigned char>(-1) }
 

Detailed Description

template<int dim>
class internal::SubfaceCase< dim >

A class that provides all possible cases a face (in the current space dimension dim) might be subdivided into subfaces.

Author
Ralf Hartmann, 2008

Definition at line 789 of file geometry_info.h.

Constructor & Destructor Documentation

template<int dim>
internal::SubfaceCase< dim >::SubfaceCase ( const typename SubfacePossibilities< dim >::Possibilities  subface_possibility)

Constructor. Take and store a value indicating a particular subface possibility in the list of possible situations specified in the base class.

Member Function Documentation

template<int dim>
internal::SubfaceCase< dim >::operator unsigned char ( ) const

Return the numeric value stored by this class. While the presence of this operator might seem dangerous, it is useful in cases where one would like to have code like switch (subface_case)... case SubfaceCase::case_x: ... , which can be written as switch (static_cast<unsigned char>(subface_case). Another application is to use an object of the current type as an index into an array; however, this use is deprecated as it assumes a certain mapping from the symbolic flags defined in the SubfacePossibilities base class to actual numerical values (the array indices).

template<int dim>
static std::size_t internal::SubfaceCase< dim >::memory_consumption ( )
static

Return the amount of memory occupied by an object of this type.

Member Data Documentation

template<int dim>
unsigned char internal::SubfaceCase< dim >::value
private

Store the refinement case as a bit field with as many bits as are necessary in any given dimension.

Definition at line 831 of file geometry_info.h.


The documentation for this class was generated from the following file: