Reference documentation for deal.II version 8.1.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
MGTransferBlockSelect< number > Class Template Reference

#include <mg_transfer_block.h>

Inheritance diagram for MGTransferBlockSelect< number >:
[legend]

Public Member Functions

 MGTransferBlockSelect ()
 
 MGTransferBlockSelect (const ConstraintMatrix &constraints, const MGConstrainedDoFs &mg_constrained_dofs)
 
virtual ~MGTransferBlockSelect ()
 
template<int dim, int spacedim>
void build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof, unsigned int selected)
 
void select (const unsigned int block)
 
virtual void prolongate (const unsigned int to_level, Vector< number > &dst, const Vector< number > &src) const
 
virtual void restrict_and_add (const unsigned int from_level, Vector< number > &dst, const Vector< number > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< Vector< number > > &dst, const Vector< number2 > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, Vector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &mg_dof, Vector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< Vector< number > > &dst, const BlockVector< number2 > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, BlockVector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &mg_dof, BlockVector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from MGTransferBase< Vector< number > >
virtual ~MGTransferBase ()
 
- 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

template<int dim, class OutVector , int spacedim>
void do_copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< Vector< number > > &src, const unsigned int offset) const
 
template<int dim, class OutVector , int spacedim>
void do_copy_from_mg_add (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< Vector< number > > &src, const unsigned int offset) const
 
template<int dim, class InVector , int spacedim>
void do_copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< Vector< number > > &dst, const InVector &src, const unsigned int offset) const
 
- Private Member Functions inherited from MGTransferBlockBase
 MGTransferBlockBase ()
 
 MGTransferBlockBase (const ConstraintMatrix &constraints, const MGConstrainedDoFs &mg_constrained_dofs)
 
std::size_t memory_consumption () const
 
template<int dim, int spacedim>
void build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof)
 
 DeclException0 (ExcMatricesNotBuilt)
 

Private Attributes

unsigned int selected_block
 
- Private Attributes inherited from MGTransferBlockBase
std::vector< boolselected
 
unsigned int n_mg_blocks
 
std::vector< unsigned intmg_block
 
std::vector< std::vector< types::global_dof_index > > sizes
 
std::vector< types::global_dof_indexblock_start
 
std::vector< std::vector< types::global_dof_index > > mg_block_start
 
std::vector< std_cxx1x::shared_ptr< BlockSparseMatrix< double > > > prolongation_matrices
 
std::vector< std::vector< std::vector< std::pair< unsigned int, unsigned int > > > > copy_indices
 
SmartPointer< const ConstraintMatrix, MGTransferBlockBaseconstraints
 
SmartPointer< const MGConstrainedDoFs, MGTransferBlockBasemg_constrained_dofs
 

Detailed Description

template<typename number>
class MGTransferBlockSelect< number >

Implementation of the MGTransferBase interface for block matrices and simple vectors. This class uses MGTransferBlockBase selecting a single block. The intergrid transfer operators are implemented for Vector objects, The copy functions between regular and multigrid vectors for Vector and BlockVector.

See MGTransferBase to find out which of the transfer classes is best for your needs.

Author
Guido Kanschat, 2001, 2002, 2003

Definition at line 341 of file mg_transfer_block.h.

Constructor & Destructor Documentation

template<typename number >
MGTransferBlockSelect< number >::MGTransferBlockSelect ( )

Constructor without constraint matrices. Use this constructor only with discontinuous finite elements or with no local refinement.

template<typename number >
MGTransferBlockSelect< number >::MGTransferBlockSelect ( const ConstraintMatrix constraints,
const MGConstrainedDoFs mg_constrained_dofs 
)

Constructor with constraint matrices as well as mg_constrained_dofs.

template<typename number >
virtual MGTransferBlockSelect< number >::~MGTransferBlockSelect ( )
virtual

Destructor.

Member Function Documentation

