Reference documentation for deal.II version GIT 2f5445400b 2023-02-05 22:30:02+00:00
MGTransferBlockMatrixFree< dim, Number > Class Template Reference

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

Inheritance diagram for MGTransferBlockMatrixFree< dim, Number >:
[legend]

## Public Member Functions

MGTransferBlockMatrixFree ()=default

MGTransferBlockMatrixFree (const MGConstrainedDoFs &mg_constrained_dofs)

MGTransferBlockMatrixFree (const std::vector< MGConstrainedDoFs > &mg_constrained_dofs)

virtual ~MGTransferBlockMatrixFree () override=default

void initialize_constraints (const MGConstrainedDoFs &mg_constrained_dofs)

void initialize_constraints (const std::vector< MGConstrainedDoFs > &mg_constrained_dofs)

void clear ()

void build (const DoFHandler< dim, dim > &dof_handler)

void build (const std::vector< const DoFHandler< dim, dim > * > &dof_handler)

std::size_t memory_consumption () const

virtual void prolongate (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override

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

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

virtual void restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override

void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const BlockVectorType2 &src) const

void copy_to_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const BlockVectorType2 &src) const

void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &src) const

void copy_from_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< 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)

## Static Public Attributes

static const bool supports_dof_handler_vector

## Protected Member Functions

const MGTransferMatrixFree< dim, Number > & get_matrix_free_transfer (const unsigned int b) const override

## Protected Attributes

const bool same_for_all

## Private Types

using map_value_type = decltype(counter_map)::value_type

using map_iterator = decltype(counter_map)::iterator

## Private Member Functions

void check_no_subscribers () const noexcept

## Private Attributes

std::vector< MGTransferMatrixFree< dim, Number > > matrix_free_transfer_vector

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 Private Attributes

static std::mutex mutex

## Detailed Description

### template<int dim, typename Number> class MGTransferBlockMatrixFree< dim, Number >

Implementation of the MGTransferBase interface for which the transfer operations is implemented in a matrix-free way based on the interpolation matrices of the underlying finite element. This requires considerably less memory than MGTransferPrebuilt and can also be considerably faster than that variant.

This class works with LinearAlgebra::distributed::BlockVector and performs exactly the same transfer operations for each block as MGTransferMatrixFree. Both the cases that the same DoFHandler is used for all the blocks and that each block uses its own DoFHandler are supported.

Definition at line 466 of file mg_transfer_matrix_free.h.

## ◆ map_value_type

 using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

## ◆ map_iterator

 using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

## ◆ MGTransferBlockMatrixFree() [1/3]

template<int dim, typename Number >
 MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( )
default

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

## ◆ MGTransferBlockMatrixFree() [2/3]

template<int dim, typename Number >
 MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( const MGConstrainedDoFs & mg_constrained_dofs )

Constructor with constraints. Equivalent to the default constructor followed by initialize_constraints().

Definition at line 709 of file mg_transfer_matrix_free.cc.

## ◆ MGTransferBlockMatrixFree() [3/3]

template<int dim, typename Number >
 MGTransferBlockMatrixFree< dim, Number >::MGTransferBlockMatrixFree ( const std::vector< MGConstrainedDoFs > & mg_constrained_dofs )

Same as above for the case that each block has its own DoFHandler.

Definition at line 721 of file mg_transfer_matrix_free.cc.

## ◆ ~MGTransferBlockMatrixFree()

template<int dim, typename Number >
 virtual MGTransferBlockMatrixFree< dim, Number >::~MGTransferBlockMatrixFree ( )
overridevirtualdefault

Destructor.

## ◆ initialize_constraints() [1/2]

template<int dim, typename Number >
 void MGTransferBlockMatrixFree< dim, Number >::initialize_constraints ( const MGConstrainedDoFs & mg_constrained_dofs )

Initialize the constraints to be used in build().

Definition at line 735 of file mg_transfer_matrix_free.cc.

## ◆ initialize_constraints() [2/2]

template<int dim, typename Number >
 void MGTransferBlockMatrixFree< dim, Number >::initialize_constraints ( const std::vector< MGConstrainedDoFs > & mg_constrained_dofs )

Same as above for the case that each block has its own DoFHandler.

Definition at line 751 of file mg_transfer_matrix_free.cc.

## ◆ clear()

template<int dim, typename Number >
 void MGTransferBlockMatrixFree< dim, Number >::clear

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

Definition at line 814 of file mg_transfer_matrix_free.cc.

## ◆ build() [1/2]

template<int dim, typename Number >
 void MGTransferBlockMatrixFree< dim, Number >::build ( const DoFHandler< dim, dim > & dof_handler )

