Reference documentation for deal.II version Git f982bbb689 2019-09-17 15:49:08 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MGLevelGlobalTransfer< VectorType > Class Template Reference

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

Inheritance diagram for MGLevelGlobalTransfer< VectorType >:
[legend]

Public Member Functions

void clear ()
 
template<int dim, class InVector , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< VectorType > &dst, const InVector &src) const
 
template<int dim, class OutVector , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< VectorType > &src) const
 
template<int dim, class OutVector , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< VectorType > &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
 
- Public Member Functions inherited from MGTransferBase< VectorType >
virtual ~MGTransferBase () override=default
 
virtual void prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const =0
 
virtual void restrict_and_add (const unsigned int from_level, VectorType &dst, const VectorType &src) const =0
 
- 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)
 

Protected Member Functions

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

Protected Attributes

std::vector< types::global_dof_indexsizes
 
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > copy_indices
 
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > copy_indices_global_mine
 
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > copy_indices_level_mine
 
bool perform_plain_copy
 
std::vector< unsigned int > component_to_block_map
 
SmartPointer< const MGConstrainedDoFs, MGLevelGlobalTransfer< VectorType > > mg_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)
 

Detailed Description

template<typename VectorType>
class MGLevelGlobalTransfer< VectorType >

Implementation of transfer between the global vectors and the multigrid levels for use in the derived class MGTransferPrebuilt and other classes.

Author
Wolfgang Bangerth, Guido Kanschat, Timo Heister, Martin Kronbichler
Date
1999, 2000, 2001, 2002, 2003, 2004, 2012, 2015

Definition at line 282 of file mg_transfer.h.

Member Function Documentation

◆ clear()

template<typename VectorType >
void MGLevelGlobalTransfer< VectorType >::clear ( )

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

Definition at line 99 of file mg_level_global_transfer.cc.

◆ copy_to_mg()

template<typename VectorType >
template<int dim, class InVector , int spacedim>
void MGLevelGlobalTransfer< VectorType >::copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
MGLevelObject< VectorType > &  dst,
const InVector &  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 VectorType >
template<int dim, class OutVector , int spacedim>
void MGLevelGlobalTransfer< VectorType >::copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof,
OutVector &  dst,
const MGLevelObject< VectorType > &  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.

◆ copy_from_mg_add()

template<typename VectorType >
template<int dim, class OutVector , int spacedim>
void MGLevelGlobalTransfer< VectorType >::copy_from_mg_add ( const DoFHandler< dim, spacedim > &  mg_dof,
OutVector &  dst,
const MGLevelObject< VectorType > &  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 VectorType >
void MGLevelGlobalTransfer< VectorType >::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 VectorType >
std::size_t MGLevelGlobalTransfer< VectorType >::memory_consumption ( ) const

Memory used by this object.

Definition at line 143 of file mg_level_global_transfer.cc.

◆ print_indices()

template<typename VectorType >
void MGLevelGlobalTransfer< VectorType >::print_indices ( std::ostream &  os) const

Print the copy index fields for debugging purposes.

Definition at line 114 of file mg_level_global_transfer.cc.

◆ fill_and_communicate_copy_indices()

template<typename VectorType >
template<int dim, int spacedim>
void MGLevelGlobalTransfer< VectorType >::fill_and_communicate_copy_indices ( const DoFHandler< dim, spacedim > &  mg_dof)
protected

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

Definition at line 51 of file mg_level_global_transfer.cc.

Member Data Documentation

◆ sizes

template<typename VectorType >
std::vector<types::global_dof_index> MGLevelGlobalTransfer< VectorType >::sizes
protected

Sizes of the multi-level vectors.

Definition at line 368 of file mg_transfer.h.

◆ copy_indices

template<typename VectorType >
std::vector< std::vector<std::pair<types::global_dof_index, types::global_dof_index> > > MGLevelGlobalTransfer< VectorType >::copy_indices
protected

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

The data is organized as follows: one vector per level. Each element of these vectors contains first the global index, then the level index.

Definition at line 379 of file mg_transfer.h.

◆ copy_indices_global_mine

template<typename VectorType >
std::vector< std::vector<std::pair<types::global_dof_index, types::global_dof_index> > > MGLevelGlobalTransfer< VectorType >::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_mine.

Definition at line 390 of file mg_transfer.h.

◆ copy_indices_level_mine

template<typename VectorType >
std::vector< std::vector<std::pair<types::global_dof_index, types::global_dof_index> > > MGLevelGlobalTransfer< VectorType >::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_mine.

Definition at line 401 of file mg_transfer.h.

◆ perform_plain_copy

template<typename VectorType >
bool MGLevelGlobalTransfer< VectorType >::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 409 of file mg_transfer.h.

◆ component_to_block_map

template<typename VectorType >
std::vector<unsigned int> MGLevelGlobalTransfer< VectorType >::component_to_block_map
protected

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

Definition at line 415 of file mg_transfer.h.

◆ mg_constrained_dofs

template<typename VectorType >
SmartPointer<const MGConstrainedDoFs, MGLevelGlobalTransfer<VectorType> > MGLevelGlobalTransfer< VectorType >::mg_constrained_dofs
protected

The mg_constrained_dofs of the level systems.

Definition at line 421 of file mg_transfer.h.


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