sor.hpp

// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_
#define GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_
 
 
#include <vector>
 
#include <ginkgo/core/base/abstract_factory.hpp>
#include <ginkgo/core/base/composition.hpp>
#include <ginkgo/core/base/lin_op.hpp>
#include <ginkgo/core/base/polymorphic_object.hpp>
#include <ginkgo/core/config/config.hpp>
 
 
namespace gko {
namespace preconditioner {
 
 
template <typename ValueType = default_precision, typename IndexType = int32>
class Sor
    : public EnablePolymorphicObject<Sor<ValueType, IndexType>, LinOpFactory>,
      public EnablePolymorphicAssignment<Sor<ValueType, IndexType>> {
    friend class EnablePolymorphicObject<Sor, LinOpFactory>;
    GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
 
public:
    struct parameters_type;
    friend class enable_parameters_type<parameters_type, Sor>;
 
    using value_type = ValueType;
    using index_type = IndexType;
    using composition_type = Composition<ValueType>;
 
    struct parameters_type
        : public enable_parameters_type<parameters_type, Sor> {
        // skip sorting of input matrix
        bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
 
        // determines if SOR or SSOR should be used
        bool GKO_FACTORY_PARAMETER_SCALAR(symmetric, false);
 
        // has to be between 0.0 and 2.0
        remove_complex<value_type> GKO_FACTORY_PARAMETER_SCALAR(
            relaxation_factor, remove_complex<value_type>(1.2));
 
        // factory for the lower triangular factor solver, defaults to LowerTrs
        std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
            l_solver);
 
        // factory for the upper triangular factor solver, unused if symmetric
        // is false, defaults to UpperTrs
        std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
            u_solver);
    };
 
    const parameters_type& get_parameters() { return parameters_; }
 
    const parameters_type& get_parameters() const { return parameters_; }
 
    std::unique_ptr<composition_type> generate(
        std::shared_ptr<const LinOp> system_matrix) const;
 
    static parameters_type build() { return {}; }
 
    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:
    explicit Sor(std::shared_ptr<const Executor> exec,
                 const parameters_type& params = {})
        : EnablePolymorphicObject<Sor, LinOpFactory>(exec), parameters_(params)
    {
        GKO_ASSERT(parameters_.relaxation_factor > 0.0 &&
                   parameters_.relaxation_factor < 2.0);
    }
 
    std::unique_ptr<LinOp> generate_impl(
        std::shared_ptr<const LinOp> system_matrix) const override;
 
private:
    parameters_type parameters_;
};
}  // namespace preconditioner
}  // namespace gko
 
 
#endif  // GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_