MGTwoLevelTransferCopyToHost< dim, VectorType > Class Template Reference

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

Detailed Description

template<int dim, typename VectorType>
class MGTwoLevelTransferCopyToHost< dim, VectorType >

A transfer class supporting device vectors via copying them to the host and using an internal transfer of type MGTwoLevelTransfer defined on the host.

Definition at line 698 of file mg_transfer_matrix_free.h.

Inheritance diagram for MGTwoLevelTransferCopyToHost< dim, VectorType >:

Public Types
using	Number = typename VectorType::value_type
using	VectorTypeHost = LinearAlgebra::distributed::Vector< Number, MemorySpace::Host >

Public Member Functions
	MGTwoLevelTransferCopyToHost ()=default
void	reinit (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int)
void	reinit (const MatrixFree< dim, Number > &matrix_free_fine, const unsigned int dof_handler_index_fine, const MatrixFree< dim, Number > &matrix_free_coarse, const unsigned int dof_handler_index_coarse)
bool	fast_polynomial_transfer_supported (const unsigned int fe_degree_fine, const unsigned int fe_degree_coarse)
void	prolongate_and_add (VectorType &dst, const VectorType &src) const override
void	restrict_and_add (VectorType &dst, const VectorType &src) const override
void	interpolate (VectorType &dst, const VectorType &src) const override
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) override
std::size_t	memory_consumption () const override
std::pair< const DoFHandler< dim > *, unsigned int >	get_dof_handler_fine () const override
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

Private Member Functions
void	copy_to_host (VectorTypeHost &dst, const VectorType &src) const
void	copy_from_host (VectorType &dst, const VectorTypeHost &src) const
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
MGTwoLevelTransfer< dim, VectorTypeHost >	host_transfer
VectorTypeHost	host_vector_coarse
VectorTypeHost	host_vector_fine
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

Friends
class	internal::MGTwoLevelTransferImplementation
class	MGTransferMatrixFree< dim, Number, typename VectorType::memory_space >

Member Typedef Documentation

Number

template<int dim, typename VectorType >

using MGTwoLevelTransferCopyToHost< dim, VectorType >::Number = typename VectorType::value_type

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

Definition at line 713 of file mg_transfer_matrix_free.h.

VectorTypeHost

template<int dim, typename VectorType >

using MGTwoLevelTransferCopyToHost< dim, VectorType >::VectorTypeHost = LinearAlgebra::distributed::Vector<Number, MemorySpace::Host>

Definition at line 718 of file mg_transfer_matrix_free.h.

Constructor & Destructor Documentation

MGTwoLevelTransferCopyToHost()

template<int dim, typename VectorType >

MGTwoLevelTransferCopyToHost< dim, VectorType >::MGTwoLevelTransferCopyToHost ( )

default

Default constructor.

Member Function Documentation

reinit() [1/2]

template<int dim, typename VectorType >

void MGTwoLevelTransferCopyToHost< dim, VectorType >::reinit	(	const DoFHandler< dim > &	dof_handler_fine,
		const DoFHandler< dim > &	dof_handler_coarse,
		const AffineConstraints< Number > &	constraint_fine = AffineConstraints< Number >(),
		const AffineConstraints< Number > &	constraint_coarse = AffineConstraints< Number >(),
		const unsigned int	mg_level_fine = numbers::invalid_unsigned_int,
		const unsigned int	mg_level_coarse = numbers::invalid_unsigned_int
	)

See MGTwoLevelTransfer

reinit() [2/2]

template<int dim, typename VectorType >

void MGTwoLevelTransferCopyToHost< dim, VectorType >::reinit	(	const MatrixFree< dim, Number > &	matrix_free_fine,
		const unsigned int	dof_handler_index_fine,
		const MatrixFree< dim, Number > &	matrix_free_coarse,
		const unsigned int	dof_handler_index_coarse
	)

See MGTwoLevelTransfer

fast_polynomial_transfer_supported()

template<int dim, typename VectorType >

bool MGTwoLevelTransferCopyToHost< dim, VectorType >::fast_polynomial_transfer_supported	(	const unsigned int	fe_degree_fine,
		const unsigned int	fe_degree_coarse
	)

Check if a fast templated version of the polynomial transfer between fe_degree_fine and fe_degree_coarse is available.

Note

Currently, the polynomial coarsening strategies: 1) go-to-one, 2) bisect, and 3) decrease-by-one are precompiled with templates for degrees up to 9.

prolongate_and_add()

template<int dim, typename VectorType >

void MGTwoLevelTransferCopyToHost< 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 MGTwoLevelTransferCopyToHost< dim, VectorType >::restrict_and_add ( VectorType &  dst, const VectorType &  src  ) const

overridevirtual

Perform restriction on a residual vector.

Implements MGTwoLevelTransferBase< dim, VectorType >.

interpolate()

template<int dim, typename VectorType >

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

overridevirtual

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.

Implements MGTwoLevelTransferBase< dim, VectorType >.

enable_inplace_operations_if_possible()

template<int dim, typename VectorType >

std::pair< bool, bool > MGTwoLevelTransferCopyToHost< 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  )

overridevirtual

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

Implements MGTwoLevelTransferBase< dim, VectorType >.

memory_consumption()

template<int dim, typename VectorType >

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

overridevirtual

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

Implements MGTwoLevelTransferBase< dim, VectorType >.

get_dof_handler_fine()

template<int dim, typename VectorType >

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

overridevirtual

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

Implements MGTwoLevelTransferBase< dim, VectorType >.

copy_to_host()

template<int dim, typename VectorType >

void MGTwoLevelTransferCopyToHost< dim, VectorType >::copy_to_host ( VectorTypeHost &  dst, const VectorType &  src  ) const

private

Copies a device vector to a host vector.

copy_from_host()

template<int dim, typename VectorType >

void MGTwoLevelTransferCopyToHost< dim, VectorType >::copy_from_host ( VectorType &  dst, const VectorTypeHost &  src  ) const

private

Copies a host vector to a device vector.

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.

Friends And Related Symbol Documentation

internal::MGTwoLevelTransferImplementation

template<int dim, typename VectorType >

friend class internal::MGTwoLevelTransferImplementation

friend

Definition at line 823 of file mg_transfer_matrix_free.h.

MGTransferMatrixFree< dim, Number, typename VectorType::memory_space >

template<int dim, typename VectorType >

friend class MGTransferMatrixFree< dim, Number, typename VectorType::memory_space >

friend

Definition at line 823 of file mg_transfer_matrix_free.h.

Member Data Documentation

host_transfer

template<int dim, typename VectorType >

MGTwoLevelTransfer<dim, VectorTypeHost> MGTwoLevelTransferCopyToHost< dim, VectorType >::host_transfer

private

The internal transfer defined on the host which handles all operations.

Definition at line 799 of file mg_transfer_matrix_free.h.

host_vector_coarse

template<int dim, typename VectorType >

VectorTypeHost MGTwoLevelTransferCopyToHost< dim, VectorType >::host_vector_coarse

mutableprivate

Temporary vector used for the host transfer.

Definition at line 804 of file mg_transfer_matrix_free.h.

host_vector_fine

template<int dim, typename VectorType >

VectorTypeHost MGTwoLevelTransferCopyToHost< dim, VectorType >::host_vector_fine

mutableprivate

Temporary vector used for the host transfer.

Definition at line 809 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