Reference documentation for deal.II version Git 1dafe5d 2017-11-23 14:01:03 +0100
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
MGTransferBlockMatrixFree< dim, Number > Class Template Reference

#include <deal.II/multigrid/mg_transfer_matrix_free.h>

Inheritance diagram for MGTransferBlockMatrixFree< dim, Number >:
[legend]

Public Member Functions

 MGTransferBlockMatrixFree ()=default
 
 MGTransferBlockMatrixFree (const MGConstrainedDoFs &mg_constrained_dofs)
 
 MGTransferBlockMatrixFree (const std::vector< MGConstrainedDoFs > &mg_constrained_dofs)
 
virtual ~MGTransferBlockMatrixFree ()=default
 
void initialize_constraints (const MGConstrainedDoFs &mg_constrained_dofs)
 
void initialize_constraints (const std::vector< MGConstrainedDoFs > &mg_constrained_dofs)
 
void clear ()
 
void build (const DoFHandler< dim, dim > &mg_dof)
 
void build (const std::vector< const DoFHandler< dim, dim > * > &mg_dof)
 
virtual void prolongate (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const
 
virtual void restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const
 
template<typename Number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const LinearAlgebra::distributed::BlockVector< Number2 > &src) const
 
template<typename Number2 , int spacedim>
void copy_to_mg (const std::vector< const DoFHandler< dim, spacedim > * > &mg_dof, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const LinearAlgebra::distributed::BlockVector< Number2 > &src) const
 
template<typename Number2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, LinearAlgebra::distributed::BlockVector< Number2 > &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &src) const
 
template<typename Number2 , int spacedim>
void copy_from_mg (const std::vector< const DoFHandler< dim, spacedim > * > &mg_dof, LinearAlgebra::distributed::BlockVector< Number2 > &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &src) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >
virtual ~MGTransferBase ()=default
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Attributes

static const bool supports_dof_handler_vector = true
 

Private Attributes

std::vector< MGTransferMatrixFree< dim, Number > > matrix_free_transfer_vector
 
const bool same_for_all
 

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<int dim, typename Number>
class MGTransferBlockMatrixFree< dim, Number >

Implementation of the MGTransferBase interface for which the transfer operations is implemented in a matrix-free way based on the interpolation matrices of the underlying finite element. This requires considerably less memory than MGTransferPrebuilt and can also be considerably faster than that variant.

This class works with LinearAlgebra::distributed::BlockVector and performs exactly the same transfer operations for each block as MGTransferMatrixFree. Both the cases that the same DoFHandler is used for all the blocks and that each block uses its own DoFHandler are supported.

Author
Denis Davydov, Daniel Arndt
Date
2017

Definition at line 269 of file mg_transfer_matrix_free.h.

Constructor & Destructor Documentation

template<int dim, typename Number >
MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( )
default

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

template<int dim, typename Number >
MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( const MGConstrainedDoFs mg_constrained_dofs)

Constructor with constraints. Equivalent to the default constructor followed by initialize_constraints().

Definition at line 552 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( const std::vector< MGConstrainedDoFs > &  mg_constrained_dofs)

Same as above for the case that each block has its own DoFHandler.

Definition at line 562 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
virtual MGTransferBlockMatrixFree< dim, Number >::~MGTransferBlockMatrixFree ( )
virtualdefault

Destructor.

Member Function Documentation

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::initialize_constraints ( const MGConstrainedDoFs mg_constrained_dofs)

Initialize the constraints to be used in build().

Definition at line 573 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::initialize_constraints ( const std::vector< MGConstrainedDoFs > &  mg_constrained_dofs)

Same as above for the case that each block has its own DoFHandler.

Definition at line 588 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::clear ( )

Reset the object to the state it had right after the default constructor.

Definition at line 604 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::build ( const DoFHandler< dim, dim > &  mg_dof)

Actually build the information for the prolongation for each level.

