Reference documentation for deal.II version GIT relicensing-480-geae235577e 2024-04-25 01:00:02+00:00
\(\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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
MGTwoLevelTransferBase< VectorType > Class Template Referenceabstract

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

Inheritance diagram for MGTwoLevelTransferBase< VectorType >:
Inheritance graph
[legend]

Public Types

using Number = typename VectorType::value_type
 

Public Member Functions

 MGTwoLevelTransferBase ()
 
void prolongate_and_add (VectorType &dst, const VectorType &src) const
 
void restrict_and_add (VectorType &dst, const VectorType &src) const
 
virtual void interpolate (VectorType &dst, const VectorType &src) const =0
 
virtual void enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine)=0
 
virtual std::size_t memory_consumption () const =0
 
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

std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_coarse
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_fine
 

Protected Member Functions

virtual void prolongate_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0
 
virtual void restrict_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0
 
void update_ghost_values (const VectorType &vec) const
 
void compress (VectorType &vec, const VectorOperation::values op) const
 
void zero_out_ghost_values (const VectorType &vec) const
 
template<int dim, std::size_t width, typename IndexType >
void internal_enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine, bool &vec_fine_needs_ghost_update, internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &constraint_info_coarse, std::vector< unsigned int > &dof_indices_fine)
 

Protected Attributes

bool fine_element_is_continuous
 
LinearAlgebra::distributed::Vector< Numbervec_coarse
 
LinearAlgebra::distributed::Vector< Numbervec_fine
 
bool vec_fine_needs_ghost_update
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_coarse_embedded
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_fine_embedded
 
AlignedVector< Numberbuffer_coarse_embedded
 
AlignedVector< Numberbuffer_fine_embedded
 

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::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 

Static Private Attributes

static std::mutex mutex
 

Detailed Description

template<typename VectorType>
class MGTwoLevelTransferBase< VectorType >

An abstract base class for transfer operators between two multigrid levels. The implementation of restriction and prolongation between levels is delegated to derived classes, which implement prolongate_and_add_internal() and restrict_and_add_internal() accordingly.

Definition at line 218 of file mg_transfer_global_coarsening.h.

Member Typedef Documentation

◆ Number

template<typename VectorType >
using MGTwoLevelTransferBase< VectorType >::Number = typename VectorType::value_type

The scalar type used by the vector-type template argument.

Definition at line 231 of file mg_transfer_global_coarsening.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 229 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 234 of file subscriptor.h.

Constructor & Destructor Documentation

◆ MGTwoLevelTransferBase()

template<typename VectorType >
MGTwoLevelTransferBase< VectorType >::MGTwoLevelTransferBase ( )

Default constructor.

Member Function Documentation

◆ prolongate_and_add()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::prolongate_and_add ( VectorType &  dst,
const VectorType &  src 
) const

Perform prolongation on a solution vector.

◆ restrict_and_add()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::restrict_and_add ( VectorType &  dst,
const VectorType &  src 
) const

Perform restriction on a residual vector.

◆ interpolate()

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::interpolate ( VectorType &  dst,
const VectorType &  src 
) const
pure virtual

Perform interpolation of a solution vector from the fine level to the coarse level. This function is different from restriction, where a weighted residual is transferred to a coarser level (transposition of prolongation matrix). In other words, restriction acts on right hand side vectors, whereas interpolation acts on solution vectors.

Implemented in MGTwoLevelTransfer< dim, VectorType >, and MGTwoLevelTransferNonNested< dim, VectorType >.

◆ enable_inplace_operations_if_possible()

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::enable_inplace_operations_if_possible ( const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_coarse,
const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_fine 
)
pure virtual

Enable inplace vector operations if external and internal vectors are compatible.

Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector >, and MGTwoLevelTransferNonNested< dim, VectorType >.

◆ memory_consumption()

template<typename VectorType >
virtual std::size_t MGTwoLevelTransferBase< VectorType >::memory_consumption ( ) const
pure virtual

◆ prolongate_and_add_internal()

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::prolongate_and_add_internal ( LinearAlgebra::distributed::Vector< Number > &  dst,
const LinearAlgebra::distributed::Vector< Number > &  src 
) const
protectedpure virtual

