5#ifndef GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
11#include <ginkgo/core/base/composition.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/factorization/incomplete_factorization.hpp>
17#include <ginkgo/core/matrix/csr.hpp>
47 using value_type = ValueType;
48 using index_type = IndexType;
51 std::shared_ptr<const matrix_type> get_l_factor()
const
54 return std::static_pointer_cast<const matrix_type>(
58 std::shared_ptr<const matrix_type> get_lt_factor()
const
62 return std::static_pointer_cast<const matrix_type>(
65 return std::static_pointer_cast<const matrix_type>(
72 template <
typename... Args>
73 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
82 std::shared_ptr<typename matrix_type::strategy_type>
133 config::make_type_descriptor<ValueType, IndexType>());
136 Ic(
const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
138 parameters_{factory->get_parameters()}
142 std::make_shared<typename matrix_type::classical>();
149 std::unique_ptr<Composition<ValueType>> generate(
150 const std::shared_ptr<const LinOp>& system_matrix,
bool skip_sorting,
151 bool both_factors)
const;
Composition(const Composition &)
std::unique_ptr< LinOp > conj_transpose() const override
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Definition composition.hpp:54
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
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:280
#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
#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
The Factorization namespace.
Definition ic.hpp:26
incomplete_algorithm
An enum class for algorithm selection in the incomplete factorization.
Definition incomplete_factorization.hpp:19
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:107
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:172
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:224
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition ic.hpp:83
incomplete_algorithm algorithm
Select the implementation which is supposed to be used for the incomplete factorization.
Definition ic.hpp:112
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition ic.hpp:95
bool both_factors
true will generate both L and L^H, false will only generate the L factor, resulting in a Composition ...
Definition ic.hpp:102