internal::SubfaceCase< dim > Class Template Reference

Inheritance diagram for internal::SubfaceCase< dim >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Static Public Member Functions

static unsigned int memory_consumption ()
::ExceptionBaseExcInvalidSubfaceCase (int arg1) throw (errortext << "The subface case given (" << arg1 << ") does not make sense " << "for the space dimension of the object to which they are applied." )

Private Attributes

unsigned char value: (dim == 3 ? 4 : 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

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<dim>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 unsigned int internal::SubfaceCase< dim >::memory_consumption (  )  [static]

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

template<int dim>
::ExceptionBase& internal::SubfaceCase< dim >::ExcInvalidSubfaceCase ( int  arg1  )  throw (errortext << "The subface case given (" << arg1 << ") does not make sense " << "for the space dimension of the object to which they are applied." ) [static]

Exception.


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.


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

deal.II documentation generated on Wed Jul 28 23:06:53 2010 by doxygen 1.5.6