gko::multigrid::Pmis< ValueType, IndexType > Class Template Reference

Parallel modified independent set (Pmis) is the classical coarsening method introduced in the paper H. More...

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

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

Collaboration diagram for gko::multigrid::Pmis< ValueType, IndexType >:

Classes
class	Factory
struct	parameters_type

Public Types
using	value_type = ValueType
using	index_type = IndexType
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
	Returns the system operator (matrix) of the linear system. More...
const parameters_type &	get_parameters () const
Public Member Functions inherited from gko::LinOp
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
	Performs the operation x = alpha * op(b) + beta * x. More...
const dim< 2 > &	get_size () const noexcept
	Returns the size of the operator. More...
virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...
LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...
LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...
	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...
	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...
Public Member Functions inherited from gko::PolymorphicObject
virtual void	validate_data () const
	Throws gko::InvalidData exception if we found the data inside the object does not fulfill certain property up to our knowledge.
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
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::multigrid::EnableMultigridLevel< ValueType >
std::shared_ptr< const LinOp >	get_fine_op () const override
	Returns the operator on fine level. More...
std::shared_ptr< const LinOp >	get_restrict_op () const override
	Returns the restrict operator. More...
std::shared_ptr< const LinOp >	get_coarse_op () const override
	Returns the operator on coarse level. More...
std::shared_ptr< const LinOp >	get_prolong_op () const override
	Returns the prolong operator. More...
Public Member Functions inherited from gko::UseComposition< ValueType >
std::shared_ptr< Composition< ValueType > >	get_composition () const
	Returns the composition operators. More...
std::shared_ptr< const LinOp >	get_operator_at (size_type index) const
	Returns the operator at index-th position of composition. More...

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 >())
	Create the parameters from the property_tree. More...

Detailed Description

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

Parallel modified independent set (Pmis) is the classical coarsening method introduced in the paper H.

De Sterck et al., "Reducing complexity in parallel algebraic multigrid preconditioners".

Pmis creates the coarse- and fine-points group according to the matrix value not the structure.

Template Parameters

ValueType	precision of matrix elements
IndexType	precision of matrix indices

Member Function Documentation

get_system_matrix()

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

std::shared_ptr<const LinOp> gko::multigrid::Pmis< 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::Pmis< 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 file:

• ginkgo/core/multigrid/pmis.hpp