Public Member Functions | Private Attributes

MGLevelObject< Object > Class Template Reference
[Multilevel supportData storage primitives]

Inheritance diagram for MGLevelObject< Object >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 MGLevelObject (const unsigned int minlevel=0, const unsigned int maxlevel=0)
Object & operator[] (const unsigned int level)
const Object & operator[] (const unsigned int level) const
void resize (const unsigned int new_minlevel, const unsigned int new_maxlevel)
MGLevelObject< Object > & operator= (const double d)
void clear ()
unsigned int min_level () const
unsigned int max_level () const
unsigned int get_minlevel () const
unsigned int get_maxlevel () const
std::size_t memory_consumption () const

Private Attributes

unsigned int minlevel
std::vector
< std_cxx1x::shared_ptr
< Object > > 
objects

Detailed Description

template<class Object>
class MGLevelObject< Object >

An array with an object for each level. The purpose of this class is mostly to store objects and allow access by level number, even if the lower levels are not used and therefore have no object at all; this is done by simply shifting the given index by the minimum level we have stored.

In most cases, the objects which are stored on each levels, are either matrices or vectors.

Author:
Wolfgang Bangerth, Guido Kanschat, 1999, 2005, 2010

Definition at line 38 of file mg_level_object.h.


Constructor & Destructor Documentation

template<class Object >
MGLevelObject< Object >::MGLevelObject ( const unsigned int  minlevel = 0,
const unsigned int  maxlevel = 0 
)

Constructor allowing to initialize the number of levels. By default, the object is created empty.

Definition at line 132 of file mg_level_object.h.

References MGLevelObject< Object >::resize().


Member Function Documentation

template<class Object >
Object & MGLevelObject< Object >::operator[] ( const unsigned int  level )

Access object on level level.

Definition at line 143 of file mg_level_object.h.

References Assert, and StandardExceptions::ExcIndexRange().

template<class Object >
const Object & MGLevelObject< Object >::operator[] ( const unsigned int  level ) const

Access object on level level. Constant version.

Definition at line 153 of file mg_level_object.h.

References Assert, and StandardExceptions::ExcIndexRange().

template<class Object >
void MGLevelObject< Object >::resize ( const unsigned int  new_minlevel,
const unsigned int  new_maxlevel 
)

Delete all previous contents of this object and reset its size according to the values of new_minlevel and new_maxlevel.

Definition at line 163 of file mg_level_object.h.

References Assert, and StandardExceptions::ExcInternalError().

Referenced by MGLevelObject< Object >::MGLevelObject(), MGMatrixBlockVector< MATRIX >::reinit_edge(), MGMatrixBlockVector< MATRIX >::reinit_edge_flux(), and MGMatrixBlockVector< MATRIX >::reinit_matrix().

template<class Object >
MGLevelObject< Object > & MGLevelObject< Object >::operator= ( const double  d )

Call operator = (s) on all objects stored by this object. This is particularly useful for e.g. Object==Vector<T>

Definition at line 181 of file mg_level_object.h.

template<class Object >
void MGLevelObject< Object >::clear (  )

Call clear on all objects stored by this object. This function is only implemented for some Object classes, e.g. the PreconditionBlockSOR and similar classes.

Reimplemented in mg::SmootherRelaxation< RELAX, VECTOR >.

Definition at line 192 of file mg_level_object.h.

template<class Object >
unsigned int MGLevelObject< Object >::min_level (  ) const
template<class Object >
unsigned int MGLevelObject< Object >::max_level (  ) const
template<class Object >
unsigned int MGLevelObject< Object >::get_minlevel (  ) const
Deprecated:
Replaced by min_level()

Definition at line 202 of file mg_level_object.h.

template<class Object >
unsigned int MGLevelObject< Object >::get_maxlevel (  ) const
Deprecated:
Replaced by max_level()

Definition at line 210 of file mg_level_object.h.

template<class Object >
std::size_t MGLevelObject< Object >::memory_consumption (  ) const

Memory used by this object.

Reimplemented in mg::SmootherRelaxation< RELAX, VECTOR >.

Definition at line 234 of file mg_level_object.h.


Member Data Documentation

template<class Object>
unsigned int MGLevelObject< Object >::minlevel [private]

Level of first component.

Definition at line 119 of file mg_level_object.h.

template<class Object>
std::vector<std_cxx1x::shared_ptr<Object> > MGLevelObject< Object >::objects [private]

Array of the objects to be held.

Definition at line 124 of file mg_level_object.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:09 by doxygen 1.7.2