A Schwarz preconditioner is a simple domain decomposition preconditioner that generalizes the Block Jacobi preconditioner, incorporating options for different local subdomain solvers and overlaps between the subdomains. More...

#include <ginkgo/core/distributed/preconditioner/schwarz.hpp>

Inheritance diagram for gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >:

[legend]

Collaboration diagram for gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >:

[legend]

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = ValueType

using	index_type = GlobalIndexType

using	local_index_type = LocalIndexType

using	global_index_type = GlobalIndexType

Public Types inherited from gko::EnablePolymorphicAssignment< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >
using	result_type = Schwarz< ValueType, LocalIndexType, GlobalIndexType >

Public Types inherited from gko::ConvertibleTo< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >
using	result_type = Schwarz< ValueType, LocalIndexType, GlobalIndexType >

Public Member Functions
bool	apply_uses_initial_guess () const override
	Return whether the local solvers use the data in x as an initial guess. More...

const parameters_type &	get_parameters () const

Public Member Functions inherited from gko::EnableLinOp< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >
const Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	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< Schwarz< ValueType, LocalIndexType, GlobalIndexType >, LinOp >
std::unique_ptr< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >	create_default () const

std::unique_ptr< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >	clone () const

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Schwarz< ValueType, LocalIndexType, GlobalIndexType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Schwarz< ValueType, LocalIndexType, GlobalIndexType > > *	copy_from (const std::unique_ptr< Derived > &other)

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	move_from (ptr_param< PolymorphicObject > other)

Schwarz< ValueType, LocalIndexType, GlobalIndexType > *	clear ()

Public Member Functions inherited from gko::LinOp
LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

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

LinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
	Performs the operation x = alpha * op(b) + beta * x. More...

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

const dim< 2 > &	get_size () const noexcept
	Returns the size of the operator. 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::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOp >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< LinOp >	create_default () const

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

std::unique_ptr< LinOp >	clone () const

LinOp *	copy_from (const PolymorphicObject *other)

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

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

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

LinOp *	move_from (ptr_param< PolymorphicObject > other)

LinOp *	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
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	create_default () const
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...

std::unique_ptr< PolymorphicObject >	clone () const
	Creates a clone of the object. More...

PolymorphicObject *	copy_from (const PolymorphicObject *other)
	Copies another object into this object. More...

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)
	Moves another object into this object. More...

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)
	Copies another object into this object. More...

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)
	Moves another object into this object. More...

PolymorphicObject *	clear ()
	Transforms the object into its default state. More...

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::EnablePolymorphicAssignment< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...

void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...

Public Member Functions inherited from gko::ConvertibleTo< Schwarz< ValueType, LocalIndexType, GlobalIndexType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

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

Friends
class	EnableLinOp< Schwarz >

class	EnablePolymorphicObject< Schwarz, LinOp >

Detailed Description

template<typename ValueType = default_precision, typename LocalIndexType = int32, typename GlobalIndexType = int64>
class gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >

A Schwarz preconditioner is a simple domain decomposition preconditioner that generalizes the Block Jacobi preconditioner, incorporating options for different local subdomain solvers and overlaps between the subdomains.

See Iterative Methods for Sparse Linear Systems (Y. Saad) for a general treatment and variations of the method.

Note: Currently overlap and coarse grid correction are not supported (TODO).

Template Parameters

ValueType	precision of matrix element
LocalIndexType	local integer type of the matrix
GlobalIndexType	global integer type of the matrix

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision, typename LocalIndexType = int32, typename GlobalIndexType = int64>

bool gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >::apply_uses_initial_guess ( ) const

overridevirtual

Return whether the local solvers use the data in x as an initial guess.

Returns: true when the local solvers use the data in x as an initial guess. otherwise, false.

Note: TODO: after adding refining step, need to revisit this.

Reimplemented from gko::LinOp.

◆ parse()

template<typename ValueType = default_precision, typename LocalIndexType = int32, typename GlobalIndexType = int64>

static parameters_type gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >::parse	(	const config::pnode &	config,
		const config::registry &	context,
		const config::type_descriptor &	td_for_child = `config::make_type_descriptor< ValueType, LocalIndexType, GlobalIndexType >()`
	)

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 objects.

Parameters

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

Returns: parameters

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

ginkgo/core/distributed/preconditioner/schwarz.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<typename ValueType = default_precision, typename LocalIndexType = int32, typename GlobalIndexType = int64> class gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >

Member Function Documentation

◆ apply_uses_initial_guess()

◆ parse()

template<typename ValueType = default_precision, typename LocalIndexType = int32, typename GlobalIndexType = int64>
class gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >