MathLib::EigenLinearSolver Class Reference

Detailed Description

Definition at line 26 of file EigenLinearSolver.h.

#include <EigenLinearSolver.h>

Collaboration diagram for MathLib::EigenLinearSolver:

Public Member Functions
	EigenLinearSolver (std::string const &solver_name, EigenOption const &option)
	~EigenLinearSolver ()
void	setOption (const EigenOption &option)
EigenOption &	getOption ()
bool	compute (EigenMatrix &A, MathLib::LinearSolverBehaviour const linear_solver_behaviour)
bool	solve (EigenVector &b, EigenVector &x)
bool	solve (EigenMatrix &A, EigenVector &b, EigenVector &x, MathLib::LinearSolverBehaviour const linear_solver_behaviour=MathLib::LinearSolverBehaviour::RECOMPUTE)
	Computes and solves in a single call.

Protected Member Functions
void	setRestart ()
void	setL ()
void	setS ()
void	setSmoothing ()
void	setAngle ()
void	setResidualUpdate ()

Protected Attributes
EigenOption	option_
std::unique_ptr< EigenLinearSolverBase >	solver_

Constructor & Destructor Documentation

EigenLinearSolver()

MathLib::EigenLinearSolver::EigenLinearSolver ( std::string const & solver_name, EigenOption const & option )

explicit

Constructor

Parameters

solver_name	A name used as a prefix for command line options if there are such options available.
option	Eigen linear solver options.

Definition at line 453 of file EigenLinearSolver.cpp.

    : option_(option)
{
    using Matrix = EigenMatrix::RawMatrixType;
 
    switch (option_.solver_type)
    {
        case EigenOption::SolverType::SparseLU:
        {
            using SolverType =
                Eigen::SparseLU<Matrix, Eigen::COLAMDOrdering<int>>;
            solver_ = std::make_unique<
                details::EigenDirectLinearSolver<SolverType>>();
            return;
        }
        case EigenOption::SolverType::BiCGSTAB:
        case EigenOption::SolverType::BiCGSTABL:
        case EigenOption::SolverType::CG:
        case EigenOption::SolverType::GMRES:
        case EigenOption::SolverType::IDRS:
        case EigenOption::SolverType::IDRSTABL:
            solver_ = details::createIterativeSolver(option_.solver_type,
                                                     option_.precon_type);
            return;
        case EigenOption::SolverType::PardisoLU:
        {
#ifdef USE_MKL
            using SolverType = Eigen::PardisoLU<EigenMatrix::RawMatrixType>;
            solver_.reset(new details::EigenDirectLinearSolver<SolverType>);
            return;
#else
            OGS_FATAL(
                "The code is not compiled with Intel MKL. Linear solver type "
                "PardisoLU is not available.");
#endif
        }
    }
 
    OGS_FATAL("Invalid Eigen linear solver type. Aborting.");
}

References MathLib::EigenOption::BiCGSTAB, MathLib::EigenOption::BiCGSTABL, MathLib::EigenOption::CG, MathLib::details::createIterativeSolver(), MathLib::EigenOption::GMRES, MathLib::EigenOption::IDRS, MathLib::EigenOption::IDRSTABL, OGS_FATAL, option_, MathLib::EigenOption::PardisoLU, MathLib::EigenOption::precon_type, solver_, MathLib::EigenOption::solver_type, and MathLib::EigenOption::SparseLU.

~EigenLinearSolver()

MathLib::EigenLinearSolver::~EigenLinearSolver ( )

default

Member Function Documentation

compute()

bool MathLib::EigenLinearSolver::compute	(	EigenMatrix &	A,
		MathLib::LinearSolverBehaviour const	linear_solver_behaviour )

Performs the compute() step of the Eigen linear solver.

I.e., computes the (LU) decomposition in case of a direct solver, or computes the preconditioner of an iterative solver.

Definition at line 497 of file EigenLinearSolver.cpp.

{
    INFO("------------------------------------------------------------------");
    INFO("*** Eigen solver compute()");
 
    return solver_->compute(A.getRawMatrix(), option_, linear_solver_behaviour);
}

References MathLib::EigenMatrix::getRawMatrix(), INFO(), option_, and solver_.

getOption()

EigenOption & MathLib::EigenLinearSolver::getOption ( )

inline

get linear solver options

Definition at line 48 of file EigenLinearSolver.h.

{ return option_; }

References option_.

setAngle()

void MathLib::EigenLinearSolver::setAngle ( )

protected

setL()

void MathLib::EigenLinearSolver::setL ( )

protected

setOption()

void MathLib::EigenLinearSolver::setOption ( const EigenOption & option )

inline

copy linear solvers options

Definition at line 43 of file EigenLinearSolver.h.

{ option_ = option; }

References option_.

setResidualUpdate()

void MathLib::EigenLinearSolver::setResidualUpdate ( )

protected

setRestart()

void MathLib::EigenLinearSolver::setRestart ( )

protected

setS()

void MathLib::EigenLinearSolver::setS ( )

protected

setSmoothing()

void MathLib::EigenLinearSolver::setSmoothing ( )

protected

solve() [1/2]

bool MathLib::EigenLinearSolver::solve	(	EigenMatrix &	A,
		EigenVector &	b,
		EigenVector &	x,
		MathLib::LinearSolverBehaviour const	linear_solver_behaviour = MathLib::LinearSolverBehaviour::RECOMPUTE )

Computes and solves in a single call.

Definition at line 515 of file EigenLinearSolver.cpp.

{
    return solver_->compute(A.getRawMatrix(), option_,
                            linear_solver_behaviour) &&
           solver_->solve(b.getRawVector(), x.getRawVector(), option_);
}

References MathLib::EigenMatrix::getRawMatrix(), MathLib::EigenVector::getRawVector(), option_, and solver_.

solve() [2/2]

bool MathLib::EigenLinearSolver::solve	(	EigenVector &	b,
		EigenVector &	x )

Solves the linear system for the given right-hand side b and initial guess x.

Precondition

compute() must have been called before. (Not necessarily for every x and b separately, but for every new/changed matrix A.

Definition at line 507 of file EigenLinearSolver.cpp.

{
    INFO("------------------------------------------------------------------");
    INFO("*** Eigen solver solve()");
 
    return solver_->solve(b.getRawVector(), x.getRawVector(), option_);
}

References MathLib::EigenVector::getRawVector(), INFO(), option_, and solver_.

Member Data Documentation

option_

EigenOption MathLib::EigenLinearSolver::option_

protected

Definition at line 75 of file EigenLinearSolver.h.

Referenced by EigenLinearSolver(), compute(), getOption(), setOption(), solve(), and solve().

solver_

std::unique_ptr<EigenLinearSolverBase> MathLib::EigenLinearSolver::solver_

protected

Definition at line 76 of file EigenLinearSolver.h.

Referenced by EigenLinearSolver(), compute(), solve(), and solve().

---

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

• MathLib/LinAlg/Eigen/EigenLinearSolver.h
• MathLib/LinAlg/Eigen/EigenLinearSolver.cpp