EigenOption.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <string>
 
namespace MathLib
{
struct EigenOption final
{
    enum class SolverType : short
    {
        CG,
        LeastSquareCG,
        BiCGSTAB,
        BiCGSTABL,
        IDRS,
        IDRSTABL,
        SparseLU,
        PardisoLU,
        GMRES
    };

    enum class PreconType : short
    {
        NONE,
        DIAGONAL,
        LeastSquareDIAGONAL,
        ILUT
    };

    enum class TriangularMatrixType : short
    {
        Lower,
        Upper,
        LowerUpper
    };

    SolverType solver_type;
    PreconType precon_type;
    TriangularMatrixType triangular_matrix_type;
    int max_iterations;
    double error_tolerance;
#ifdef USE_EIGEN_UNSUPPORTED
    bool scaling;
    int restart;
    int l;
    int s;
    double angle;
    bool smoothing;
    bool residualupdate;
#endif

    EigenOption();

    static SolverType getSolverType(const std::string& solver_name);

    static PreconType getPreconType(const std::string& precon_name);

    static TriangularMatrixType getTriangularMatrixType(
        const std::string& triangular_matrix_name);

    static std::string getSolverName(SolverType const solver_type);

    static std::string getPreconName(PreconType const precon_type);

    static std::string getTriangularMatrixName(
        TriangularMatrixType const triangular_matrix_type);
};
 
}  // namespace MathLib