PreconditionerBase.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_
#define GEOS_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_
 
#include "linearAlgebra/common/common.hpp"
#include "linearAlgebra/common/LinearOperator.hpp"
 
namespace geos
{
 
class DofManager;
 
template< typename LAI >
class PreconditionerBase : public LinearOperator< typename LAI::ParallelVector >
{
public:
 
  PreconditionerBase() = default;
 
  virtual ~PreconditionerBase() = default;
 
  using Base = LinearOperator< typename LAI::ParallelVector >;
 
  using Vector = typename Base::Vector;
 
  using Matrix = typename LAI::ParallelMatrix;
 
  virtual void setup( Matrix const & mat )
  {
    GEOS_LAI_ASSERT( mat.ready() );
    GEOS_LAI_ASSERT_MSG( mat.numLocalRows() == mat.numLocalCols(), "Matrix must be square" );
    m_mat = &mat;
  }
 
  virtual void clear()
  {
    m_mat = nullptr;
  }
 
  virtual globalIndex numGlobalRows() const override
  {
    return m_mat->numGlobalRows();
  }
 
  virtual globalIndex numGlobalCols() const override
  {
    return m_mat->numGlobalCols();
  }
 
  virtual localIndex numLocalRows() const override
  {
    return m_mat->numLocalRows();
  }
 
  virtual localIndex numLocalCols() const override
  {
    return m_mat->numLocalCols();
  }
 
  virtual MPI_Comm comm() const override
  {
    return m_mat->comm();
  }
 
  bool ready() const
  {
    return m_mat != nullptr;
  }
 
  Matrix const & matrix() const
  {
    GEOS_LAI_ASSERT( ready() );
    return *m_mat;
  }
 
  virtual bool hasPreconditionerMatrix() const
  {
    return false;
  }
 
  virtual Matrix const & preconditionerMatrix() const
  {
    GEOS_ERROR( "PreconditionerBase::preconditionerMatrix called. This is not supposed to happen."
                "Check the value of hasPreconditionerMatrix() before accessing this function." );
    // This is here just to be able to compile ...
    return *m_mat;
  }
 
private:
 
  Matrix const * m_mat{};
};
 
}
 
#endif //GEOS_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_