MathLib::details Namespace Reference

Classes
class	EigenDirectLinearSolver
	Template class for Eigen direct linear solvers. More...
class	EigenIterativeLinearSolver
	Template class for Eigen iterative linear solvers. More...

Typedefs
template<typename Mat , typename Precon >
using	EigenCGSolverL = Eigen::ConjugateGradient<Mat, Eigen::Lower, Precon>
template<typename Mat , typename Precon >
using	EigenCGSolverU = Eigen::ConjugateGradient<Mat, Eigen::Upper, Precon>
template<typename Mat , typename Precon >
using	EigenCGSolverLU

Functions
template<template< typename, typename > class Solver, typename Precon >
std::unique_ptr< EigenLinearSolverBase >	createIterativeSolver ()
template<template< typename, typename > class Solver>
std::unique_ptr< EigenLinearSolverBase >	createIterativeSolver (EigenOption::PreconType precon_type)
std::unique_ptr< EigenLinearSolverBase >	createIterativeSolver (EigenOption::SolverType solver_type, EigenOption::PreconType precon_type, EigenOption::TriangularMatrixType triangular_matrix_type)

Typedef Documentation

EigenCGSolverL

template<typename Mat , typename Precon >

using MathLib::details::EigenCGSolverL = Eigen::ConjugateGradient<Mat, Eigen::Lower, Precon>

Definition at line 406 of file EigenLinearSolver.cpp.

EigenCGSolverLU

template<typename Mat , typename Precon >

using MathLib::details::EigenCGSolverLU

Initial value:

 
    Eigen::ConjugateGradient<Mat, Eigen::Lower | Eigen::Upper, Precon>

Definition at line 412 of file EigenLinearSolver.cpp.

EigenCGSolverU

template<typename Mat , typename Precon >

using MathLib::details::EigenCGSolverU = Eigen::ConjugateGradient<Mat, Eigen::Upper, Precon>

Definition at line 409 of file EigenLinearSolver.cpp.

Function Documentation

createIterativeSolver() [1/3]

template<template< typename, typename > class Solver, typename Precon >

std::unique_ptr< EigenLinearSolverBase > MathLib::details::createIterativeSolver

(

)

Definition at line 372 of file EigenLinearSolver.cpp.

{
    using Slv =
        EigenIterativeLinearSolver<Solver<EigenMatrix::RawMatrixType, Precon>>;
    return std::make_unique<Slv>();
}

Referenced by MathLib::EigenLinearSolver::EigenLinearSolver(), createIterativeSolver(), and createIterativeSolver().

createIterativeSolver() [2/3]

template<template< typename, typename > class Solver>

std::unique_ptr< EigenLinearSolverBase > MathLib::details::createIterativeSolver

(

EigenOption::PreconType

precon_type

)

Definition at line 380 of file EigenLinearSolver.cpp.

{
    switch (precon_type)
    {
        case EigenOption::PreconType::NONE:
            return createIterativeSolver<Solver,
                                         Eigen::IdentityPreconditioner>();
        case EigenOption::PreconType::DIAGONAL:
            return createIterativeSolver<
                Solver, Eigen::DiagonalPreconditioner<double>>();
        case EigenOption::PreconType::LeastSquareDIAGONAL:
            return createIterativeSolver<
                Solver, Eigen::LeastSquareDiagonalPreconditioner<double>>();
        case EigenOption::PreconType::ILUT:
            // TODO for this preconditioner further options can be passed.
            // see
            // https://libeigen.gitlab.io/docs/classEigen_1_1IncompleteLUT.html
            return createIterativeSolver<Solver,
                                         Eigen::IncompleteLUT<double>>();
        default:
            OGS_FATAL("Invalid Eigen preconditioner type.");
    }
}

References createIterativeSolver(), MathLib::EigenOption::DIAGONAL, MathLib::EigenOption::ILUT, MathLib::EigenOption::LeastSquareDIAGONAL, MathLib::EigenOption::NONE, and OGS_FATAL.

createIterativeSolver() [3/3]

std::unique_ptr< EigenLinearSolverBase > MathLib::details::createIterativeSolver	(	EigenOption::SolverType	solver_type,
		EigenOption::PreconType	precon_type,
		EigenOption::TriangularMatrixType	triangular_matrix_type )

Definition at line 415 of file EigenLinearSolver.cpp.

{
    switch (solver_type)
    {
        case EigenOption::SolverType::BiCGSTAB:
        {
            return createIterativeSolver<Eigen::BiCGSTAB>(precon_type);
        }
        case EigenOption::SolverType::BiCGSTABL:
        {
#ifdef USE_EIGEN_UNSUPPORTED
#if EIGEN_VERSION_AT_LEAST(3, 4, 90)
            return createIterativeSolver<Eigen::BiCGSTABL>(precon_type);
#else
            OGS_FATAL("BiCGSTABL requires at least Eigen version 3.4.90");
#endif
#else
            OGS_FATAL(
                "The code is not compiled with the Eigen unsupported modules. "
                "Linear solver type BiCGSTABL is not available.");
#endif
        }
        case EigenOption::SolverType::CG:
        {
            switch (triangular_matrix_type)
            {
                case EigenOption::TriangularMatrixType::Upper:
                    return createIterativeSolver<EigenCGSolverU>(precon_type);
                case EigenOption::TriangularMatrixType::LowerUpper:
                    return createIterativeSolver<EigenCGSolverLU>(precon_type);
                default:
                    return createIterativeSolver<EigenCGSolverL>(precon_type);
            }
        }
        case EigenOption::SolverType::LeastSquareCG:
        {
            return createIterativeSolver<Eigen::LeastSquaresConjugateGradient>(
                precon_type);
        }
        case EigenOption::SolverType::GMRES:
        {
#ifdef USE_EIGEN_UNSUPPORTED
            return createIterativeSolver<Eigen::GMRES>(precon_type);
#else
            OGS_FATAL(
                "The code is not compiled with the Eigen unsupported modules. "
                "Linear solver type GMRES is not available.");
#endif
        }
        case EigenOption::SolverType::IDRS:
        {
#ifdef USE_EIGEN_UNSUPPORTED
#if EIGEN_VERSION_AT_LEAST(3, 4, 90)
            return createIterativeSolver<Eigen::IDRS>(precon_type);
#else
            OGS_FATAL("IDRS requires at least Eigen version 3.4.90");
#endif
#else
            OGS_FATAL(
                "The code is not compiled with the Eigen unsupported modules. "
                "Linear solver type IDRS is not available.");
#endif
        }
        case EigenOption::SolverType::IDRSTABL:
        {
#ifdef USE_EIGEN_UNSUPPORTED
#if EIGEN_VERSION_AT_LEAST(3, 4, 90)
            return createIterativeSolver<Eigen::IDRSTABL>(precon_type);
#else
            OGS_FATAL("IDRSTABL requires at least Eigen version 3.4.90");
#endif
#else
            OGS_FATAL(
                "The code is not compiled with the Eigen unsupported modules. "
                "Linear solver type IDRSTABL is not available.");
#endif
        }
        default:
            OGS_FATAL("Invalid Eigen iterative linear solver type. Aborting.");
    }
}

References MathLib::EigenOption::BiCGSTAB, MathLib::EigenOption::BiCGSTABL, MathLib::EigenOption::CG, createIterativeSolver(), MathLib::EigenOption::GMRES, MathLib::EigenOption::IDRS, MathLib::EigenOption::IDRSTABL, MathLib::EigenOption::LeastSquareCG, MathLib::EigenOption::LowerUpper, OGS_FATAL, and MathLib::EigenOption::Upper.