template<typename number >
template<int dim, int spacedim>
void MGTransferBlockSelect< number >::build_matrices ( const DoFHandler< dim, spacedim > &  dof,
const DoFHandler< dim, spacedim > &  mg_dof,
unsigned int  selected 
)

Actually build the prolongation matrices for grouped blocks.

This function is a front-end for the same function in MGTransferBlockBase.

  • selected: Number of the block of the global vector to be copied from and to the multilevel vector.
  • mg_selected: Number of the component for which the transfer matrices should be built.
template<typename number >
void MGTransferBlockSelect< number >::select ( const unsigned int  block)
inline

Change selected block. Handle with care!

Definition at line 531 of file mg_transfer_block.h.

template<typename number >
virtual void MGTransferBlockSelect< number >::prolongate ( const unsigned int  to_level,
Vector< number > &  dst,
const Vector< number > &  src 
) const
virtual

Prolongate a vector from level to_level-1 to level to_level. The previous content of dst is overwritten.

  • src is a vector with as many elements as there are degrees of freedom on the coarser level involved.
  • dst has as many elements as there are degrees of freedom on the finer level.

Implements MGTransferBase< Vector< number > >.

template<typename number >
virtual void MGTransferBlockSelect< number >::restrict_and_add ( const unsigned int  from_level,
Vector< number > &  dst,
const Vector< number > &  src 
) const
virtual

Restrict a vector from level from_level to level from_level-1 and add this restriction to dst. If the region covered by cells on level from_level is smaller than that of level from_level-1 (local refinement), then some degrees of freedom in dst are active and will not be altered. For the other degress of freedom, the result of the restriction is added.

  • src is a vector with as many elements as there are degrees of freedom on the finer level
  • dst has as many elements as there are degrees of freedom on the coarser level.

Implements MGTransferBase< Vector< number > >.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< Vector< number > > &  dst,
const Vector< number2 > &  src 
) const

Transfer a single block from a vector on the global grid to a multilevel vector.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
Vector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Transfer from multilevel vector to normal vector.

Copies data from active portions of an multilevel vector into the respective positions of a Vector.

Definition at line 59 of file mg_transfer_block.templates.h.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg_add ( const DoFHandler< dim, spacedim > &  mg_dof,
Vector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Add a multi-level vector to a normal vector.

Works as the previous function, but probably not for continuous elements.

Definition at line 91 of file mg_transfer_block.templates.h.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< Vector< number > > &  dst,
const BlockVector< number2 > &  src 
) const

Transfer a block from a vector on the global grid to multilevel vectors. Only the block selected is transfered.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
BlockVector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Transfer from multilevel vector to normal vector.

Copies data from active portions of a multilevel vector into the respective positions of a global BlockVector.

Definition at line 43 of file mg_transfer_block.templates.h.

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg_add ( const DoFHandler< dim, spacedim > &  mg_dof,
BlockVector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Add a multi-level vector to a normal vector.

Works as the previous function, but probably not for continuous elements.

Definition at line 75 of file mg_transfer_block.templates.h.

template<typename number >
std::size_t MGTransferBlockSelect< number >::memory_consumption ( ) const

Memory used by this object.

Definition at line 106 of file mg_transfer_block.templates.h.

template<typename number >
template<int dim, class OutVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
OutVector &  dst,
const MGLevelObject< Vector< number > > &  src,
const unsigned int  offset 
) const
private

Implementation of the public function.

template<typename number >
template<int dim, class OutVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_from_mg_add ( const DoFHandler< dim, spacedim > &  mg_dof,
OutVector &  dst,
const MGLevelObject< Vector< number > > &  src,
const unsigned int  offset 
) const
private

Implementation of the public function.

template<typename number >
template<int dim, class InVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< Vector< number > > &  dst,
const InVector &  src,
const unsigned int  offset 
) const
private

Actual implementation of copy_to_mg().

Member Data Documentation

template<typename number >
unsigned int MGTransferBlockSelect< number >::selected_block
private

Selected block.

Definition at line 523 of file mg_transfer_block.h.


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