Definition at line 613 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::build ( const std::vector< const DoFHandler< dim, dim > * > &  mg_dof)

Same as above for the case that each block has its own DoFHandler.

Definition at line 623 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::prolongate ( const unsigned int  to_level,
LinearAlgebra::distributed::BlockVector< Number > &  dst,
const LinearAlgebra::distributed::BlockVector< Number > &  src 
) const
virtual

Prolongate a vector from level to_level-1 to level to_level using the embedding matrices of the underlying finite element. The previous content of dst is overwritten.

Parameters
to_levelThe index of the level to prolongate to, which is the level of dst.
srcis a vector with as many elements as there are degrees of freedom on the coarser level involved.
dsthas as many elements as there are degrees of freedom on the finer level.

Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.

Definition at line 634 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
void MGTransferBlockMatrixFree< dim, Number >::restrict_and_add ( const unsigned int  from_level,
LinearAlgebra::distributed::BlockVector< Number > &  dst,
const LinearAlgebra::distributed::BlockVector< Number > &  src 
) const
virtual

Restrict a vector from level from_level to level from_level-1 using the transpose operation of the prolongate() method. 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 degrees of freedom, the result of the restriction is added.

Parameters
from_levelThe index of the level to restrict from, which is the level of src.
srcis a vector with as many elements as there are degrees of freedom on the finer level involved.
dsthas as many elements as there are degrees of freedom on the coarser level.

Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.

Definition at line 655 of file mg_transfer_matrix_free.cc.

template<int dim, typename Number >
template<typename Number2 , int spacedim>
void MGTransferBlockMatrixFree< dim, Number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  dst,
const LinearAlgebra::distributed::BlockVector< Number2 > &  src 
) const

Transfer from a block-vector on the global grid to block-vectors defined on each of the levels separately for active degrees of freedom. In particular, for a globally refined mesh only the finest level in dst is filled as a plain copy of src. All the other level objects are left untouched.

This function will initialize dst accordingly if needed as required by the Multigrid class.

template<int dim, typename Number >
template<typename Number2 , int spacedim>
void MGTransferBlockMatrixFree< dim, Number >::copy_to_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  mg_dof,
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  dst,
const LinearAlgebra::distributed::BlockVector< Number2 > &  src 
) const

Same as above for the case that each block has its own DoFHandler.

template<int dim, typename Number >
template<typename Number2 , int spacedim>
void MGTransferBlockMatrixFree< dim, Number >::copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
LinearAlgebra::distributed::BlockVector< Number2 > &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  src 
) const

Transfer from multi-level block-vector to normal vector.

template<int dim, typename Number >
template<typename Number2 , int spacedim>
void MGTransferBlockMatrixFree< dim, Number >::copy_from_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  mg_dof,
LinearAlgebra::distributed::BlockVector< Number2 > &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  src 
) const

Same as above for the case that each block has its own DoFHandler.

template<int dim, typename Number >
std::size_t MGTransferBlockMatrixFree< dim, Number >::memory_consumption ( ) const

Memory used by this object.

Definition at line 676 of file mg_transfer_matrix_free.cc.

Member Data Documentation

template<int dim, typename Number >
const bool MGTransferBlockMatrixFree< dim, Number >::supports_dof_handler_vector = true
static

This class can both be used with a single DoFHandler or a separate DoFHandler for each block.

Definition at line 411 of file mg_transfer_matrix_free.h.

template<int dim, typename Number >
std::vector<MGTransferMatrixFree<dim,Number> > MGTransferBlockMatrixFree< dim, Number >::matrix_free_transfer_vector
private

Non-block matrix-free versions of transfer operation.

Definition at line 418 of file mg_transfer_matrix_free.h.

template<int dim, typename Number >
const bool MGTransferBlockMatrixFree< dim, Number >::same_for_all
private

A flag to indicate whether the same DoFHandler is used for all the components or if each block has its own DoFHandler.

Definition at line 424 of file mg_transfer_matrix_free.h.


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