Reference documentation for deal.II version Git 5a2787e538 2021-09-21 14:55:10 -0600
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Static 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 (const DoFHandler< dim, spacedim > &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
 
virtual void prolongate_and_add (const unsigned int to_level, Vector< number > &dst, const Vector< number > &src) const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

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
 
template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler)
 

Static Private Member Functions

static ::ExceptionBaseExcMatricesNotBuilt ()
 

Private Attributes

unsigned int selected_component
 
unsigned int mg_selected_component
 
std::vector< IndexSetinterface_dofs
 
ComponentMask component_mask
 
ComponentMask mg_component_mask
 
std::vector< unsigned inttarget_component
 
std::vector< unsigned intmg_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
 

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.

Definition at line 173 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 198 of file multigrid.cc.

◆ MGTransferSelect() [2/2]

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

Constructor with constraint matrices.

Definition at line 205 of file multigrid.cc.

◆ ~MGTransferSelect()

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

Destructor.

Member Function Documentation

◆ build() [1/2]

template<typename number >
template<int dim, int spacedim>
void MGTransferSelect< number >::build ( const DoFHandler< dim, spacedim > &  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 564 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 379 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 215 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 232 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 215 of file mg_transfer_component.cc.

◆ prolongate_and_add()

void MGTransferBase< Vector< number > >::prolongate_and_add ( const unsigned int  to_level,
Vector< number > &  dst,
const Vector< number > &  src 
) const
virtualinherited

Prolongate a vector from level to_level-1 to level to_level, summing into the previous content of dst.

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

Definition at line 47 of file mg_base.cc.

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 301 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 310 of file subscriptor.h.

◆ build() [2/2]

template<int dim, int spacedim>
void MGTransferComponentBase::build ( const DoFHandler< dim, spacedim > &  dof_handler)
protectedinherited

Actually build the prolongation matrices for each level.

This function is only called by derived classes. These can also set the member variables selected_component and mg_selected_component member variables to restrict the transfer matrices to certain components. Furthermore, they use target_component and mg_target_component for re-ordering and grouping of components.

Definition at line 257 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 354 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 358 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 365 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 371 of file mg_transfer_component.h.

◆ component_mask

ComponentMask MGTransferComponentBase::component_mask
protectedinherited

Flag of selected components.

The transfer operators only act on the components having a true entry here. If renumbering by target_component is used, this refers to the renumbered components.

Definition at line 93 of file mg_transfer_component.h.

◆ mg_component_mask

ComponentMask MGTransferComponentBase::mg_component_mask
protectedinherited

Flag of selected components.

The transfer operators only act on the components having a true entry here. If renumbering by mg_target_component is used, this refers to the renumbered components.

Definition at line 102 of file mg_transfer_component.h.

◆ target_component

std::vector<unsigned int> MGTransferComponentBase::target_component
protectedinherited

Target component of the fine-level vector if renumbering is required.

Definition at line 107 of file mg_transfer_component.h.

◆ mg_target_component

std::vector<unsigned int> MGTransferComponentBase::mg_target_component
protectedinherited

Target component if renumbering of level vectors is required.

Definition at line 112 of file mg_transfer_component.h.

◆ sizes

std::vector<std::vector<types::global_dof_index> > MGTransferComponentBase::sizes
mutableprotectedinherited

Sizes of the multi-level vectors.

Definition at line 117 of file mg_transfer_component.h.

◆ component_start

std::vector<types::global_dof_index> MGTransferComponentBase::component_start
protectedinherited

Start index of each component.

Definition at line 122 of file mg_transfer_component.h.

◆ mg_component_start

std::vector<std::vector<types::global_dof_index> > MGTransferComponentBase::mg_component_start
protectedinherited

Start index of each component on all levels.

Definition at line 127 of file mg_transfer_component.h.

◆ prolongation_matrices

std::vector<std::shared_ptr<BlockSparseMatrix<double> > > MGTransferComponentBase::prolongation_matrices
protectedinherited

The actual prolongation matrix. column indices belong to the dof indices of the mother cell, i.e. the coarse level. while row indices belong to the child cell, i.e. the fine level.

Definition at line 143 of file mg_transfer_component.h.

◆ copy_to_and_from_indices

std::vector<std::vector<std::pair<types::global_dof_index, unsigned int> > > MGTransferComponentBase::copy_to_and_from_indices
protectedinherited

This variable holds the mapping for the copy_to/from_mg-functions. The data is first the global index, then the level index.

Definition at line 150 of file mg_transfer_component.h.

◆ boundary_indices

std::vector<std::set<types::global_dof_index> > MGTransferComponentBase::boundary_indices
protectedinherited

Store the boundary_indices. These are needed for the boundary values in the restriction matrix.

Definition at line 156 of file mg_transfer_component.h.


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