Detailed Description

Option for Eigen sparse solver.

Definition at line 18 of file EigenOption.h.

#include <EigenOption.h>

Public Types
enum class	SolverType : short { CG , LeastSquareCG , BiCGSTAB , BiCGSTABL , IDRS , IDRSTABL , SparseLU , PardisoLU , GMRES }
	Solver type. More...
enum class	PreconType : short { NONE , DIAGONAL , LeastSquareDIAGONAL , ILUT }
	Preconditioner type. More...
enum class	TriangularMatrixType : short { Lower , Upper , LowerUpper }
	triangular matrix type More...

Public Member Functions
	EigenOption ()

Static Public Member Functions
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)
	return a linear solver name from the solver type
static std::string	getPreconName (PreconType const precon_type)
	return a preconditioner name from the preconditioner type
static std::string	getTriangularMatrixName (TriangularMatrixType const triangular_matrix_type)
	return a triangular matrix name from the preconditioner type

Public Attributes
SolverType	solver_type
	Linear solver type.
PreconType	precon_type
	Preconditioner type.
TriangularMatrixType	triangular_matrix_type
	Triangular Matrix Type.
int	max_iterations
	Maximum iteration count.
double	error_tolerance
	Error tolerance.

Member Enumeration Documentation

◆ PreconType

enum class MathLib::EigenOption::PreconType : short

strong

Preconditioner type.

Enumerator
NONE
DIAGONAL
LeastSquareDIAGONAL
ILUT

Definition at line 35 of file EigenOption.h.

    {
        NONE,
        DIAGONAL,
        LeastSquareDIAGONAL,
        ILUT
    };

◆ SolverType

enum class MathLib::EigenOption::SolverType : short

strong

Solver type.

Enumerator
CG
LeastSquareCG
BiCGSTAB
BiCGSTABL
IDRS
IDRSTABL
SparseLU
PardisoLU
GMRES

Definition at line 21 of file EigenOption.h.

    {
        CG,
        LeastSquareCG,
        BiCGSTAB,
        BiCGSTABL,
        IDRS,
        IDRSTABL,
        SparseLU,
        PardisoLU,
        GMRES
    };

◆ TriangularMatrixType

enum class MathLib::EigenOption::TriangularMatrixType : short

strong

triangular matrix type

Enumerator
Lower
Upper
LowerUpper

Definition at line 44 of file EigenOption.h.

    {
        Lower,
        Upper,
        LowerUpper
    };

Constructor & Destructor Documentation

◆ EigenOption()

MathLib::EigenOption::EigenOption ( )

Constructor

Default options are CG, no preconditioner, iteration count 500 and tolerance 1e-10. Default matrix storage type is CRS.

Definition at line 17 of file EigenOption.cpp.

{
    solver_type = SolverType::SparseLU;
    precon_type = PreconType::NONE;
    max_iterations = static_cast<int>(1e6);
    error_tolerance = 1.e-16;
    triangular_matrix_type = TriangularMatrixType::Lower;
#ifdef USE_EIGEN_UNSUPPORTED
    scaling = false;
    restart = 30;
    l = 2;
    s = 4;
    angle = 0.7;
    smoothing = false;
    residualupdate = false;
#endif
}

References error_tolerance, Lower, max_iterations, NONE, precon_type, MathLib::s, solver_type, SparseLU, and triangular_matrix_type.

Member Function Documentation

◆ getPreconName()

std::string MathLib::EigenOption::getPreconName ( PreconType const precon_type )

static

return a preconditioner name from the preconditioner type

Definition at line 146 of file EigenOption.cpp.

{
    switch (precon_type)
    {
        case PreconType::NONE:
            return "NONE";
        case PreconType::DIAGONAL:
            return "DIAGONAL";
        case PreconType::LeastSquareDIAGONAL:
            return "LeastSquareDIAGONAL";
        case PreconType::ILUT:
            return "ILUT";
    }
    return "Invalid";
}

References DIAGONAL, ILUT, LeastSquareDIAGONAL, NONE, and precon_type.

Referenced by MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl().

◆ getPreconType()

EigenOption::PreconType MathLib::EigenOption::getPreconType ( const std::string & precon_name )

static

return a preconditioner type from the name

Parameters

precon_name

Returns: a preconditioner type If there is no preconditioner type matched with the given name, NONE is returned.

Definition at line 78 of file EigenOption.cpp.

{
    if (precon_name == "NONE")
    {
        return PreconType::NONE;
    }
    if (precon_name == "DIAGONAL")
    {
        return PreconType::DIAGONAL;
    }
    if (precon_name == "LeastSquareDIAGONAL")
    {
        return PreconType::LeastSquareDIAGONAL;
    }
    if (precon_name == "ILUT")
    {
        return PreconType::ILUT;
    }
 
    OGS_FATAL("Unknown Eigen preconditioner type `{:s}'", precon_name);
}

References DIAGONAL, ILUT, LeastSquareDIAGONAL, NONE, and OGS_FATAL.

Referenced by MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions().

◆ getSolverName()

std::string MathLib::EigenOption::getSolverName ( SolverType const solver_type )

static

return a linear solver name from the solver type

Definition at line 120 of file EigenOption.cpp.

{
    switch (solver_type)
    {
        case SolverType::CG:
            return "CG";
        case SolverType::LeastSquareCG:
            return "LeastSquareCG";
        case SolverType::BiCGSTAB:
            return "BiCGSTAB";
        case SolverType::BiCGSTABL:
            return "BiCGSTABL";
        case SolverType::IDRS:
            return "IDRS";
        case SolverType::IDRSTABL:
            return "IDRSTABL";
        case SolverType::SparseLU:
            return "SparseLU";
        case SolverType::PardisoLU:
            return "PardisoLU";
        case SolverType::GMRES:
            return "GMRES";
    }
    return "Invalid";
}

