5#ifndef GKO_PUBLIC_CORE_SOLVER_CG_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_CG_HPP_
12#include <ginkgo/core/base/array.hpp>
13#include <ginkgo/core/base/exception_helpers.hpp>
14#include <ginkgo/core/base/lin_op.hpp>
15#include <ginkgo/core/base/math.hpp>
16#include <ginkgo/core/base/types.hpp>
17#include <ginkgo/core/config/config.hpp>
18#include <ginkgo/core/config/registry.hpp>
19#include <ginkgo/core/config/type_descriptor.hpp>
20#include <ginkgo/core/log/logger.hpp>
21#include <ginkgo/core/matrix/dense.hpp>
22#include <ginkgo/core/matrix/identity.hpp>
23#include <ginkgo/core/solver/solver_base.hpp>
24#include <ginkgo/core/stop/combined.hpp>
25#include <ginkgo/core/stop/criterion.hpp>
48template <
typename ValueType = default_precision>
56 using value_type = ValueType;
74 parameters_type, Factory> {};
95 config::make_type_descriptor<ValueType>());
98 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
100 template <
typename VectorType>
101 void apply_dense_impl(
const VectorType* b, VectorType* x)
const;
104 LinOp* x)
const override;
106 explicit Cg(std::shared_ptr<const Executor> exec)
110 explicit Cg(
const Factory* factory,
111 std::shared_ptr<const LinOp> system_matrix)
115 std::move(system_matrix), factory->get_parameters()},
116 parameters_{factory->get_parameters()}
121template <
typename ValueType>
125 static int num_vectors(
const Solver&);
127 static int num_arrays(
const Solver&);
129 static std::vector<std::string> op_names(
const Solver&);
131 static std::vector<std::string> array_names(
const Solver&);
133 static std::vector<int> scalars(
const Solver&);
135 static std::vector<int> vectors(
const Solver&);
138 constexpr static int r = 0;
140 constexpr static int z = 1;
142 constexpr static int p = 2;
144 constexpr static int q = 3;
146 constexpr static int alpha = 4;
148 constexpr static int beta = 5;
150 constexpr static int prev_rho = 6;
152 constexpr static int rho = 7;
154 constexpr static int one = 8;
156 constexpr static int minus_one = 9;
159 constexpr static int stop = 0;
161 constexpr static int tmp = 1;
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
CG or the conjugate gradient method is an iterative type Krylov subspace method which is suitable for...
Definition cg.hpp:51
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
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.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition cg.hpp:68
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:788
#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
#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
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
Definition solver_base.hpp:841
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239