Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
par_ic.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_FACTORIZATION_PAR_IC_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_IC_HPP_
7
8
9#include <memory>
10
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/matrix/csr.hpp>
17
18
19namespace gko {
25namespace factorization {
26
27
68template <typename ValueType = default_precision, typename IndexType = int32>
69class ParIc : public Composition<ValueType> {
70public:
71 using value_type = ValueType;
72 using index_type = IndexType;
74
75 std::shared_ptr<const matrix_type> get_l_factor() const
76 {
77 // Can be `static_cast` since the type is guaranteed in this class
78 return std::static_pointer_cast<const matrix_type>(
79 this->get_operators()[0]);
80 }
81
82 std::shared_ptr<const matrix_type> get_lt_factor() const
83 {
84 if (this->get_operators().size() == 2) {
85 // Can be `static_cast` since the type is guaranteed in this class
86 return std::static_pointer_cast<const matrix_type>(
87 this->get_operators()[1]);
88 } else {
89 return std::static_pointer_cast<const matrix_type>(
90 share(get_l_factor()->conj_transpose()));
91 }
92 }
93
94 // Remove the possibility of calling `create`, which was enabled by
95 // `Composition`
96 template <typename... Args>
97 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
98 delete;
99
101 {
109
120 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
121
126 std::shared_ptr<typename matrix_type::strategy_type>
127 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
128
134 bool GKO_FACTORY_PARAMETER_SCALAR(both_factors, true);
135 };
138
153 const config::pnode& config, const config::registry& context,
154 const config::type_descriptor& td_for_child =
155 config::make_type_descriptor<ValueType, IndexType>());
156
157protected:
158 explicit ParIc(const Factory* factory,
159 std::shared_ptr<const LinOp> system_matrix)
160 : Composition<ValueType>(factory->get_executor()),
161 parameters_{factory->get_parameters()}
162 {
163 if (parameters_.l_strategy == nullptr) {
164 parameters_.l_strategy =
165 std::make_shared<typename matrix_type::classical>();
166 }
167 generate(system_matrix, parameters_.skip_sorting,
168 parameters_.both_factors)
169 ->move_to(this);
170 }
171
172 std::unique_ptr<Composition<ValueType>> generate(
173 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
174 bool both_factors) const;
175};
176
177
178} // namespace factorization
179} // namespace gko
180
181
182#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_IC_HPP_
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
std::unique_ptr< LinOp > conj_transpose() const override
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Definition composition.hpp:54
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:234
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
Definition par_ic.hpp:136
ParIC is an incomplete Cholesky factorization which is computed in parallel.
Definition par_ic.hpp:69
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 sparsity_csr.hpp:21
#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 Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:224
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ic.hpp:120
bool both_factors
true will generate both L and L^H, false will only generate the L factor, resulting in a Composition ...
Definition par_ic.hpp:134
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ic.hpp:127