References BiCGSTAB, BiCGSTABL, CG, GMRES, IDRS, IDRSTABL, LeastSquareCG, PardisoLU, solver_type, and SparseLU.

Referenced by MathLib::details::EigenDirectLinearSolver< T_SOLVER >::computeImpl(), MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solveImpl(), and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl().

◆ getSolverType()

EigenOption::SolverType MathLib::EigenOption::getSolverType ( const std::string & solver_name )

static

return a linear solver type from the solver name

Parameters

solver_name

Returns: a linear solver type If there is no solver type matched with the given name, INVALID is returned.

Definition at line 35 of file EigenOption.cpp.

{
    if (solver_name == "CG")
    {
        return SolverType::CG;
    }
    if (solver_name == "LeastSquareCG")
    {
        return SolverType::LeastSquareCG;
    }
    if (solver_name == "BiCGSTAB")
    {
        return SolverType::BiCGSTAB;
    }
    if (solver_name == "BiCGSTABL")
    {
        return SolverType::BiCGSTABL;
    }
    if (solver_name == "IDRS")
    {
        return SolverType::IDRS;
    }
    if (solver_name == "IDRSTABL")
    {
        return SolverType::IDRSTABL;
    }
    if (solver_name == "SparseLU")
    {
        return SolverType::SparseLU;
    }
    if (solver_name == "PardisoLU")
    {
        return SolverType::PardisoLU;
    }
    if (solver_name == "GMRES")
    {
        return SolverType::GMRES;
    }
 
    OGS_FATAL("Unknown Eigen solver type `{:s}'", solver_name);
}

References BiCGSTAB, BiCGSTABL, CG, GMRES, IDRS, IDRSTABL, LeastSquareCG, OGS_FATAL, PardisoLU, and SparseLU.

Referenced by MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions().

◆ getTriangularMatrixName()

std::string MathLib::EigenOption::getTriangularMatrixName ( TriangularMatrixType const triangular_matrix_type )

static

return a triangular matrix name from the preconditioner type

Definition at line 162 of file EigenOption.cpp.

{
    switch (triangular_matrix_type)
    {
        case TriangularMatrixType::Lower:
            return "Lower";
        case TriangularMatrixType::Upper:
            return "Upper";
        case TriangularMatrixType::LowerUpper:
            return "LowerUpper";
    }
    return "Invalid";
}

References Lower, LowerUpper, triangular_matrix_type, and Upper.

◆ getTriangularMatrixType()

EigenOption::TriangularMatrixType MathLib::EigenOption::getTriangularMatrixType ( const std::string & triangular_matrix_name )

static

return a triangular matrix type from the name

Parameters

triangular_matrix_name

Returns: a triangular_matrix type If there is no triangular matrix type matched with the given name, NONE is returned.

Definition at line 101 of file EigenOption.cpp.

{
    if (triangular_matrix_name == "Lower")
    {
        return TriangularMatrixType::Lower;
    }
    if (triangular_matrix_name == "Upper")
    {
        return TriangularMatrixType::Upper;
    }
    if (triangular_matrix_name == "LowerUpper")
    {
        return TriangularMatrixType::LowerUpper;
    }
 
    OGS_FATAL("Unknown triangular matrix type `{:s}'", triangular_matrix_name);
}

References Lower, LowerUpper, OGS_FATAL, and Upper.

Referenced by MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions().

Member Data Documentation

◆ error_tolerance

double MathLib::EigenOption::error_tolerance

Error tolerance.

Definition at line 60 of file EigenOption.h.

Referenced by EigenOption(), MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), and MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions().

◆ max_iterations

int MathLib::EigenOption::max_iterations

Maximum iteration count.

Definition at line 58 of file EigenOption.h.

Referenced by EigenOption(), MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions(), and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl().

◆ precon_type

PreconType MathLib::EigenOption::precon_type

Preconditioner type.

Definition at line 54 of file EigenOption.h.

Referenced by EigenOption(), MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), getPreconName(), MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions(), and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl().

◆ solver_type

SolverType MathLib::EigenOption::solver_type

Linear solver type.

Definition at line 52 of file EigenOption.h.

Referenced by EigenOption(), MathLib::details::EigenDirectLinearSolver< T_SOLVER >::computeImpl(), MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl(), getSolverName(), MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions(), MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solveImpl(), and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl().

◆ triangular_matrix_type

TriangularMatrixType MathLib::EigenOption::triangular_matrix_type

Triangular Matrix Type.

Definition at line 56 of file EigenOption.h.

Referenced by EigenOption(), getTriangularMatrixName(), and MathLib::LinearSolverOptionsParser< EigenLinearSolver >::parseNameAndOptions().

The documentation for this struct was generated from the following files:

MathLib/LinAlg/Eigen/EigenOption.h
MathLib/LinAlg/Eigen/EigenOption.cpp

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Enumeration Documentation

◆ PreconType

◆ SolverType

◆ TriangularMatrixType

Constructor & Destructor Documentation

◆ EigenOption()

Member Function Documentation

◆ getPreconName()

◆ getPreconType()

◆ getSolverName()

◆ getSolverType()

◆ getTriangularMatrixName()

◆ getTriangularMatrixType()

Member Data Documentation

◆ error_tolerance

◆ max_iterations

◆ precon_type

◆ solver_type

◆ triangular_matrix_type