Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
fcg.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_SOLVER_FCG_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_FCG_HPP_
35
36
37#include <vector>
38
39
40#include <ginkgo/core/base/array.hpp>
41#include <ginkgo/core/base/exception_helpers.hpp>
42#include <ginkgo/core/base/lin_op.hpp>
43#include <ginkgo/core/base/math.hpp>
44#include <ginkgo/core/base/types.hpp>
45#include <ginkgo/core/log/logger.hpp>
46#include <ginkgo/core/matrix/dense.hpp>
47#include <ginkgo/core/matrix/identity.hpp>
48#include <ginkgo/core/solver/solver_base.hpp>
49#include <ginkgo/core/stop/combined.hpp>
50#include <ginkgo/core/stop/criterion.hpp>
51
52
53namespace gko {
54namespace solver {
55
56
78template <typename ValueType = default_precision>
79class Fcg
80 : public EnableLinOp<Fcg<ValueType>>,
81 public EnablePreconditionedIterativeSolver<ValueType, Fcg<ValueType>>,
82 public Transposable {
83 friend class EnableLinOp<Fcg>;
84 friend class EnablePolymorphicObject<Fcg, LinOp>;
85
86public:
87 using value_type = ValueType;
89
90 std::unique_ptr<LinOp> transpose() const override;
91
92 std::unique_ptr<LinOp> conj_transpose() const override;
93
99 bool apply_uses_initial_guess() const override { return true; }
100
101 class Factory;
102
105 parameters_type, Factory> {};
106
109
110protected:
111 void apply_impl(const LinOp* b, LinOp* x) const override;
112
113 template <typename VectorType>
114 void apply_dense_impl(const VectorType* b, VectorType* x) const;
115
116 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
117 LinOp* x) const override;
118
119 explicit Fcg(std::shared_ptr<const Executor> exec)
120 : EnableLinOp<Fcg>(std::move(exec))
121 {}
122
123 explicit Fcg(const Factory* factory,
124 std::shared_ptr<const LinOp> system_matrix)
125 : EnableLinOp<Fcg>(factory->get_executor(),
126 gko::transpose(system_matrix->get_size())),
127 EnablePreconditionedIterativeSolver<ValueType, Fcg<ValueType>>{
128 std::move(system_matrix), factory->get_parameters()},
129 parameters_{factory->get_parameters()}
130 {}
131};
132
133
134template <typename ValueType>
135struct workspace_traits<Fcg<ValueType>> {
136 using Solver = Fcg<ValueType>;
137 // number of vectors used by this workspace
138 static int num_vectors(const Solver&);
139 // number of arrays used by this workspace
140 static int num_arrays(const Solver&);
141 // array containing the num_vectors names for the workspace vectors
142 static std::vector<std::string> op_names(const Solver&);
143 // array containing the num_arrays names for the workspace vectors
144 static std::vector<std::string> array_names(const Solver&);
145 // array containing all varying scalar vectors (independent of problem size)
146 static std::vector<int> scalars(const Solver&);
147 // array containing all varying vectors (dependent on problem size)
148 static std::vector<int> vectors(const Solver&);
149
150 // residual vector
151 constexpr static int r = 0;
152 // preconditioned residual vector
153 constexpr static int z = 1;
154 // p vector
155 constexpr static int p = 2;
156 // q vector
157 constexpr static int q = 3;
158 // t vector
159 constexpr static int t = 4;
160 // alpha scalar
161 constexpr static int alpha = 5;
162 // beta scalar
163 constexpr static int beta = 6;
164 // previous rho scalar
165 constexpr static int prev_rho = 7;
166 // current rho scalar
167 constexpr static int rho = 8;
168 // current rho_t scalar
169 constexpr static int rho_t = 9;
170 // constant 1.0 scalar
171 constexpr static int one = 10;
172 // constant -1.0 scalar
173 constexpr static int minus_one = 11;
174
175 // stopping status array
176 constexpr static int stop = 0;
177 // reduction tmp array
178 constexpr static int tmp = 1;
179};
180
181
182} // namespace solver
183} // namespace gko
184
185
186#endif // GKO_PUBLIC_CORE_SOLVER_FCG_HPP_
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:816
Definition fcg.hpp:107
FCG or the flexible conjugate gradient method is an iterative type Krylov subspace method which is su...
Definition fcg.hpp:82
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition fcg.hpp:99
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
Definition fcg.hpp:105
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267