|
Ginkgo
Generated from pipelines/1554403166 branch based on develop. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
|
5 #ifndef GKO_PUBLIC_CORE_SOLVER_IR_HPP_
6 #define GKO_PUBLIC_CORE_SOLVER_IR_HPP_
11 #include <ginkgo/core/base/exception_helpers.hpp>
12 #include <ginkgo/core/base/lin_op.hpp>
13 #include <ginkgo/core/base/types.hpp>
14 #include <ginkgo/core/config/config.hpp>
15 #include <ginkgo/core/config/registry.hpp>
16 #include <ginkgo/core/matrix/dense.hpp>
17 #include <ginkgo/core/matrix/identity.hpp>
18 #include <ginkgo/core/solver/solver_base.hpp>
19 #include <ginkgo/core/stop/combined.hpp>
20 #include <ginkgo/core/stop/criterion.hpp>
21 #include <ginkgo/core/stop/iteration.hpp>
80 template <
typename ValueType = default_precision>
91 using value_type = ValueType;
94 std::unique_ptr<LinOp>
transpose()
const override;
105 return this->get_default_initial_guess() ==
114 std::shared_ptr<const LinOp>
get_solver()
const {
return solver_; }
121 void set_solver(std::shared_ptr<const LinOp> new_solver);
160 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
202 config::make_type_descriptor<ValueType>());
205 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
207 template <
typename VectorType>
208 void apply_dense_impl(
const VectorType* b, VectorType* x,
212 LinOp* x)
const override;
214 void apply_with_initial_guess_impl(
const LinOp* b,
LinOp* x,
217 void apply_with_initial_guess_impl(
const LinOp* alpha,
const LinOp* b,
221 void set_relaxation_factor(
224 explicit Ir(std::shared_ptr<const Executor> exec)
229 std::shared_ptr<const LinOp> system_matrix)
235 parameters_{factory->get_parameters()}
239 }
else if (parameters_.
solver) {
241 parameters_.
solver->generate(this->get_system_matrix()));
247 relaxation_factor_ = gko::initialize<matrix::Dense<ValueType>>(
252 std::shared_ptr<const LinOp> solver_{};
253 std::shared_ptr<const matrix::Dense<ValueType>> relaxation_factor_{};
257 template <
typename ValueType = default_precision>
258 using Richardson = Ir<ValueType>;
261 template <
typename ValueType>
265 static int num_vectors(
const Solver&);
267 static int num_arrays(
const Solver&);
269 static std::vector<std::string> op_names(
const Solver&);
271 static std::vector<std::string> array_names(
const Solver&);
273 static std::vector<int> scalars(
const Solver&);
275 static std::vector<int> vectors(
const Solver&);
278 constexpr
static int residual = 0;
280 constexpr
static int inner_solution = 1;
282 constexpr
static int one = 2;
284 constexpr
static int minus_one = 3;
287 constexpr
static int stop = 0;
301 template <
typename ValueType>
303 size_type iteration = 1, ValueType relaxation_factor = 0.9)
305 auto exec = factory->get_executor();
307 .with_solver(factory)
308 .with_relaxation_factor(relaxation_factor)
309 .with_criteria(gko::stop::Iteration::build().with_max_iters(iteration))
325 template <
typename ValueType>
327 size_type iteration = 1, ValueType relaxation_factor = 0.9)
329 auto exec = solver->get_executor();
331 .with_generated_solver(solver)
332 .with_relaxation_factor(relaxation_factor)
333 .with_criteria(gko::stop::Iteration::build().with_max_iters(iteration))
342 #endif // GKO_PUBLIC_CORE_SOLVER_IR_HPP_
EnableApplyWithInitialGuess providing default operation for ApplyWithInitialGuess with correct valida...
Definition: solver_base.hpp:161
Ir & operator=(const Ir &)
Copy-assigns an IR solver.
pnode describes a tree of properties.
Definition: property_tree.hpp:28
A LinOp deriving from this CRTP class stores a stopping criterion factory and allows applying with a ...
Definition: solver_base.hpp:703
Definition: lin_op.hpp:117
Dense is a matrix format which explicitly stores all values of the matrix.
Definition: dense_cache.hpp:19
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.
Definition: solver_base.hpp:828
Iterative refinement (IR) is an iterative method that uses another coarse method to approximate the e...
Definition: ir.hpp:81
std::shared_ptr< const LinOp > generated_solver
Already generated solver.
Definition: ir.hpp:168
Linear operators which support transposition should implement the Transposable interface.
Definition: lin_op.hpp:433
Ir(const Ir &)
Copy-constructs an IR solver.
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:86
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
std::shared_ptr< const LinOp > get_solver() const
Returns the solver operator used as the inner solver.
Definition: ir.hpp:114
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition: abstract_factory.hpp:445
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 Ginkgo namespace.
Definition: abstract_factory.hpp:20
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
#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:1017
std::shared_ptr< const CriterionFactory > combine(FactoryContainer &&factories)
Combines multiple criterion factories into a single combined criterion factory.
Definition: combined.hpp:109
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:302
static std::unique_ptr< Identity > create(std::shared_ptr< const Executor > exec, dim< 2 > size)
Creates an Identity matrix of the specified size.
void set_solver(std::shared_ptr< const LinOp > new_solver)
Sets the solver operator used as the inner solver.
A LinOp deriving from this CRTP class stores a system matrix.
Definition: solver_base.hpp:541
initial_guess_mode default_initial_guess
Default initial guess mode.
Definition: ir.hpp:181
This class stores additional context for creating Ginkgo objects from configuration files.
Definition: registry.hpp:167
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition: ir.hpp:103
#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
initial_guess_mode
Give a initial guess mode about the input of the apply method.
Definition: solver_base.hpp:33
ValueType relaxation_factor
Relaxation factor for Richardson iteration.
Definition: ir.hpp:174
std::shared_ptr< const LinOpFactory > solver
Inner solver factory.
Definition: ir.hpp:161
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition: polymorphic_object.hpp:234
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition: solver_base.hpp:238
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition: lin_op.hpp:210
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:877
constexpr T one()
Returns the multiplicative identity for T.
Definition: math.hpp:652
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:661