Reference documentation for deal.II version Git cb0bd54b52 2019-09-21 16:31:22 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
MGTransferSelect< number > Class Template Reference

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

Inheritance diagram for MGTransferSelect< number >:
[legend]

Public Member Functions

 MGTransferSelect ()
 
 MGTransferSelect (const AffineConstraints< double > &constraints)
 
virtual ~MGTransferSelect () override=default
 
template<int dim, int spacedim>
void build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof, unsigned int selected, unsigned int mg_selected, const std::vector< unsigned int > &target_component=std::vector< unsigned int >(), const std::vector< unsigned int > &mg_target_component=std::vector< unsigned int >(), const std::vector< std::set< types::global_dof_index >> &boundary_indices=std::vector< std::set< types::global_dof_index >>())
 
void select (const unsigned int component, const unsigned int mg_component=numbers::invalid_unsigned_int)
 
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)
 

Public Attributes

SmartPointer< const AffineConstraints< double > > constraints
 

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
 
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
 
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
 
- Private Member Functions inherited from MGTransferComponentBase
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_component
 
unsigned int mg_selected_component
 
std::vector< IndexSetinterface_dofs
 
- Private Attributes inherited from MGTransferComponentBase
ComponentMask component_mask
 
ComponentMask mg_component_mask
 
std::vector< unsigned int > target_component
 
std::vector< unsigned int > mg_target_component
 
std::vector< std::vector< types::global_dof_index > > sizes
 
std::vector< types::global_dof_indexcomponent_start
 
std::vector< std::vector< types::global_dof_index > > mg_component_start
 
std::vector< std::shared_ptr< BlockSparseMatrix< double > > > prolongation_matrices
 
std::vector< std::vector< std::pair< types::global_dof_index, unsigned int > > > copy_to_and_from_indices
 
std::vector< std::set< types::global_dof_index > > boundary_indices
 

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 MGTransferComponentBase
static ::ExceptionBaseExcMatricesNotBuilt ()
 

Detailed Description

template<typename number>
class MGTransferSelect< number >

Implementation of the MGTransferBase interface for block matrices and simple vectors. This class uses MGTransferComponentBase selecting a single component or grouping several components into a single block. The transfer operators themselves are implemented for Vector and BlockVector objects.

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

Author
Guido Kanschat, 2001, 2002, 2003

Definition at line 178 of file mg_transfer_component.h.

Constructor & Destructor Documentation

◆ MGTransferSelect() [1/2]

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

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

Definition at line 206 of file multigrid.cc.

◆ MGTransferSelect() [2/2]

template<typename number >
MGTransferSelect< number >::MGTransferSelect ( const AffineConstraints< double > &  constraints)

Constructor with constraint matrices.

Definition at line 213 of file multigrid.cc.

◆ ~MGTransferSelect()

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

Destructor.

Member Function Documentation

◆ build_matrices()

template<typename number >
template<int dim, int spacedim>
void MGTransferSelect< number >::build_matrices ( const DoFHandler< dim, spacedim > &  dof,
const DoFHandler< dim, spacedim > &  mg_dof,
unsigned int  selected,
unsigned int  mg_selected,
const std::vector< unsigned int > &  target_component = std::vector<unsigned int>(),
const std::vector< unsigned int > &  mg_target_component = std::vector<unsigned int>(),
const std::vector< std::set< types::global_dof_index >> &  boundary_indices = std::vector<std::set<types::global_dof_index>>() 
)

Actually build the prolongation matrices for grouped components.

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

  • selected: Number of the block of the global vector to be copied from and to the multilevel vector. This number refers to the renumbering by target_component.
  • mg_selected: Number of the block for which the transfer matrices should be built.

If mg_target_component is present, this refers to the renumbered components.

  • mg_target_component: this argument allows grouping and renumbering of components in the level vectors (see DoFRenumbering::component_wise). It also affects the behavior of the selected argument
  • boundary_indices: holds the boundary indices on each level.

Definition at line 569 of file mg_transfer_component.cc.

◆ select()

template<typename number >
void MGTransferSelect< number >::select ( const unsigned int  component,
const unsigned int  mg_component = numbers::invalid_unsigned_int 
)
inline

Change selected component. Handle with care!

Definition at line 386 of file mg_transfer_component.h.

◆ prolongate()

template<typename number >
void MGTransferSelect< 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 223 of file multigrid.cc.

◆ restrict_and_add()

template<typename number >
void MGTransferSelect< 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 240 of file multigrid.cc.

◆ copy_to_mg() [1/2]

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

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

◆ copy_from_mg() [1/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferSelect< 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 MGTransferSelect< 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 MGTransferSelect< number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< Vector< number >> &  dst,
const BlockVector< number2 > &  src 
) const

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

◆ copy_from_mg() [2/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferSelect< 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 MGTransferSelect< 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 MGTransferSelect< number >::memory_consumption ( ) const

Memory used by this object.

◆ do_copy_from_mg()

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

Implementation of the public function.

◆ do_copy_from_mg_add()

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

Implementation of the public function.

◆ do_copy_to_mg()

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

Actual implementation of copy_to_mg().

Definition at line 217 of file mg_transfer_component.cc.

Member Data Documentation

◆ selected_component

template<typename number >
unsigned int MGTransferSelect< number >::selected_component
private

Selected component of global vector.

Definition at line 361 of file mg_transfer_component.h.

◆ mg_selected_component

template<typename number >
unsigned int MGTransferSelect< number >::mg_selected_component
private

Selected component inside multigrid.

Definition at line 365 of file mg_transfer_component.h.

◆ interface_dofs

template<typename number >
std::vector<IndexSet> MGTransferSelect< number >::interface_dofs
private

The degrees of freedom on the refinement edges. For each level the index set denotes which level degrees of freedom are on the refinement edge towards the lower level, excluding boundary dofs.

Definition at line 372 of file mg_transfer_component.h.

◆ constraints

template<typename number >
SmartPointer<const AffineConstraints<double> > MGTransferSelect< number >::constraints

The constraints of the global system.

Definition at line 378 of file mg_transfer_component.h.


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