Detailed Description

Linear solver using Lis library with Eigen matrix and vector objects

Definition at line 29 of file EigenLisLinearSolver.h.

#include <EigenLisLinearSolver.h>

Collaboration diagram for MathLib::EigenLisLinearSolver:

Public Member Functions
	EigenLisLinearSolver (const std::string solver_name, BaseLib::ConfigTree const *const option)

void	setOption (const LisOption &option)

bool	solve (EigenMatrix &A, EigenVector &b, EigenVector &x)

Private Attributes
LisOption	lis_option_

Constructor & Destructor Documentation

◆ EigenLisLinearSolver()

MathLib::EigenLisLinearSolver::EigenLisLinearSolver	(	const std::string	solver_name,
		BaseLib::ConfigTree const *const	option
	)

Constructor

Parameters

solver_name	A name used as a prefix for command line options if there are such options available.
option	A pointer to a linear solver option. In case you omit this argument, default settings follow those of LisOption struct.

Definition at line 26 of file EigenLisLinearSolver.cpp.

     : lis_option_(option)
 {
 }

Member Function Documentation

◆ setOption()

void MathLib::EigenLisLinearSolver::setOption ( const LisOption & option )

inline

copy linear solvers options

Definition at line 46 of file EigenLisLinearSolver.h.

46 { lis_option_ = option; }

References lis_option_.

◆ solve()

bool MathLib::EigenLisLinearSolver::solve	(	EigenMatrix &	A,
		EigenVector &	b,
		EigenVector &	x
	)

Definition at line 32 of file EigenLisLinearSolver.cpp.

 {
     static_assert(EigenMatrix::RawMatrixType::IsRowMajor,
                   "Sparse matrix is required to be in row major storage.");
     auto& A = A_.getRawMatrix();
     auto& b = b_.getRawVector();
     auto& x = x_.getRawVector();
  
     if (!A.isCompressed())
         A.makeCompressed();
     int nnz = A.nonZeros();
     int* ptr = A.outerIndexPtr();
     int* col = A.innerIndexPtr();
     double* data = A.valuePtr();
     LisMatrix lisA(A_.getNumberOfRows(), nnz, ptr, col, data);
     LisVector lisb(b.rows(), b.data());
     LisVector lisx(x.rows(), x.data());
  
     LisLinearSolver lissol;  // TODO not always create Lis solver here
     lissol.setOption(lis_option_);
     bool const status = lissol.solve(lisA, lisb, lisx);
  
     for (std::size_t i = 0; i < lisx.size(); i++)
         x[i] = lisx[i];
  
     return status;
 }

References MathLib::EigenMatrix::getNumberOfRows(), MathLib::EigenMatrix::getRawMatrix(), MathLib::EigenVector::getRawVector(), lis_option_, MathLib::LisLinearSolver::setOption(), MathLib::LisVector::size(), and MathLib::LisLinearSolver::solve().

Referenced by ProcessLib::ComponentTransport::ComponentTransportProcess::solveReactionEquation().

Member Data Documentation

◆ lis_option_

LisOption MathLib::EigenLisLinearSolver::lis_option_

private

Definition at line 51 of file EigenLisLinearSolver.h.

Referenced by setOption(), and solve().

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

MathLib/LinAlg/EigenLis/EigenLisLinearSolver.h
MathLib/LinAlg/EigenLis/EigenLisLinearSolver.cpp