MathLib::EigenLinearSolverBase Class Reference

Detailed Description

Definition at line 29 of file EigenLinearSolver.cpp.

Inheritance diagram for MathLib::EigenLinearSolverBase:

Public Types
using	Vector = EigenVector::RawVectorType
using	Matrix = EigenMatrix::RawMatrixType

Public Member Functions
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

Protected Member Functions
virtual bool	solveImpl (Vector const &b, Vector &x, EigenOption &opt)=0
virtual bool	computeImpl (Matrix &A, EigenOption &opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour)=0

Private Attributes
bool	is_first_compute_call_ = true

Member Typedef Documentation

Matrix

using MathLib::EigenLinearSolverBase::Matrix = EigenMatrix::RawMatrixType

Definition at line 33 of file EigenLinearSolver.cpp.

Vector

using MathLib::EigenLinearSolverBase::Vector = EigenVector::RawVectorType

Definition at line 32 of file EigenLinearSolver.cpp.

Constructor & Destructor Documentation

~EigenLinearSolverBase()

virtual MathLib::EigenLinearSolverBase::~EigenLinearSolverBase ( )

virtualdefault

Member Function Documentation

compute()

bool MathLib::EigenLinearSolverBase::compute ( Matrix & A, EigenOption & opt, MathLib::LinearSolverBehaviour linear_solver_behaviour )

inline

Definition at line 58 of file EigenLinearSolver.cpp.

    {
        if (linear_solver_behaviour == MathLib::LinearSolverBehaviour::REUSE)
        {
            // Checking if this is the first compute() call should work both for
            // direct solvers (that factorize the matrix A) and for iterative
            // solvers (that store a reference to A in the preconditioner).
            if (is_first_compute_call_)
            {
                // There is nothing there, yet, to be reused. Hence, we compute
                // and store the result.
                linear_solver_behaviour =
                    MathLib::LinearSolverBehaviour::RECOMPUTE_AND_STORE;
            }
            else
            {
                return true;
            }
        }
 
        // TODO (CL) That might not work under all circumstances, e.g., if the
        // linear solver fails subsequently. Time will tell.
        is_first_compute_call_ = false;
 
#ifdef USE_EIGEN_UNSUPPORTED
        if (opt.scaling)
        {
            INFO("-> scale");
            scaling_ = std::make_unique<
                Eigen::IterScaling<EigenMatrix::RawMatrixType>>();
            scaling_->computeRef(A);
        }
#endif
 
        return computeImpl(A, opt, linear_solver_behaviour);
    }

References computeImpl(), INFO(), is_first_compute_call_, MathLib::RECOMPUTE_AND_STORE, and MathLib::REUSE.

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

computeImpl()

virtual bool MathLib::EigenLinearSolverBase::computeImpl ( Matrix & A, EigenOption & opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour )

protectedpure virtual

Implemented in MathLib::details::EigenDirectLinearSolver< T_SOLVER >, and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >.

Referenced by compute().

didComputeAtLeastOnce()

bool MathLib::EigenLinearSolverBase::didComputeAtLeastOnce ( ) const

inline

Definition at line 96 of file EigenLinearSolver.cpp.

{ return !is_first_compute_call_; }

References is_first_compute_call_.

solve()

bool MathLib::EigenLinearSolverBase::solve ( Vector & b, Vector & x, EigenOption & opt )

inline

Definition at line 37 of file EigenLinearSolver.cpp.

    {
#ifdef USE_EIGEN_UNSUPPORTED
        if (scaling_)
        {
            b = scaling_->LeftScaling().cwiseProduct(b);
        }
#endif
 
        auto const success = solveImpl(b, x, opt);
 
#ifdef USE_EIGEN_UNSUPPORTED
        if (scaling_)
        {
            x = scaling_->RightScaling().cwiseProduct(x);
        }
#endif
 
        return success;
    }

References solveImpl().

solveImpl()

virtual bool MathLib::EigenLinearSolverBase::solveImpl ( Vector const & b, Vector & x, EigenOption & opt )

protectedpure virtual

Implemented in MathLib::details::EigenDirectLinearSolver< T_SOLVER >, and MathLib::details::EigenIterativeLinearSolver< T_SOLVER >.

Referenced by solve().

Member Data Documentation

is_first_compute_call_

bool MathLib::EigenLinearSolverBase::is_first_compute_call_ = true

private

Definition at line 110 of file EigenLinearSolver.cpp.

Referenced by compute(), and didComputeAtLeastOnce().

---

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

• EigenLinearSolver.cpp