Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
MGMatrixBlockVector< MATRIX > Class Template Reference

#include <matrix_block.h>

Inheritance diagram for MGMatrixBlockVector< MATRIX >:
[legend]

Public Types

typedef types::global_dof_index size_type
 
typedef MGLevelObject
< MatrixBlock< MATRIX > > 
value_type
 

Public Member Functions

 MGMatrixBlockVector (const bool edge_matrices=false, const bool edge_flux_matrices=false)
 
unsigned int size () const
 
void add (size_type row, size_type column, const std::string &name)
 
void reinit_matrix (const MGLevelObject< BlockSparsityPattern > &sparsity)
 
void reinit_edge (const MGLevelObject< BlockSparsityPattern > &sparsity)
 
void reinit_edge_flux (const MGLevelObject< BlockSparsityPattern > &sparsity)
 
void clear (bool really_clean=false)
 
const value_typeblock (size_type i) const
 
value_typeblock (size_type i)
 
const value_typeblock_in (size_type i) const
 
value_typeblock_in (size_type i)
 
const value_typeblock_out (size_type i) const
 
value_typeblock_out (size_type i)
 
const value_typeblock_up (size_type i) const
 
value_typeblock_up (size_type i)
 
const value_typeblock_down (size_type i) const
 
value_typeblock_down (size_type i)
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Member Functions

void clear_object (NamedData< MGLevelObject< MatrixBlock< MATRIX > > > &)
 Clear one of the matrix objects.
 

Private Attributes

const bool edge_matrices
 Flag for storing matrices_in and matrices_out.
 
const bool edge_flux_matrices
 Flag for storing flux_matrices_up and flux_matrices_down.
 
NamedData< MGLevelObject
< MatrixBlock< MATRIX > > > 
matrices
 The level matrices.
 
NamedData< MGLevelObject
< MatrixBlock< MATRIX > > > 
matrices_in
 The matrix from the interior of a level to the refinement edge.
 
NamedData< MGLevelObject
< MatrixBlock< MATRIX > > > 
matrices_out
 The matrix from the refinement edge to the interior of a level.
 
NamedData< MGLevelObject
< MatrixBlock< MATRIX > > > 
flux_matrices_down
 The DG flux from a level to the lower level.
 
NamedData< MGLevelObject
< MatrixBlock< MATRIX > > > 
flux_matrices_up
 The DG flux from the lower level to a level.
 

Detailed Description

template<class MATRIX>
class MGMatrixBlockVector< MATRIX >

A vector of MGLevelObject<MatrixBlock>, which is implemented using shared pointers, in order to allow for copying and rearranging. Each matrix block can be identified by name.

Author
Baerbel Janssen, Guido Kanschat, 2010

Definition at line 499 of file matrix_block.h.

Member Typedef Documentation

template<class MATRIX>
typedef types::global_dof_index MGMatrixBlockVector< MATRIX >::size_type

Declare type for container size.

Definition at line 506 of file matrix_block.h.

template<class MATRIX>
typedef MGLevelObject<MatrixBlock<MATRIX> > MGMatrixBlockVector< MATRIX >::value_type

The type of object stored.

Definition at line 511 of file matrix_block.h.

Constructor & Destructor Documentation

template<class MATRIX >
MGMatrixBlockVector< MATRIX >::MGMatrixBlockVector ( const bool  edge_matrices = false,
const bool  edge_flux_matrices = false 
)
inline

Constructor, determining which matrices should be stored.

If edge_matrices is true, then objects for edge matrices for discretizations with degrees of freedom on faces are allocated.

If edge_flux_matrices is true, then objects for DG fluxes on the refinement edge are allocated.

Definition at line 1008 of file matrix_block.h.

Member Function Documentation

template<class MATRIX >
unsigned int MGMatrixBlockVector< MATRIX >::size ( ) const
inline

The number of blocks.

Definition at line 1019 of file matrix_block.h.

template<class MATRIX >
void MGMatrixBlockVector< MATRIX >::add ( size_type  row,
size_type  column,
const std::string &  name 
)
inline

Add a new matrix block at the position (row,column) in the block system. The third argument allows to give the matrix a name for later identification.

Definition at line 1027 of file matrix_block.h.

template<class MATRIX >
void MGMatrixBlockVector< MATRIX >::reinit_matrix ( const MGLevelObject< BlockSparsityPattern > &  sparsity)
inline

For matrices using a SparsityPattern, this function reinitializes each matrix in the vector with the correct pattern from the block system.

This function reinitializes the level matrices.

Definition at line 1131 of file matrix_block.h.

template<class MATRIX >
void MGMatrixBlockVector< MATRIX >::reinit_edge ( const MGLevelObject< BlockSparsityPattern > &  sparsity)
inline

For matrices using a SparsityPattern, this function reinitializes each matrix in the vector with the correct pattern from the block system.

This function reinitializes the matrices for degrees of freedom on the refinement edge.

Definition at line 1152 of file matrix_block.h.

template<class MATRIX >
void MGMatrixBlockVector< MATRIX >::reinit_edge_flux ( const MGLevelObject< BlockSparsityPattern > &  sparsity)
inline

For matrices using a SparsityPattern, this function reinitializes each matrix in the vector with the correct pattern from the block system.

This function reinitializes the flux matrices over the refinement edge.

Definition at line 1177 of file matrix_block.h.

template<class MATRIX >
void MGMatrixBlockVector< MATRIX >::clear ( bool  really_clean = false)
inline

Clears the object.

Since often only clearing of the individual matrices is desired, but not removing the blocks themselves, there is an optional argument. If the argument is missing or false, all matrices will be mepty, but the size of this object and the block positions will not change. If really_clean is true, then the object will contain no blocks at the end.

Definition at line 1216 of file matrix_block.h.

template<class MATRIX >
const MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block ( size_type  i) const
inline

Access a constant reference to the matrix block at position i.

Definition at line 1051 of file matrix_block.h.

template<class MATRIX >
MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block ( size_type  i)
inline

Access a reference to the matrix block at position i.

Definition at line 1059 of file matrix_block.h.

template<class MATRIX >
const MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_in ( size_type  i) const
inline

Access a constant reference to the edge matrix block at position i.

Definition at line 1067 of file matrix_block.h.

template<class MATRIX >
MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_in ( size_type  i)
inline

Access a reference to the edge matrix block at position i.

Definition at line 1075 of file matrix_block.h.

template<class MATRIX >
const MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_out ( size_type  i) const
inline

Access a constant reference to the edge matrix block at position i.

Definition at line 1083 of file matrix_block.h.

template<class MATRIX >
MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_out ( size_type  i)
inline

Access a reference to the edge matrix block at position i.

Definition at line 1091 of file matrix_block.h.

template<class MATRIX >
const MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_up ( size_type  i) const
inline

Access a constant reference to the edge flux matrix block at position i.

Definition at line 1099 of file matrix_block.h.

template<class MATRIX >
MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_up ( size_type  i)
inline

Access a reference to the edge flux matrix block at position i.

Definition at line 1107 of file matrix_block.h.

template<class MATRIX >
const MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_down ( size_type  i) const
inline

Access a constant reference to the edge flux matrix block at position i.

Definition at line 1115 of file matrix_block.h.

template<class MATRIX >
MGLevelObject< MatrixBlock< MATRIX > > & MGMatrixBlockVector< MATRIX >::block_down ( size_type  i)
inline

Access a reference to the edge flux matrix block at position i.

Definition at line 1123 of file matrix_block.h.

template<class MATRIX>
std::size_t MGMatrixBlockVector< MATRIX >::memory_consumption ( ) const

The memory used by this object.


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