Reference documentation for deal.II version Git d3646d97a1 2019-11-19 14:29:22 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Private Member Functions | Private Attributes | List of all members
MGTransferBlockSelect< number > Class Template Reference

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

Inheritance diagram for MGTransferBlockSelect< number >:
[legend]

Public Member Functions

 MGTransferBlockSelect ()
 
 MGTransferBlockSelect (const MGConstrainedDoFs &mg_constrained_dofs)
 
 MGTransferBlockSelect (const AffineConstraints< double > &constraints, const MGConstrainedDoFs &mg_constrained_dofs)
 
virtual ~MGTransferBlockSelect () override=default
 
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 override
 
virtual void restrict_and_add (const unsigned int from_level, Vector< number > &dst, const Vector< number > &src) const override
 
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 () override=default
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
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 MGConstrainedDoFs &mg_constrained_dofs)
 
 MGTransferBlockBase (const AffineConstraints< double > &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)
 

Private Attributes

unsigned int selected_block
 
- Private Attributes inherited from MGTransferBlockBase
std::vector< bool > selected
 
unsigned int n_mg_blocks
 
std::vector< unsigned int > mg_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::shared_ptr< BlockSparseMatrix< double > > > prolongation_matrices
 
std::vector< std::vector< std::vector< std::pair< unsigned int, unsigned int > > > > copy_indices
 
SmartPointer< const MGConstrainedDoFs, MGTransferBlockBasemg_constrained_dofs
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- Static Private Member Functions inherited from MGTransferBlockBase
static ::ExceptionBaseExcMatricesNotBuilt ()
 

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 314 of file mg_transfer_block.h.

Constructor & Destructor Documentation

◆ MGTransferBlockSelect() [1/3]

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

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

Definition at line 257 of file multigrid.cc.

◆ MGTransferBlockSelect() [2/3]

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

Constructor with constraint matrices as well as mg_constrained_dofs.

Definition at line 264 of file multigrid.cc.

◆ MGTransferBlockSelect() [3/3]

template<typename number >
MGTransferBlockSelect< number >::MGTransferBlockSelect ( const AffineConstraints< double > &  constraints,
const MGConstrainedDoFs mg_constrained_dofs 
)

Constructor with constraint matrices as well as mg_constrained_dofs.

Deprecated:
constraints is unused.

Definition at line 273 of file multigrid.cc.

◆ ~MGTransferBlockSelect()

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

Destructor.

Member Function Documentation

◆ build_matrices()

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.

Definition at line 477 of file mg_transfer_block.cc.

◆ select()

template<typename number >
void MGTransferBlockSelect< number >::select ( const unsigned int  block)
inline

Change selected block. Handle with care!

Definition at line 495 of file mg_transfer_block.h.

◆ prolongate()

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

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 > >.

Definition at line 284 of file multigrid.cc.

◆ restrict_and_add()

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

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 degrees 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 > >.

Definition at line 307 of file multigrid.cc.

◆ copy_to_mg() [1/2]

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 for the 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.

Definition at line 159 of file mg_transfer_block.cc.

◆ copy_from_mg() [1/2]

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.

◆ copy_from_mg_add() [1/2]

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.

◆ copy_to_mg() [2/2]

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 values for the active degrees of freedom of the block selected are transferred. 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.

Definition at line 133 of file mg_transfer_block.cc.

◆ copy_from_mg() [2/2]

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.

◆ copy_from_mg_add() [2/2]

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.

◆ memory_consumption()

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

Memory used by this object.

◆ do_copy_from_mg()

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.

◆ do_copy_from_mg_add()

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.

◆ do_copy_to_mg()

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

◆ selected_block

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

Selected block.

Definition at line 487 of file mg_transfer_block.h.


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