Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.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
12#include <ginkgo/core/base/composition.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/types.hpp>
15#include <ginkgo/core/matrix/csr.hpp>
16
17
18namespace gko {
24namespace factorization {
25
26
67template <typename ValueType = default_precision, typename IndexType = int32>
68class ParIc : public Composition<ValueType> {
69public:
70 using value_type = ValueType;
71 using index_type = IndexType;
73
74 std::shared_ptr<const matrix_type> get_l_factor() const
75 {
76 // Can be `static_cast` since the type is guaranteed in this class
77 return std::static_pointer_cast<const matrix_type>(
78 this->get_operators()[0]);
79 }
80
81 std::shared_ptr<const matrix_type> get_lt_factor() const
82 {
83 if (this->get_operators().size() == 2) {
84 // Can be `static_cast` since the type is guaranteed in this class
85 return std::static_pointer_cast<const matrix_type>(
86 this->get_operators()[1]);
87 } else {
88 return std::static_pointer_cast<const matrix_type>(
89 share(get_l_factor()->conj_transpose()));
90 }
91 }
92
93 // Remove the possibility of calling `create`, which was enabled by
94 // `Composition`
95 template <typename... Args>
96 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
97 delete;
98
100 {
108
119 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
120
125 std::shared_ptr<typename matrix_type::strategy_type>
126 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
127
133 bool GKO_FACTORY_PARAMETER_SCALAR(both_factors, true);
134 };
137
138protected:
139 explicit ParIc(const Factory* factory,
140 std::shared_ptr<const LinOp> system_matrix)
141 : Composition<ValueType>(factory->get_executor()),
142 parameters_{factory->get_parameters()}
143 {
144 if (parameters_.l_strategy == nullptr) {
145 parameters_.l_strategy =
146 std::make_shared<typename matrix_type::classical>();
147 }
148 generate(system_matrix, parameters_.skip_sorting,
149 parameters_.both_factors)
150 ->move_to(this);
151 }
152
153 std::unique_ptr<Composition<ValueType>> generate(
154 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
155 bool both_factors) const;
156};
157
158
159} // namespace factorization
160} // namespace gko
161
162
163#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
Returns a LinOp representing the conjugate transpose of the Transposable object.
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Returns a list of operators of the composition.
Definition composition.hpp:54
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Definition par_ic.hpp:135
ParIC is an incomplete Cholesky factorization which is computed in parallel.
Definition par_ic.hpp:68
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:117
#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:1018
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:92
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:226
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ic.hpp:119
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:133
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ic.hpp:126