EigenLinearSolver.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <memory>
#include <vector>
 
#include "EigenOption.h"
#include "MathLib/LinAlg/LinearSolverBehaviour.h"
 
namespace MathLib
{
class EigenMatrix;
class EigenVector;
 
class EigenLinearSolverBase;
 
class EigenLinearSolver final
{
public:
    explicit EigenLinearSolver(std::string const& solver_name,
                               EigenOption const& option);
 
    ~EigenLinearSolver();

    void setOption(const EigenOption& option) { option_ = option; }

    EigenOption& getOption() { return option_; }

    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);

    bool canSolveRectangular() const { return can_solve_rectangular_; }

    bool willCompute(
        MathLib::LinearSolverBehaviour const linear_solver_behaviour) const;
 
protected:
    EigenOption option_;
    std::unique_ptr<EigenLinearSolverBase> solver_;
    bool can_solve_rectangular_ = false;
    void setRestart();
    void setL();
    void setS();
    void setSmoothing();
    void setAngle();
    void setResidualUpdate();
};
 
}  // namespace MathLib