pmis.hpp

// SPDX-FileCopyrightText: 2025 - 2026 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_MULTIGRID_PMIS_HPP_
#define GKO_PUBLIC_CORE_MULTIGRID_PMIS_HPP_
 
 
#include <ginkgo/core/base/composition.hpp>
#include <ginkgo/core/base/lin_op.hpp>
#include <ginkgo/core/base/types.hpp>
#include <ginkgo/core/config/config.hpp>
#include <ginkgo/core/config/registry.hpp>
#include <ginkgo/core/config/type_descriptor.hpp>
#include <ginkgo/core/distributed/matrix.hpp>
#include <ginkgo/core/multigrid/multigrid_level.hpp>
 
 
namespace gko {
namespace multigrid {
 
 
template <typename ValueType = default_precision, typename IndexType = int32>
class Pmis : public LinOp, public EnableMultigridLevel<ValueType> {
    GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
 
public:
    using value_type = ValueType;
    using index_type = IndexType;
 
    std::shared_ptr<const LinOp> get_system_matrix() const
    {
        return system_matrix_;
    }
 
 
    GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
    {
        remove_complex<ValueType> GKO_FACTORY_PARAMETER_SCALAR(
            strength_threshold, remove_complex<ValueType>{0.25});
 
 
        bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
    };
    GKO_ENABLE_LIN_OP_FACTORY(Pmis, parameters, Factory);
    GKO_ENABLE_BUILD_METHOD(Factory);
 
    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>());
 
protected:
    void apply_impl(const LinOp* b, LinOp* x) const override;
 
    void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
                    LinOp* x) const override;
 
    explicit Pmis(std::shared_ptr<const Executor> exec);
 
    explicit Pmis(const Factory* factory,
                  std::shared_ptr<const LinOp> system_matrix);
 
    void generate();
 
private:
    std::shared_ptr<const LinOp> system_matrix_{};
};
 
 
}  // namespace multigrid
}  // namespace gko
 
 
#endif  // GKO_PUBLIC_CORE_MULTIGRID_PMIS_HPP_