Reference documentation for deal.II version GIT 969cfe8cd8 2022-06-28 20:20:01+00:00
MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > > Class Template Referenceabstract

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

Inheritance diagram for MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >:
[legend]

## Public Member Functions

void clear ()

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

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

template<int dim, typename Number2 , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &dof_handler, LinearAlgebra::distributed::Vector< Number2 > &dst, const MGLevelObject< LinearAlgebra::distributed::Vector< Number >> &src) const

void set_component_to_block_map (const std::vector< unsigned int > &map)

std::size_t memory_consumption () const

void print_indices (std::ostream &os) const

virtual void prolongate (const unsigned int to_level, LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const=0

virtual void prolongate_and_add (const unsigned int to_level, LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const

virtual void restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const=0

## Protected Member Functions

template<int dim, typename Number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< LinearAlgebra::distributed::Vector< Number >> &dst, const LinearAlgebra::distributed::Vector< Number2 > &src, const bool solution_transfer) const

template<int dim, int spacedim>
void fill_and_communicate_copy_indices (const DoFHandler< dim, spacedim > &dof_handler)

## Protected Attributes

std::vector< types::global_dof_indexsizes

std::vector< Table< 2, unsigned int > > copy_indices

std::vector< Table< 2, unsigned int > > solution_copy_indices

std::vector< Table< 2, unsigned int > > copy_indices_global_mine

std::vector< Table< 2, unsigned int > > solution_copy_indices_global_mine

std::vector< Table< 2, unsigned int > > copy_indices_level_mine

std::vector< Table< 2, unsigned int > > solution_copy_indices_level_mine

bool perform_plain_copy

bool perform_renumbered_plain_copy

std::vector< unsigned int > component_to_block_map

SmartPointer< const MGConstrainedDoFs, MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > > > mg_constrained_dofs

LinearAlgebra::distributed::Vector< Number > ghosted_global_vector

LinearAlgebra::distributed::Vector< Number > solution_ghosted_global_vector

MGLevelObject< LinearAlgebra::distributed::Vector< Number > > ghosted_level_vector

MGLevelObject< LinearAlgebra::distributed::Vector< Number > > solution_ghosted_level_vector

std::function< void(const unsigned int, LinearAlgebra::distributed::Vector< Number > &)> initialize_dof_vector

## Private Member Functions

template<int dim, int spacedim>
void assert_built (const DoFHandler< dim, spacedim > &dof_handler) const

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

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

void check_no_subscribers () const noexcept

using map_value_type = decltype(counter_map)::value_type

using map_iterator = decltype(counter_map)::iterator

std::atomic< unsigned int > counter

std::map< std::string, unsigned int > counter_map

std::vector< std::atomic< bool > * > validity_pointers

const std::type_info * object_info

static std::mutex mutex

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

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Detailed Description

### template<typename Number> class MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >

Implementation of transfer between the global vectors and the multigrid levels for use in the derived class MGTransferPrebuilt and other classes. This class is a specialization for the case of LinearAlgebra::distributed::Vector that requires a few different calling routines as compared to the parallel vectors in the PETScWrappers and TrilinosWrappers namespaces.

Definition at line 412 of file mg_transfer.h.

## ◆ clear()

template<typename Number >
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::clear

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

Definition at line 386 of file mg_level_global_transfer.cc.

## ◆ copy_to_mg() [1/2]

template<typename Number >
template<int dim, typename Number2 , int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_to_mg ( const DoFHandler< dim, spacedim > & dof_handler, MGLevelObject< LinearAlgebra::distributed::Vector< Number >> & dst, const LinearAlgebra::distributed::Vector< Number2 > & src ) const

Transfer from a vector on the global grid to vectors defined on each of the levels separately 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()

template<typename Number >
template<int dim, typename Number2 , int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_from_mg ( const DoFHandler< dim, spacedim > & dof_handler, LinearAlgebra::distributed::Vector< Number2 > & dst, const MGLevelObject< LinearAlgebra::distributed::Vector< Number >> & src ) const

Transfer from multi-level vector to normal vector.

Copies data from active portions of an MGVector into the respective positions of a Vector<number>. In order to keep the result consistent, constrained degrees of freedom are set to zero.

template<typename Number >
template<int dim, typename Number2 , int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_from_mg_add ( const DoFHandler< dim, spacedim > & dof_handler, LinearAlgebra::distributed::Vector< Number2 > & dst, const MGLevelObject< LinearAlgebra::distributed::Vector< Number >> & src ) const

Add a multi-level vector to a normal vector.

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

## ◆ set_component_to_block_map()

template<typename Number >
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::set_component_to_block_map ( const std::vector< unsigned int > & map )

If this object operates on BlockVector objects, we need to describe how the individual vector components are mapped to the blocks of a vector. For example, for a Stokes system, we have dim+1 vector components for velocity and pressure, but we may want to use block vectors with only two blocks for all velocities in one block, and the pressure variables in the other.

By default, if this function is not called, block vectors have as many blocks as the finite element has vector components. However, this can be changed by calling this function with an array that describes how vector components are to be grouped into blocks. The meaning of the argument is the same as the one given to the DoFTools::count_dofs_per_component function.

## ◆ memory_consumption()

template<typename Number >
 std::size_t MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::memory_consumption

Memory used by this object.

Definition at line 436 of file mg_level_global_transfer.cc.

## ◆ print_indices()

template<typename Number >
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::print_indices ( std::ostream & os ) const

Print the copy index fields for debugging purposes.

Definition at line 404 of file mg_level_global_transfer.cc.

## ◆ copy_to_mg() [2/2]

template<typename Number >
template<int dim, typename Number2 , int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_to_mg ( const DoFHandler< dim, spacedim > & dof_handler, MGLevelObject< LinearAlgebra::distributed::Vector< Number >> & dst, const LinearAlgebra::distributed::Vector< Number2 > & src, const bool solution_transfer ) const
protected

Internal function to perform transfer of residuals or solutions basesd on the flag solution_transfer.

## ◆ fill_and_communicate_copy_indices()

template<typename Number >
template<int dim, int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::fill_and_communicate_copy_indices ( const DoFHandler< dim, spacedim > & dof_handler )
protected

Internal function to fill copy_indices*. Called by derived classes.

Definition at line 284 of file mg_level_global_transfer.cc.

## ◆ assert_built()

template<typename Number >
template<int dim, int spacedim>
 void MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::assert_built ( const DoFHandler< dim, spacedim > & dof_handler ) const
private

This function is called to make sure that build() has been invoked.

## ◆ prolongate()

 virtual void MGTransferBase< LinearAlgebra::distributed::Vector< Number > >::prolongate ( const unsigned int to_level, LinearAlgebra::distributed::Vector< Number > & dst, const LinearAlgebra::distributed::Vector< Number > & src ) const
pure virtualinherited

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.

Implemented in MGTransferMatrixFree< dim, Number >.

 void MGTransferBase< LinearAlgebra::distributed::Vector< Number > >::prolongate_and_add ( const unsigned int to_level, LinearAlgebra::distributed::Vector< Number > & dst, const LinearAlgebra::distributed::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 205 of file mg_base.cc.

 virtual void MGTransferBase< LinearAlgebra::distributed::Vector< Number > >::restrict_and_add ( const unsigned int from_level, LinearAlgebra::distributed::Vector< Number > & dst, const LinearAlgebra::distributed::Vector< Number > & src ) const
pure virtualinherited

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.

Implemented in MGTransferMatrixFree< dim, Number >.

## ◆ sizes

template<typename Number >
 std::vector MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::sizes
protected

Sizes of the multi-level vectors.

Definition at line 513 of file mg_transfer.h.

## ◆ copy_indices

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_indices
protected

Mapping for the copy_to_mg() and copy_from_mg() functions. Here only index pairs locally owned is stored.

The data is organized as follows: one table per level. This table has two rows. The first row contains the global index, the second one the level index.

Definition at line 523 of file mg_transfer.h.

## ◆ solution_copy_indices

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::solution_copy_indices
protected

Same as above, but used to transfer solution vectors.

Definition at line 528 of file mg_transfer.h.

## ◆ copy_indices_global_mine

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_indices_global_mine
protected

Additional degrees of freedom for the copy_to_mg() function. These are the ones where the global degree of freedom is locally owned and the level degree of freedom is not.

Organization of the data is like for copy_indices.

Definition at line 537 of file mg_transfer.h.

## ◆ solution_copy_indices_global_mine

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::solution_copy_indices_global_mine
protected

Same as above, but used to transfer solution vectors.

Definition at line 542 of file mg_transfer.h.

## ◆ copy_indices_level_mine

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::copy_indices_level_mine
protected

Additional degrees of freedom for the copy_from_mg() function. These are the ones where the level degree of freedom is locally owned and the global degree of freedom is not.

Organization of the data is like for copy_indices.

Definition at line 551 of file mg_transfer.h.

## ◆ solution_copy_indices_level_mine

template<typename Number >
 std::vector > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::solution_copy_indices_level_mine
protected

Same as above, but used to transfer solution vectors.

Definition at line 556 of file mg_transfer.h.

## ◆ perform_plain_copy

template<typename Number >
 bool MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::perform_plain_copy
protected

This variable stores whether the copy operation from the global to the level vector is actually a plain copy to the finest level. This means that the grid has no adaptive refinement and the numbering on the finest multigrid level is the same as in the global case.

Definition at line 564 of file mg_transfer.h.

## ◆ perform_renumbered_plain_copy

template<typename Number >
 bool MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::perform_renumbered_plain_copy
protected

This variable stores whether the copy operation from the global to the level vector is actually a plain copy to the finest level except for a renumbering within the finest level of the degrees of freedom. This means that the grid has no adaptive refinement.

Definition at line 572 of file mg_transfer.h.

## ◆ component_to_block_map

template<typename Number >
 std::vector MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::component_to_block_map
protected

The vector that stores what has been given to the set_component_to_block_map() function.

Definition at line 578 of file mg_transfer.h.

## ◆ mg_constrained_dofs

template<typename Number >
 SmartPointer< const MGConstrainedDoFs, MGLevelGlobalTransfer > > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::mg_constrained_dofs
protected

The mg_constrained_dofs of the level systems.

Definition at line 586 of file mg_transfer.h.

## ◆ ghosted_global_vector

template<typename Number >
 LinearAlgebra::distributed::Vector MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::ghosted_global_vector
mutableprotected

In the function copy_to_mg, we need to access ghosted entries of the global vector for inserting into the level vectors. This vector is populated with those entries.

Definition at line 593 of file mg_transfer.h.

## ◆ solution_ghosted_global_vector

template<typename Number >
 LinearAlgebra::distributed::Vector MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::solution_ghosted_global_vector
mutableprotected

Same as above but used when working with solution vectors.

Definition at line 599 of file mg_transfer.h.

## ◆ ghosted_level_vector

template<typename Number >
 MGLevelObject > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::ghosted_level_vector
mutableprotected

In the function copy_from_mg, we access all level vectors with certain ghost entries for inserting the result into a global vector.

Definition at line 606 of file mg_transfer.h.

## ◆ solution_ghosted_level_vector

template<typename Number >
 MGLevelObject > MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::solution_ghosted_level_vector
mutableprotected

Same as above but used when working with solution vectors.

Definition at line 612 of file mg_transfer.h.

## ◆ initialize_dof_vector

template<typename Number >
 std::function &)> MGLevelGlobalTransfer< LinearAlgebra::distributed::Vector< Number > >::initialize_dof_vector
protected

Function to initialize internal level vectors.

Definition at line 619 of file mg_transfer.h.

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