5#ifndef GKO_PUBLIC_CORE_SOLVER_IR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_IR_HPP_
12#include <ginkgo/core/base/exception_helpers.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/types.hpp>
15#include <ginkgo/core/config/config.hpp>
16#include <ginkgo/core/config/registry.hpp>
17#include <ginkgo/core/matrix/dense.hpp>
18#include <ginkgo/core/matrix/identity.hpp>
19#include <ginkgo/core/solver/solver_base.hpp>
20#include <ginkgo/core/stop/combined.hpp>
21#include <ginkgo/core/stop/criterion.hpp>
22#include <ginkgo/core/stop/iteration.hpp>
81template <
typename ValueType = default_precision>
92 using value_type = ValueType;
106 return this->get_default_initial_guess() ==
115 std::shared_ptr<const LinOp>
get_solver()
const {
return solver_; }
161 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
203 config::make_type_descriptor<ValueType>());
206 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
208 template <
typename VectorType>
209 void apply_dense_impl(
const VectorType* b, VectorType* x,
213 LinOp* x)
const override;
215 void apply_with_initial_guess_impl(
const LinOp* b,
LinOp* x,
218 void apply_with_initial_guess_impl(
const LinOp* alpha,
const LinOp* b,
222 void set_relaxation_factor(
225 explicit Ir(std::shared_ptr<const Executor> exec)
229 explicit Ir(
const Factory* factory,
230 std::shared_ptr<const LinOp> system_matrix)
234 EnableIterativeBase<Ir>{
236 parameters_{factory->get_parameters()}
240 }
else if (parameters_.
solver) {
242 parameters_.
solver->generate(this->get_system_matrix()));
253 std::shared_ptr<const LinOp> solver_{};
254 std::shared_ptr<const matrix::Dense<ValueType>> relaxation_factor_{};
258template <
typename ValueType = default_precision>
259using Richardson = Ir<ValueType>;
262template <
typename ValueType>
266 static int num_vectors(
const Solver&);
268 static int num_arrays(
const Solver&);
270 static std::vector<std::string> op_names(
const Solver&);
272 static std::vector<std::string> array_names(
const Solver&);
274 static std::vector<int> scalars(
const Solver&);
276 static std::vector<int> vectors(
const Solver&);
279 constexpr static int residual = 0;
281 constexpr static int inner_solution = 1;
283 constexpr static int one = 2;
285 constexpr static int minus_one = 3;
288 constexpr static int stop = 0;
302template <
typename ValueType>
304 size_type iteration = 1, ValueType relaxation_factor = 0.9)
306 auto exec = factory->get_executor();
308 .with_solver(factory)
309 .with_relaxation_factor(relaxation_factor)
310 .with_criteria(gko::stop::Iteration::build().with_max_iters(iteration))
326template <
typename ValueType>
328 size_type iteration = 1, ValueType relaxation_factor = 0.9)
330 auto exec = solver->get_executor();
332 .with_generated_solver(solver)
333 .with_relaxation_factor(relaxation_factor)
334 .with_criteria(gko::stop::Iteration::build().with_max_iters(iteration))
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
Definition lin_op.hpp:118
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:211
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:434
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:168
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:37
Dense is a matrix format which explicitly stores all values of the matrix.
Definition sparsity_csr.hpp:26
static std::unique_ptr< Identity > create(std::shared_ptr< const Executor > exec, dim< 2 > size)
Creates an Identity matrix of the specified size.
EnableApplyWithInitialGuess providing default operation for ApplyWithInitialGuess with correct valida...
Definition solver_base.hpp:162
A LinOp deriving from this CRTP class stores a stopping criterion factory and allows applying with a ...
Definition solver_base.hpp:704
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:542
Iterative refinement (IR) is an iterative method that uses another coarse method to approximate the e...
Definition ir.hpp:86
Ir(const Ir &)
Copy-constructs an IR solver.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
Ir & operator=(Ir &&)
Move-assigns an IR solver.
Ir(Ir &&)
Move-constructs an IR solver.
void set_solver(std::shared_ptr< const LinOp > new_solver)
Sets the solver operator used as the inner solver.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType >())
Create the parameters from the property_tree.
std::shared_ptr< const LinOp > get_solver() const
Returns the solver operator used as the inner solver.
Definition ir.hpp:115
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition ir.hpp:104
Ir & operator=(const Ir &)
Copy-assigns an IR solver.
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition abstract_factory.hpp:394
std::unique_ptr< Matrix > initialize(size_type stride, std::initializer_list< typename Matrix::value_type > vals, std::shared_ptr< const Executor > exec, TArgs &&... create_args)
Creates and initializes a column-vector.
Definition dense.hpp:1540
#define GKO_ENABLE_LIN_OP_FACTORY(_lin_op, _parameters_name, _factory_name)
This macro will generate a default implementation of a LinOpFactory for the LinOp subclass it is defi...
Definition lin_op.hpp:1018
std::shared_ptr< const CriterionFactory > combine(FactoryContainer &&factories)
Combines multiple criterion factories into a single combined criterion factory.
Definition combined.hpp:110
initial_guess_mode
Give a initial guess mode about the input of the apply method.
Definition solver_base.hpp:34
@ provided
the input is provided
auto build_smoother(std::shared_ptr< const LinOpFactory > factory, size_type iteration=1, ValueType relaxation_factor=0.9)
build_smoother gives a shortcut to build a smoother by IR(Richardson) with limited stop criterion(ite...
Definition ir.hpp:303
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86
initial_guess_mode default_initial_guess
Default initial guess mode.
Definition ir.hpp:182
std::shared_ptr< const LinOpFactory > solver
Inner solver factory.
Definition ir.hpp:162
std::shared_ptr< const LinOp > generated_solver
Already generated solver.
Definition ir.hpp:169
ValueType relaxation_factor
Relaxation factor for Richardson iteration.
Definition ir.hpp:175
Definition solver_base.hpp:830
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239