Reference documentation for deal.II version Git dc65276 2016-10-01 16:32:42 -0400
Public Member Functions | Private Attributes | List of all members
MGLevelObject< Object > Class Template Reference

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

Inheritance diagram for MGLevelObject< Object >:
[legend]

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 () DEAL_II_DEPRECATED
 
void clear_elements ()
 
unsigned int min_level () const
 
unsigned int max_level () const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 

Detailed Description

template<class Object>
class MGLevelObject< Object >

This class represents an array with one object for each used level of a multilevel hierarchy, for example for use in the multigrid algorithms. In contrast to just a generic std::vector, this class allows to store objects only between some minimal and maximal index (=level), as one often wants to run a multilevel algorithm only on a subset of the levels of a mesh (e.g., because the second or third coarsest level is already small enough that it is cheaper to run a direct solver there, rather than recurse to even coarser levels). Despite storing objects only for these "interesting" levels, the class allows indexing simply by level. Internally, this is of course done by simply shifting the given index by the minimum level we have stored.

In a typical use case for this class, the objects stored on each level are either matrices or vectors.

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

Definition at line 48 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. Create a multilevel object with given minimal and maximal level, and allocate storage for objects on maxlevel-minlevel+1 levels.

Note
Unlike in many other places of the library, the two arguments here do not denote the first level and last-plus-one level, but indeed an inclusive range of levels for which to allocate storage for level objects. Consequently, the defaults for the two arguments will create an array with one level object, rather than an empty array.
Parameters
[in]minlevelThe lowest level for which to provision memory for level objects.
[in]maxlevelThe highest level for which to provision memory for level objects.
Precondition
minlevel <= maxlevel

Definition at line 162 of file mg_level_object.h.

Member Function Documentation

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

Access object on level level.

Definition at line 173 of file mg_level_object.h.

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

Access object on level level.

This function can be called on a const object, and consequently returns a const reference.

Definition at line 183 of file mg_level_object.h.

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.

Parameters
[in]new_minlevelThe lowest level for which to provision memory for level objects.
[in]new_maxlevelThe highest level for which to provision memory for level objects.
Precondition
minlevel <= maxlevel

Definition at line 193 of file mg_level_object.h.

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

Call operator = (s) on all objects stored by this object. This clearly requires that the objects stored on each level allow for this operation. This is, in particular, true for vectors and matrices if d is zero, thereby zeroing out all vector or matrix entries.

Definition at line 211 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., matrix types or the PreconditionBlockSOR and similar classes. Using this function will fail with a compiler error if the Object template type to this class does not provide a clear() member function.

Deprecated:
Use clear_elements () instead

Definition at line 222 of file mg_level_object.h.

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

Call clear on all objects stored by this object. This function is only implemented for some Object classes, e.g., matrix types or the PreconditionBlockSOR and similar classes. Using this function will fail with a compiler error if the Object template type to this class does not provide a clear() member function.

Definition at line 231 of file mg_level_object.h.

template<class Object >
unsigned int MGLevelObject< Object >::min_level ( ) const

The coarsest level for which this class stores a level object.

Definition at line 241 of file mg_level_object.h.

template<class Object >
unsigned int MGLevelObject< Object >::max_level ( ) const

The highest level for which this class stores a level object.

Definition at line 249 of file mg_level_object.h.

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

Memory used by this object.

Definition at line 257 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 149 of file mg_level_object.h.

template<class Object>
std::vector<std_cxx11::shared_ptr<Object> > MGLevelObject< Object >::objects
private

Array of the objects to be held.

Definition at line 154 of file mg_level_object.h.


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