![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
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>
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< default_precision, int32, int64 > > | |
using | result_type |
Public Types inherited from gko::ConvertibleTo< Schwarz< default_precision, int32, int64 > > | |
using | result_type |
Public Member Functions | |
bool | apply_uses_initial_guess () const override |
Return whether the local solvers use the data in x as an initial guess. | |
const parameters_type & | get_parameters () const |
Public Member Functions inherited from gko::EnableLinOp< Schwarz< default_precision, int32, int64 > > | |
const Schwarz< default_precision, int32, int64 > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Schwarz< default_precision, int32, int64 >, LinOp > | |
std::unique_ptr< Schwarz< default_precision, int32, int64 > > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< Schwarz< default_precision, int32, int64 > > | clone (std::shared_ptr< const Executor > exec) const |
Schwarz< default_precision, int32, int64 > * | copy_from (const PolymorphicObject *other) |
Schwarz< default_precision, int32, int64 > * | move_from (ptr_param< PolymorphicObject > other) |
Schwarz< default_precision, int32, int64 > * | 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). | |
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. | |
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. | |
LinOp & | operator= (const LinOp &)=default |
Copy-assigns a LinOp. | |
LinOp & | operator= (LinOp &&other) |
Move-assigns a LinOp. | |
LinOp (const LinOp &)=default | |
Copy-constructs a LinOp. | |
LinOp (LinOp &&other) | |
Move-constructs a LinOp. | |
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 > | clone (std::shared_ptr< const Executor > exec) const |
LinOp * | copy_from (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. | |
std::unique_ptr< PolymorphicObject > | create_default () const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
Creates a clone of the object. | |
std::unique_ptr< PolymorphicObject > | clone () const |
Creates a clone of the object. | |
PolymorphicObject * | copy_from (const PolymorphicObject *other) |
Copies another object into this object. | |
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. | |
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. | |
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Copies another object into this object. | |
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
Moves another object into this object. | |
PolymorphicObject * | clear () |
Transforms the object into its default state. | |
std::shared_ptr< const Executor > | get_executor () const noexcept |
Returns the Executor of the object. | |
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject > | |
void | add_logger (std::shared_ptr< const Logger > logger) override |
Adds a new logger to the list of subscribed loggers. | |
void | remove_logger (const Logger *logger) override |
Removes a logger from the list of subscribed loggers. | |
const std::vector< std::shared_ptr< const Logger > > & | get_loggers () const override |
Returns the vector containing all loggers registered at this object. | |
void | clear_loggers () override |
Remove all loggers registered at this object. | |
Public Member Functions inherited from gko::log::Loggable | |
void | remove_logger (ptr_param< const Logger > logger) |
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Schwarz< default_precision, int32, int64 > > | |
void | convert_to (result_type *result) const override |
void | move_to (result_type *result) override |
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. |
Friends | |
class | EnableLinOp< Schwarz > |
class | EnablePolymorphicObject< Schwarz, LinOp > |
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.
A L1 smoother variant is also available, which updates the local matrix with the sums of the non-local matrix row sums.
See Iterative Methods for Sparse Linear Systems (Y. Saad) for a general treatment and variations of the method.
A Two-level variant is also available. To enable two-level preconditioning, you need to specify a LinOpFactory that can generate a multigrid::MultigridLevel and a solver for the coarse level solution. Currently, only additive coarse correction is supported with an optional weighting between the local and the coarse solutions, for cases when the coarse solutions might tend to overcorrect.
ValueType | precision of matrix element |
LocalIndexType | local integer type of the matrix |
GlobalIndexType | global integer type of the matrix |
|
overridevirtual |
Return whether the local solvers use the data in x as an initial guess.
Reimplemented from gko::LinOp.
|
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.
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. |