33#ifndef GKO_PUBLIC_CORE_SOLVER_MULTIGRID_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_MULTIGRID_HPP_
43#include <ginkgo/core/base/abstract_factory.hpp>
44#include <ginkgo/core/base/array.hpp>
45#include <ginkgo/core/base/exception_helpers.hpp>
46#include <ginkgo/core/base/lin_op.hpp>
47#include <ginkgo/core/base/math.hpp>
48#include <ginkgo/core/base/precision_dispatch.hpp>
49#include <ginkgo/core/base/types.hpp>
50#include <ginkgo/core/log/logger.hpp>
51#include <ginkgo/core/matrix/dense.hpp>
52#include <ginkgo/core/matrix/identity.hpp>
53#include <ginkgo/core/multigrid/multigrid_level.hpp>
54#include <ginkgo/core/solver/solver_base.hpp>
55#include <ginkgo/core/stop/combined.hpp>
56#include <ginkgo/core/stop/criterion.hpp>
150 return this->get_default_initial_guess() ==
159 std::vector<std::shared_ptr<const gko::multigrid::MultigridLevel>>
162 return mg_level_list_;
172 return pre_smoother_list_;
182 return mid_smoother_list_;
192 return post_smoother_list_;
202 return coarsest_solver_;
228 std::vector<std::shared_ptr<const LinOpFactory>>
274 std::vector<std::shared_ptr<const LinOpFactory>>
282 std::vector<std::shared_ptr<const LinOpFactory>>
292 std::vector<std::shared_ptr<const LinOpFactory>>
333 std::vector<std::shared_ptr<const LinOpFactory>>
367 multigrid::cycle::v);
411 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
414 LinOp* x)
const override;
416 void apply_with_initial_guess_impl(
const LinOp* b,
LinOp* x,
419 void apply_with_initial_guess_impl(
const LinOp* alpha,
const LinOp* b,
423 template <
typename VectorType>
433 explicit Multigrid(std::shared_ptr<const Executor> exec);
436 std::shared_ptr<const LinOp> system_matrix);
454 void create_state()
const;
457 std::vector<std::shared_ptr<const gko::multigrid::MultigridLevel>>
459 std::vector<std::shared_ptr<const LinOp>> pre_smoother_list_{};
460 std::vector<std::shared_ptr<const LinOp>> mid_smoother_list_{};
461 std::vector<std::shared_ptr<const LinOp>> post_smoother_list_{};
462 std::shared_ptr<const LinOp> coarsest_solver_{};
476 mutable struct cache_struct {
477 cache_struct() =
default;
479 ~cache_struct() =
default;
481 cache_struct(
const cache_struct&) {}
483 cache_struct(cache_struct&&) {}
485 cache_struct& operator=(
const cache_struct&) {
return *
this; }
487 cache_struct& operator=(cache_struct&&) {
return *
this; }
491 std::shared_ptr<multigrid::detail::MultigridState> state{};
499 static int num_vectors(
const Solver&);
501 static int num_arrays(
const Solver&);
503 static std::vector<std::string> op_names(
const Solver&);
505 static std::vector<std::string> array_names(
const Solver&);
507 static std::vector<int> scalars(
const Solver&);
509 static std::vector<int> vectors(
const Solver&);
512 constexpr static int stop = 0;
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
EnableApplyWithInitialGuess providing default operation for ApplyWithInitialGuess with correct valida...
Definition solver_base.hpp:190
A LinOp deriving from this CRTP class stores a stopping criterion factory and allows applying with a ...
Definition solver_base.hpp:732
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:570
Definition multigrid.hpp:407
Multigrid methods have a hierarchy of many levels, whose corase level is a subset of the fine level,...
Definition multigrid.hpp:136
std::shared_ptr< const LinOp > get_coarsest_solver() const
Gets the operator at the coarsest level.
Definition multigrid.hpp:200
std::vector< std::shared_ptr< const gko::multigrid::MultigridLevel > > get_mg_level_list() const
Gets the list of MultigridLevel operators.
Definition multigrid.hpp:160
void set_cycle(multigrid::cycle cycle)
Set the cycle of multigrid.
Definition multigrid.hpp:217
std::vector< std::shared_ptr< const LinOp > > get_mid_smoother_list() const
Gets the list of mid-smoother operators.
Definition multigrid.hpp:180
multigrid::cycle get_cycle() const
Get the cycle of multigrid.
Definition multigrid.hpp:210
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess or false if multigrid always s...
Definition multigrid.hpp:148
std::vector< std::shared_ptr< const LinOp > > get_pre_smoother_list() const
Gets the list of pre-smoother operators.
Definition multigrid.hpp:170
std::vector< std::shared_ptr< const LinOp > > get_post_smoother_list() const
Gets the list of post-smoother operators.
Definition multigrid.hpp:190
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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
mid_smooth_type
mid_smooth_type gives the options to handle the middle smoother behavior between the two cycles in th...
Definition multigrid.hpp:96
cycle
cycle defines which kind of multigrid cycle can be used.
Definition multigrid.hpp:80
initial_guess_mode
Give a initial guess mode about the input of the apply method.
Definition solver_base.hpp:62
@ provided
the input is provided
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
Definition multigrid.hpp:224
std::vector< std::shared_ptr< const LinOpFactory > > coarsest_solver
Coarsest factory list.
Definition multigrid.hpp:334
std::vector< std::shared_ptr< const LinOpFactory > > post_smoother
Post-smooth Factory list.
Definition multigrid.hpp:283
size_type max_levels
The maximum number of mg_level (without coarsest solver level) that can be used.
Definition multigrid.hpp:318
std::complex< double > smoother_relax
smoother_relax is the relaxation factor of default generated smoother.
Definition multigrid.hpp:392
std::function< size_type(const size_type, const LinOp *) solver_selector)
Custom coarsest_solver selector size_type (size_type level, const LinOp *coarsest_matrix) Selector fu...
Definition multigrid.hpp:359
size_type min_coarse_rows
The minimal number of coarse rows.
Definition multigrid.hpp:325
initial_guess_mode default_initial_guess
Default initial guess mode.
Definition multigrid.hpp:405
std::vector< std::shared_ptr< const LinOpFactory > > pre_smoother
Pre-smooth Factory list.
Definition multigrid.hpp:275
size_type kcycle_base
kcycle_base is a factor to choose how often enable FCG/GCR step.
Definition multigrid.hpp:377
size_type smoother_iters
smoother_iters is the number of iteration of default generated smoother.
Definition multigrid.hpp:398
multigrid::cycle cycle
Multigrid cycle type.
Definition multigrid.hpp:367
multigrid::mid_smooth_type mid_case
Choose the behavior of mid smoother between two cycles close to each other in the same level.
Definition multigrid.hpp:309
bool post_uses_pre
Whether post-smoothing-related calls use corresponding pre-smoothing-related calls.
Definition multigrid.hpp:299
std::vector< std::shared_ptr< const LinOpFactory > > mid_smoother
Mid-smooth Factory list.
Definition multigrid.hpp:293
double kcycle_rel_tol
kcycle_rel_tol decides whether run the second iteration of FCG/GCR step.
Definition multigrid.hpp:386
std::function< size_type(const size_type, const LinOp *) level_selector)
Custom selector size_type (size_type level, const LinOp* fine_matrix) Selector function returns the e...
Definition multigrid.hpp:258
std::vector< std::shared_ptr< const LinOpFactory > > mg_level
MultigridLevel Factory list.
Definition multigrid.hpp:229
Definition solver_base.hpp:858
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267