5#ifndef GKO_PUBLIC_CORE_PRECONDITIONER_GAUSS_SEIDEL_HPP_
6#define GKO_PUBLIC_CORE_PRECONDITIONER_GAUSS_SEIDEL_HPP_
11#include <ginkgo/core/base/abstract_factory.hpp>
12#include <ginkgo/core/base/composition.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/polymorphic_object.hpp>
15#include <ginkgo/core/config/config.hpp>
32template <
typename ValueType = default_precision,
typename IndexType =
int32>
43 using value_type = ValueType;
44 using index_type = IndexType;
56 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
61 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
85 std::shared_ptr<const LinOp> system_matrix)
const;
90 static parameters_type parse(
93 config::make_type_descriptor<ValueType, IndexType>());
96 explicit GaussSeidel(std::shared_ptr<const Executor> exec,
97 const parameters_type& params = {})
102 std::unique_ptr<LinOp> generate_impl(
103 std::shared_ptr<const LinOp> system_matrix)
const override;
106 parameters_type parameters_;
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:743
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
This class generates the Gauss-Seidel preconditioner.
Definition gauss_seidel.hpp:36
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition gauss_seidel.hpp:70
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition gauss_seidel.hpp:88
std::unique_ptr< composition_type > generate(std::shared_ptr< const LinOp > system_matrix) const
Creates a new product from the given components.
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition gauss_seidel.hpp:75
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
The Preconditioner namespace.
Definition gauss_seidel.hpp:19
The Ginkgo namespace.
Definition abstract_factory.hpp:20
Definition gauss_seidel.hpp:48