internal::MGTwoLevelTransferCore< dim, VectorType > Class Template Reference

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

Detailed Description

template<int dim, typename VectorType>
class internal::MGTwoLevelTransferCore< dim, VectorType >

Base class for MGTwoLevelTransferNonNested and MGTwoLevelTransfer.

Definition at line 205 of file mg_transfer_matrix_free.h.

Inheritance diagram for internal::MGTwoLevelTransferCore< dim, VectorType >:

Public Types
using	Number = typename VectorType::value_type

Public Member Functions
	MGTwoLevelTransferCore ()
void	prolongate_and_add (VectorType &dst, const VectorType &src) const override
void	restrict_and_add (VectorType &dst, const VectorType &src) const override
virtual void	interpolate (VectorType &dst, const VectorType &src) const =0
virtual std::pair< bool, bool >	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
virtual std::pair< const DoFHandler< dim > *, unsigned int >	get_dof_handler_fine () const =0
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
Querying the observer pointers an object has.
unsigned int	n_subscriptions () const
template<typename StreamType >
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Public Attributes
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_coarse
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_fine

Protected Member Functions
virtual void	prolongate_and_add_internal (VectorType &dst, const VectorType &src) const =0
virtual void	restrict_and_add_internal (VectorType &dst, const VectorType &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<std::size_t width, typename IndexType >
std::pair< bool, bool >	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
VectorType	vec_coarse
VectorType	vec_fine
bool	vec_fine_needs_ghost_update
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_coarse_embedded
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_fine_embedded
AlignedVector< Number >	buffer_coarse_embedded
AlignedVector< Number >	buffer_fine_embedded

Private Member Functions
EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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
void	check_no_subscribers () const noexcept

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

Member Typedef Documentation

Number

template<int dim, typename VectorType >

using internal::MGTwoLevelTransferCore< dim, VectorType >::Number = typename VectorType::value_type

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

Definition at line 211 of file mg_transfer_matrix_free.h.

Constructor & Destructor Documentation

MGTwoLevelTransferCore()

template<int dim, typename VectorType >

internal::MGTwoLevelTransferCore< dim, VectorType >::MGTwoLevelTransferCore

(

)

Constructor.

Member Function Documentation

prolongate_and_add()

template<int dim, typename VectorType >

void internal::MGTwoLevelTransferCore< dim, VectorType >::prolongate_and_add ( VectorType &  dst, const VectorType &  src  ) const

overridevirtual

Perform prolongation on a solution vector.

Implements MGTwoLevelTransferBase< dim, VectorType >.

restrict_and_add()

template<int dim, typename VectorType >

void internal::MGTwoLevelTransferCore< dim, VectorType >::restrict_and_add ( VectorType &  dst, const VectorType &  src  ) const

overridevirtual

Perform restriction on a residual vector.

Implements MGTwoLevelTransferBase< dim, VectorType >.

prolongate_and_add_internal()

template<int dim, typename VectorType >

virtual void internal::MGTwoLevelTransferCore< dim, VectorType >::prolongate_and_add_internal ( VectorType &  dst, const VectorType &  src  ) const

protectedpure virtual

Perform prolongation on vectors with correct ghosting.

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

restrict_and_add_internal()

template<int dim, typename VectorType >

virtual void internal::MGTwoLevelTransferCore< dim, VectorType >::restrict_and_add_internal ( VectorType &  dst, const VectorType &  src  ) const

protectedpure virtual

Perform restriction on vectors with correct ghosting.

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

update_ghost_values()

template<int dim, typename VectorType >

void internal::MGTwoLevelTransferCore< dim, 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<int dim, typename VectorType >

void internal::MGTwoLevelTransferCore< dim, 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<int dim, typename VectorType >

void internal::MGTwoLevelTransferCore< dim, 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<int dim, typename VectorType >

template<std::size_t width, typename IndexType >

std::pair< bool, bool > internal::MGTwoLevelTransferCore< dim, 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.

interpolate()

template<int dim, typename VectorType >

virtual void MGTwoLevelTransferBase< dim, VectorType >::interpolate ( VectorType &  dst, const VectorType &  src  ) const

pure virtualinherited

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 >, MGTwoLevelTransferCopyToHost< dim, VectorType >, MGTwoLevelTransferNonNested< dim, VectorType >, and Portable::MGTwoLevelTransfer< dim, VectorType >.

enable_inplace_operations_if_possible()

template<int dim, typename VectorType >

virtual std::pair< bool, bool > MGTwoLevelTransferBase< dim, 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 virtualinherited

Enable inplace vector operations if external and internal vectors are compatible. The returned pair indicates if the operation was successful on the coarse and the fine level.

Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector< Number, MemorySpace::Host > >, MGTwoLevelTransfer< dim, Vector< Number, MemorySpace::Host > >, MGTwoLevelTransferCopyToHost< dim, VectorType >, MGTwoLevelTransferNonNested< dim, VectorType >, and Portable::MGTwoLevelTransfer< dim, VectorType >.

memory_consumption()

template<int dim, typename VectorType >

virtual std::size_t MGTwoLevelTransferBase< dim, VectorType >::memory_consumption ( ) const

pure virtualinherited

Return the memory consumption of the allocated memory in this class.

Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector< Number, MemorySpace::Host > >, MGTwoLevelTransfer< dim, Vector< Number, MemorySpace::Host > >, MGTwoLevelTransferCopyToHost< dim, VectorType >, MGTwoLevelTransferNonNested< dim, VectorType >, and Portable::MGTwoLevelTransfer< dim, VectorType >.

get_dof_handler_fine()

template<int dim, typename VectorType >

virtual std::pair< const DoFHandler< dim > *, unsigned int > MGTwoLevelTransferBase< dim, VectorType >::get_dof_handler_fine ( ) const

pure virtualinherited

Return the DoFHandler associated with the fine level and the level index.

Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector< Number, MemorySpace::Host > >, MGTwoLevelTransfer< dim, Vector< Number, MemorySpace::Host > >, MGTwoLevelTransferCopyToHost< dim, VectorType >, MGTwoLevelTransferNonNested< dim, VectorType >, and Portable::MGTwoLevelTransfer< dim, VectorType >.

n_subscriptions()

unsigned int EnableObserverPointer::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 318 of file enable_observer_pointer.h.

list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType &  stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 335 of file enable_observer_pointer.h.

list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 200 of file enable_observer_pointer.cc.

serialize()

template<class Archive >

void EnableObserverPointer::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 327 of file enable_observer_pointer.h.

subscribe()

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

privateinherited

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 enable_observer_pointer.cc.

unsubscribe()

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

privateinherited

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 154 of file enable_observer_pointer.cc.

check_no_subscribers()

void EnableObserverPointer::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 58 of file enable_observer_pointer.cc.

Member Data Documentation

fine_element_is_continuous

template<int dim, typename VectorType >

bool internal::MGTwoLevelTransferCore< dim, 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 290 of file mg_transfer_matrix_free.h.

vec_coarse

template<int dim, typename VectorType >

VectorType internal::MGTwoLevelTransferCore< dim, VectorType >::vec_coarse

mutableprotected

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

Definition at line 297 of file mg_transfer_matrix_free.h.

vec_fine

template<int dim, typename VectorType >

VectorType internal::MGTwoLevelTransferCore< dim, 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 306 of file mg_transfer_matrix_free.h.

vec_fine_needs_ghost_update

template<int dim, typename VectorType >

bool internal::MGTwoLevelTransferCore< dim, VectorType >::vec_fine_needs_ghost_update

protected

Bool indicating whether fine vector has relevant ghost values.

Definition at line 311 of file mg_transfer_matrix_free.h.

partitioner_coarse_embedded

template<int dim, typename VectorType >

std::shared_ptr<const Utilities::MPI::Partitioner> internal::MGTwoLevelTransferCore< dim, 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 318 of file mg_transfer_matrix_free.h.

partitioner_fine_embedded

template<int dim, typename VectorType >

std::shared_ptr<const Utilities::MPI::Partitioner> internal::MGTwoLevelTransferCore< dim, 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 325 of file mg_transfer_matrix_free.h.

buffer_coarse_embedded

template<int dim, typename VectorType >

AlignedVector<Number> internal::MGTwoLevelTransferCore< dim, VectorType >::buffer_coarse_embedded

mutableprotected

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

Definition at line 331 of file mg_transfer_matrix_free.h.

buffer_fine_embedded

template<int dim, typename VectorType >

AlignedVector<Number> internal::MGTwoLevelTransferCore< dim, VectorType >::buffer_fine_embedded

mutableprotected

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

Definition at line 337 of file mg_transfer_matrix_free.h.

partitioner_coarse

template<int dim, typename VectorType >

std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< dim, VectorType >::partitioner_coarse

inherited

Partitioner needed by the intermediate vector.

Definition at line 142 of file mg_transfer_matrix_free.h.

partitioner_fine

template<int dim, typename VectorType >

std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< dim, VectorType >::partitioner_fine

inherited

Partitioner needed by the intermediate vector.

Definition at line 147 of file mg_transfer_matrix_free.h.

counter

std::atomic<unsigned int> EnableObserverPointer::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 212 of file enable_observer_pointer.h.

counter_map

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

mutableprivateinherited

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

Definition at line 218 of file enable_observer_pointer.h.

validity_pointers

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

mutableprivateinherited

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

Definition at line 224 of file enable_observer_pointer.h.

object_info

const std::type_info* EnableObserverPointer::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 232 of file enable_observer_pointer.h.

mutex

std::mutex EnableObserverPointer::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 239 of file enable_observer_pointer.h.

---

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

• include/deal.II/multigrid/mg_transfer_matrix_free.h