LinearSystem.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/CepsCommon.hpp"
 
#include "linearAlgebra/DistributedMatrix.hpp"
#include "linearAlgebra/DistributedVector.hpp"
 
// #include "linearAlgebra/SolverType.hpp"
 
// Implementation depends on compilation options
#ifdef CEPS_USE_PETSC
#include "petscksp.h"
typedef KSP CepsSolver;
#endif
 
class
 
  LinearSystem : public CepsObject
{
  public:
    LinearSystem ();
  
    explicit LinearSystem (InputParameters *params);
  
    ~LinearSystem () override;
 
    void
    setupWithParameters(InputParameters* params);
 
    virtual void
    solve(DVecPtr solution);
  
    void
    setLhsMatrix(DMatPtr lhs);
  
    void
    setPreconditioningMatrix(DMatPtr preconditioningMatrix);
  
    void
    setRhsVector(DVecPtr rhs);
  
    void
    setType(const CepsString &type);
  
    CepsSolver&
    getSolver();
  
    DMatPtr
    getLhsMatrix();
  
    DVecPtr
    getRhsVector();
  
    void
    setTolerances(CepsReal rTol, CepsReal aTol, CepsReal dTol, CepsUInt iter);
  
    void
    setMaxNbIterations(CepsUInt nbIterations);
  
    void
    setRelativeTolerance(CepsReal rTol);
  
    void
    setAbsoluteTolerance(CepsReal aTol);
  
    void
    setDivergenceTolerance(CepsReal dTol);
  
    CepsReal
    getRelativeTolerance() const;
  
    CepsReal
    getAbsoluteTolerance() const;
  
    CepsReal
    getDivergenceTolerance() const;
 
    CepsUInt
    getMaxNbIterations() const;
  
  private:
    void
    initialize();
  
    void
    setUp();
  
  protected:
    CepsSolver       m_solver;         
    DMatPtr          m_lhsMatrix;      
    DVecPtr          m_rhsVector;      
    DMatPtr          m_precondMatrix;  
  
    CepsReal m_absoluteTolerance;    
    CepsReal m_relativeTolerance;    
    CepsReal m_divergenceTolerance;  
    CepsUInt m_maxIterations;        
  
    CepsBool m_isSetUp;  
  
    CepsUInt m_avIterNb;  
    CepsUInt m_nSolv;     
};