Perform prolongation on vectors with correct ghosting.

◆ restrict_and_add_internal()

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::restrict_and_add_internal ( LinearAlgebra::distributed::Vector< Number > &  dst,
const LinearAlgebra::distributed::Vector< Number > &  src 
) const
protectedpure virtual

Perform restriction on vectors with correct ghosting.

◆ update_ghost_values()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::update_ghost_values ( const VectorType &  vec) const
protected

A wrapper around update_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ compress()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::compress ( VectorType &  vec,
const VectorOperation::values  op 
) const
protected

A wrapper around compress() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ zero_out_ghost_values()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::zero_out_ghost_values ( const VectorType &  vec) const
protected

A wrapper around zero_out_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ internal_enable_inplace_operations_if_possible()

template<typename VectorType >
template<int dim, std::size_t width, typename IndexType >
void MGTwoLevelTransferBase< VectorType >::internal_enable_inplace_operations_if_possible ( const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_coarse,
const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_fine,
bool vec_fine_needs_ghost_update,
internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &  constraint_info_coarse,
std::vector< unsigned int > &  dof_indices_fine 
)
protected

Enable inplace vector operations if external and internal vectors are compatible.

◆ 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 135 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 155 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 203 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 52 of file subscriptor.cc.

Member Data Documentation

◆ fine_element_is_continuous

template<typename VectorType >
bool MGTwoLevelTransferBase< VectorType >::fine_element_is_continuous
protected

Flag if the finite elements on the fine cells are continuous. If yes, the multiplicity of DoF sharing a vertex/line as well as constraints have to be taken into account via weights.

Definition at line 339 of file mg_transfer_global_coarsening.h.

◆ partitioner_coarse

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_coarse

Partitioner needed by the intermediate vector.

Definition at line 345 of file mg_transfer_global_coarsening.h.

◆ partitioner_fine

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_fine

Partitioner needed by the intermediate vector.

Definition at line 350 of file mg_transfer_global_coarsening.h.

◆ vec_coarse

template<typename VectorType >
LinearAlgebra::distributed::Vector<Number> MGTwoLevelTransferBase< VectorType >::vec_coarse
mutableprotected

Internal vector on which the actual prolongation/restriction is performed.

Definition at line 356 of file mg_transfer_global_coarsening.h.

◆ vec_fine

template<typename VectorType >
LinearAlgebra::distributed::Vector<Number> MGTwoLevelTransferBase< VectorType >::vec_fine
mutableprotected

Internal vector needed for collecting all degrees of freedom of the fine cells. It is only initialized if the fine-level DoF indices touch DoFs other than the locally active ones (which we always assume can be accessed by the given vectors in the prolongate/restrict functions), otherwise it is left at size zero.

Definition at line 365 of file mg_transfer_global_coarsening.h.

◆ vec_fine_needs_ghost_update

template<typename VectorType >
bool MGTwoLevelTransferBase< VectorType >::vec_fine_needs_ghost_update
protected

Bool indicating whether fine vector has relevant ghost values.

Definition at line 370 of file mg_transfer_global_coarsening.h.

◆ partitioner_coarse_embedded

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_coarse_embedded
protected

Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 377 of file mg_transfer_global_coarsening.h.

◆ partitioner_fine_embedded

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_fine_embedded
protected

Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 383 of file mg_transfer_global_coarsening.h.

◆ buffer_coarse_embedded

template<typename VectorType >
AlignedVector<Number> MGTwoLevelTransferBase< VectorType >::buffer_coarse_embedded
mutableprotected

Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 389 of file mg_transfer_global_coarsening.h.

◆ buffer_fine_embedded

template<typename VectorType >
AlignedVector<Number> MGTwoLevelTransferBase< VectorType >::buffer_fine_embedded
mutableprotected

Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 395 of file mg_transfer_global_coarsening.h.

◆ counter

std::atomic<unsigned int> 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 218 of file subscriptor.h.

◆ counter_map

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

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

Definition at line 224 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> 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 240 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 248 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 271 of file subscriptor.h.


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