ILinearSolver.h

Go to the documentation of this file.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------

 
#pragma once
 
#include <arccore/message_passing/MessagePassingGlobal.h>
#include <alien/utils/Precomp.h>
 
#include <memory>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ILinearAlgebra;
class Space;
class SolverStat;
class VectorData;
class IMatrix;
class IVector;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

struct SolverStatus
{
  SolverStatus()
  : succeeded(false)
  , residual(0)
  , iteration_count(0)
  , error(0)
  {}

  bool succeeded;
  Arccore::Real residual;
  Arccore::Integer iteration_count;
  Arccore::Integer error;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ILinearSolver
{
 public:
  typedef SolverStatus Status;
 
 public:
  ILinearSolver() {}

  virtual ~ILinearSolver() {}
 
 public:
  /*
   * \brief Get the back end name
   * \returns The back end name
   */
  virtual Arccore::String getBackEndName() const = 0;

  virtual void init() = 0;

  virtual void end() = 0;

  virtual void updateParallelMng(Arccore::MessagePassing::IMessagePassingMng* pm) = 0;

  virtual bool solve(const IMatrix& A, const IVector& b, IVector& x) = 0;
 
  /*
   * \brief Get statistics on the solve process
   * \returns Statistics on the solve process
   */
  virtual SolverStat const& getSolverStat() const = 0;

  virtual std::shared_ptr<ILinearAlgebra> algebra() const = 0;

  virtual bool hasParallelSupport() const = 0;

  virtual const SolverStatus& getStatus() const = 0;

  virtual void setNullSpaceConstantOption(bool flag) = 0;
 
#ifdef USE_MULTI_SOLVER_INSTANCE
  virtual ILinearSolver* create() const { return NULL; }
#endif /* USE_MULTI_SOLVER_INSTANCE */
 
};
 
class ILinearSolverWithDiagScaling
{
 public:

  ILinearSolverWithDiagScaling() {}

  virtual ~ILinearSolverWithDiagScaling() {}
 
  virtual void setDiagScaling(const IMatrix& matrix) = 0 ;
 
} ;
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/