#include <ginkgo/core/multigrid/pgm.hpp>

Inheritance diagram for gko::multigrid::Pgm< ValueType, IndexType >:

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = ValueType

using	index_type = IndexType

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using	result_type = ConcreteLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Types inherited from gko::multigrid::EnableMultigridLevel< ValueType >
using	value_type = ValueType

Public Types inherited from gko::UseComposition< ValueType >
using	value_type = ValueType

Public Member Functions
std::shared_ptr< const LinOp >	get_system_matrix () const

IndexType *	get_agg () noexcept

const IndexType *	get_const_agg () const noexcept

const parameters_type &	get_parameters () const

Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
const ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (std::unique_ptr< Derived > &&other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (const std::unique_ptr< Derived > &other)

AbstractObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::multigrid::EnableMultigridLevel< ValueType >
std::shared_ptr< const LinOp >	get_fine_op () const override

std::shared_ptr< const LinOp >	get_restrict_op () const override

std::shared_ptr< const LinOp >	get_coarse_op () const override

std::shared_ptr< const LinOp >	get_prolong_op () const override

Public Member Functions inherited from gko::UseComposition< ValueType >
std::shared_ptr< Composition< ValueType > >	get_composition () const

std::shared_ptr< const LinOp >	get_operator_at (size_type index) const

Static Public Member Functions
static auto	build () -> decltype(Factory ::create())

static parameters_type	parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())

Protected Member Functions
void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

	Pgm (std::shared_ptr< const Executor > exec)

	Pgm (const Factory *factory, std::shared_ptr< const LinOp > system_matrix)

void	generate ()

std::tuple< std::shared_ptr< LinOp >, std::shared_ptr< LinOp >, std::shared_ptr< LinOp > >	generate_local (std::shared_ptr< const matrix::Csr< ValueType, IndexType > > local_matrix)

template<typename GlobalIndexType >
void	communicate (std::shared_ptr< const experimental::distributed::Matrix< ValueType, IndexType, GlobalIndexType > > matrix, const array< IndexType > &local_agg, array< IndexType > &non_local_agg)

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Protected Member Functions inherited from gko::multigrid::EnableMultigridLevel< ValueType >
void	set_multigrid_level (std::shared_ptr< const LinOp > prolong_op, std::shared_ptr< const LinOp > coarse_op, std::shared_ptr< const LinOp > restrict_op)

void	set_fine_op (std::shared_ptr< const LinOp > fine_op)

	EnableMultigridLevel (std::shared_ptr< const LinOp > fine_op)

Protected Member Functions inherited from gko::UseComposition< ValueType >
void	set_composition (LinOp &&... linop)

Friends
class	EnableLinOp< Pgm >

class	EnablePolymorphicObject< Pgm, LinOp >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::multigrid::Pgm< ValueType, IndexType >

Parallel graph match (Pgm) is the aggregate method introduced in the paper M. Naumov et al., "AmgX: A Library for GPU Accelerated Algebraic Multigrid and Preconditioned Iterative Methods". Current implementation only contains size = 2 version.

Pgm creates the aggregate group according to the matrix value not the structure. Pgm gives two steps (one-phase handshaking) to group the elements. 1: get the strongest neighbor of each unaggregated element. 2: group the elements whose strongest neighbor is each other. repeating until reaching the given conditions. After that, the un-aggregated elements are assigned to an aggregated group or are left alone.

Template Parameters

ValueType	precision of matrix elements
IndexType	precision of matrix indexes

Member Function Documentation

◆ generate_local()

template<typename ValueType = default_precision, typename IndexType = int32>

std::tuple< std::shared_ptr< LinOp >, std::shared_ptr< LinOp >, std::shared_ptr< LinOp > > gko::multigrid::Pgm< ValueType, IndexType >::generate_local ( std::shared_ptr< const matrix::Csr< ValueType, IndexType > > local_matrix )

protected

This function generates the local matrix coarsening operators.

Returns: a tuple with prolongation, coarse, and restriction linop

◆ get_agg()

template<typename ValueType = default_precision, typename IndexType = int32>

IndexType * gko::multigrid::Pgm< ValueType, IndexType >::get_agg ( )

inlinenoexcept

Returns the aggregate group.

Aggregate group whose size is same as the number of rows. Stores the mapping information from row index to coarse row index. i.e., agg[row_idx] = coarse_row_idx.

Returns: the aggregate group.

References gko::array< ValueType >::get_data().

◆ get_const_agg()

template<typename ValueType = default_precision, typename IndexType = int32>

const IndexType * gko::multigrid::Pgm< ValueType, IndexType >::get_const_agg ( ) const

inlinenoexcept

Returns the aggregate group.

Aggregate group whose size is same as the number of rows. Stores the mapping information from row index to coarse row index. i.e., agg[row_idx] = coarse_row_idx.

Returns: the aggregate group.

Note: This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::array< ValueType >::get_const_data().

◆ get_system_matrix()

template<typename ValueType = default_precision, typename IndexType = int32>

std::shared_ptr< const LinOp > gko::multigrid::Pgm< ValueType, IndexType >::get_system_matrix ( ) const

inline

Returns the system operator (matrix) of the linear system.

Returns: the system operator (matrix)

◆ parse()

template<typename ValueType = default_precision, typename IndexType = int32>

static parameters_type gko::multigrid::Pgm< ValueType, IndexType >::parse	(	const config::pnode &	config,
		const config::registry &	context,
		const config::type_descriptor &	td_for_child = `config::make_type_descriptor< ValueType, IndexType >()`
	)

static

Create the parameters from the property_tree. Because this is directly tied to the specific type, the value/index type settings within config are ignored and type_descriptor is only used for children configs.

Parameters

config	the property tree for setting
context	the registry
td_for_child	the type descriptor for children configs. The default uses the value/index type of this class.

Returns: parameters

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

ginkgo/core/distributed/matrix.hpp
ginkgo/core/multigrid/pgm.hpp

Pgm< ValueType, IndexType > Class Template Reference

Pgm< ValueType, IndexType > Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ generate_local()

◆ get_agg()

◆ get_const_agg()

◆ get_system_matrix()

◆ parse()

Pgm< ValueType, IndexType > Class Template Reference

Pgm&lt; ValueType, IndexType &gt; Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ generate_local()

◆ get_agg()

◆ get_const_agg()

◆ get_system_matrix()

◆ parse()

Pgm< ValueType, IndexType > Class Template Reference#