Actually build the information for the prolongation for each level.

Definition at line 769 of file mg_transfer_matrix_free.cc.

## ◆ build() [2/2]

template<int dim, typename Number >
 void MGTransferBlockMatrixFree< dim, Number >::build ( const std::vector< const DoFHandler< dim, dim > * > & dof_handler )

Same as above for the case that each block has its own DoFHandler.

Definition at line 780 of file mg_transfer_matrix_free.cc.

## ◆ memory_consumption()

template<int dim, typename Number >
 std::size_t MGTransferBlockMatrixFree< dim, Number >::memory_consumption

Memory used by this object.

Definition at line 792 of file mg_transfer_matrix_free.cc.

## ◆ get_matrix_free_transfer()

template<int dim, typename Number >
 const MGTransferMatrixFree< dim, Number > & MGTransferBlockMatrixFree< dim, Number >::get_matrix_free_transfer ( const unsigned int b ) const
overrideprotectedvirtual

Return the right non-block transfer operator. Has to be implemented by the derived class.

Definition at line 804 of file mg_transfer_matrix_free.cc.

## ◆ prolongate()

 virtual void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::prolongate ( const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > & dst, const LinearAlgebra::distributed::BlockVector< Number > & src ) const
overridevirtualinherited

Prolongate a vector from level to_level-1 to level to_level using the embedding matrices of the underlying finite element. The previous content of dst is overwritten.

Parameters
 to_level The index of the level to prolongate to, which is the level 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.

 virtual void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::prolongate_and_add ( const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > & dst, const LinearAlgebra::distributed::BlockVector< Number > & src ) const
overridevirtualinherited

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

 virtual void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::restrict_and_add ( const unsigned int from_level, LinearAlgebra::distributed::BlockVector< Number > & dst, const LinearAlgebra::distributed::BlockVector< Number > & src ) const
overridevirtualinherited

Restrict a vector from level from_level to level from_level-1 using the transpose operation of the prolongate() method. 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.

Parameters
 from_level The index of the level to restrict from, which is the level of src. src is a vector with as many elements as there are degrees of freedom on the finer level involved. dst has as many elements as there are degrees of freedom on the coarser level.

## ◆ copy_to_mg() [1/2]

 void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::copy_to_mg ( const DoFHandler< dim, spacedim > & dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> & dst, const BlockVectorType2 & src ) const
inherited

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

This function will initialize dst accordingly if needed as required by the Multigrid class.

## ◆ copy_to_mg() [2/2]

 void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::copy_to_mg ( const std::vector< const DoFHandler< dim, spacedim > * > & dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> & dst, const BlockVectorType2 & src ) const
inherited

Same as above for the case that each block has its own DoFHandler.

## ◆ copy_from_mg() [1/2]

 void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::copy_from_mg ( const DoFHandler< dim, spacedim > & dof_handler, BlockVectorType2 & dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> & src ) const
inherited

Transfer from multi-level block-vector to normal vector.

## ◆ copy_from_mg() [2/2]

 void MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::copy_from_mg ( const std::vector< const DoFHandler< dim, spacedim > * > & dof_handler, BlockVectorType2 & dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> & src ) const
inherited

Same as above for the case that each block has its own DoFHandler.

## ◆ 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 300 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 317 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 309 of file subscriptor.h.

## ◆ check_no_subscribers()

 void Subscriptor::check_no_subscribers ( ) const
privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

## ◆ matrix_free_transfer_vector

template<int dim, typename Number >
 std::vector > MGTransferBlockMatrixFree< dim, Number >::matrix_free_transfer_vector
private

Non-block matrix-free versions of transfer operation.

Definition at line 540 of file mg_transfer_matrix_free.h.

## ◆ supports_dof_handler_vector

 const bool MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::supports_dof_handler_vector
staticinherited

This class can both be used with a single DoFHandler or a separate DoFHandler for each block.

Definition at line 433 of file mg_transfer_matrix_free.h.

## ◆ same_for_all

 const bool MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >::same_for_all
protectedinherited

A flag to indicate whether the same DoFHandler is used for all the components or if each block has its own DoFHandler.

Definition at line 447 of file mg_transfer_matrix_free.h.

## ◆ counter

 std::atomic Subscriptor::counter
mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 219 of file subscriptor.h.

## ◆ counter_map

 std::map Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

## ◆ validity_pointers

 std::vector *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

## ◆ object_info

 const std::type_info* Subscriptor::object_info
mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 249 of file subscriptor.h.

## ◆ mutex

 std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.

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