Detailed Description

template<class T_SOLVER>
class MathLib::details::EigenIterativeLinearSolver< T_SOLVER >

Template class for Eigen iterative linear solvers.

Definition at line 267 of file EigenLinearSolver.cpp.

Inheritance diagram for MathLib::details::EigenIterativeLinearSolver< T_SOLVER >:

Collaboration diagram for MathLib::details::EigenIterativeLinearSolver< T_SOLVER >:

Public Member Functions
bool	computeImpl (Matrix &A, EigenOption &opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour) override
bool	solveImpl (Vector const &b, Vector &x, EigenOption &opt) override
Public Member Functions inherited from MathLib::EigenLinearSolverBase
virtual	~EigenLinearSolverBase ()=default
bool	solve (Vector &b, Vector &x, EigenOption &opt)
bool	compute (Matrix &A, EigenOption &opt, MathLib::LinearSolverBehaviour linear_solver_behaviour)
bool	didComputeAtLeastOnce () const

Private Attributes
T_SOLVER	solver_
Matrix	A_

Additional Inherited Members
Public Types inherited from MathLib::EigenLinearSolverBase
using	Vector = EigenVector::RawVectorType
using	Matrix = EigenMatrix::RawMatrixType

Member Function Documentation

◆ computeImpl()

template<class T_SOLVER>

bool MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::computeImpl	(	Matrix &	A,
		EigenOption &	opt,
		MathLib::LinearSolverBehaviour const	linear_solver_behaviour )

inlineoverridevirtual

Implements MathLib::EigenLinearSolverBase.

Definition at line 270 of file EigenLinearSolver.cpp.

    {
        INFO("-> compute with Eigen iterative linear solver {:s} (precon {:s})",
             EigenOption::getSolverName(opt.solver_type),
             EigenOption::getPreconName(opt.precon_type));
        solver_.setTolerance(opt.error_tolerance);
        solver_.setMaxIterations(opt.max_iterations);
 
#ifdef USE_EIGEN_UNSUPPORTED
        MathLib::details::EigenIterativeLinearSolver<T_SOLVER>::setRestart(
            opt.restart);
        MathLib::details::EigenIterativeLinearSolver<T_SOLVER>::setL(opt.l);
        MathLib::details::EigenIterativeLinearSolver<T_SOLVER>::setS(opt.s);
        MathLib::details::EigenIterativeLinearSolver<T_SOLVER>::setSmoothing(
            opt.smoothing);
        MathLib::details::EigenIterativeLinearSolver<T_SOLVER>::setAngle(
            opt.angle);
        MathLib::details::EigenIterativeLinearSolver<
            T_SOLVER>::setResidualUpdate(opt.residualupdate);
#endif
 
        auto compute = [this](Matrix& m)
        {
            if (!m.isCompressed())
            {
                m.makeCompressed();
            }
 
            solver_.compute(m);
        };
 
        switch (linear_solver_behaviour)
        {
            case MathLib::LinearSolverBehaviour::RECOMPUTE_AND_STORE:
            {
                // matrix must be copied, because Eigen's linear solver stores a
                // reference to it cf.
                // https://libeigen.gitlab.io/docs/classEigen_1_1IterativeSolverBase.html#a7dfa55c55e82d697bde227696a630914
                A_ = A;
                compute(A_);
                break;
            }
            case MathLib::LinearSolverBehaviour::RECOMPUTE:
            {
                compute(A);
                break;
            }
            case MathLib::LinearSolverBehaviour::REUSE:
                OGS_FATAL(
                    "If NumLib::LinearSolverBehaviour::REUSE is set then "
                    "EigenLinearSolver::compute() should never be executed");
        };
 
        if (solver_.info() != Eigen::Success)
        {
            ERR("Failed during Eigen linear solver initialization");
            return false;
        }
 
        return true;
    }

References A_, MathLib::EigenLinearSolverBase::compute(), ERR(), MathLib::EigenOption::error_tolerance, MathLib::EigenOption::getPreconName(), MathLib::EigenOption::getSolverName(), INFO(), MathLib::EigenOption::max_iterations, OGS_FATAL, MathLib::EigenOption::precon_type, MathLib::RECOMPUTE, MathLib::RECOMPUTE_AND_STORE, MathLib::REUSE, solver_, and MathLib::EigenOption::solver_type.

◆ solveImpl()

template<class T_SOLVER>

bool MathLib::details::EigenIterativeLinearSolver< T_SOLVER >::solveImpl	(	Vector const &	b,
		Vector &	x,
		EigenOption &	opt )

inlineoverridevirtual

Implements MathLib::EigenLinearSolverBase.

Definition at line 334 of file EigenLinearSolver.cpp.

    {
        INFO("-> solve with Eigen iterative linear solver {:s} (precon {:s})",
             EigenOption::getSolverName(opt.solver_type),
             EigenOption::getPreconName(opt.precon_type));
 
        x = solver_.solveWithGuess(b, x);
        INFO("\t iteration: {:d}/{:d}", solver_.iterations(),
             opt.max_iterations);
        INFO("\t residual: {:e}\n", solver_.error());
 
        if (solver_.info() != Eigen::Success)
        {
            ERR("Failed during Eigen linear solve");
            return false;
        }
 
        return true;
    }