PreconditionerBase.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_
#define GEOSX_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_

#include "linearAlgebra/common.hpp"
#include "linearAlgebra/interfaces/LinearOperator.hpp"

namespace geosx
{

class DofManager;

template< typename LAI >
class PreconditionerBase : public LinearOperator< typename LAI::ParallelVector >
{
public:

  PreconditionerBase()
    : m_mat{}
  {}

  virtual ~PreconditionerBase() = default;

  using Base = LinearOperator< typename LAI::ParallelVector >;

  using Vector = typename Base::Vector;

  using Matrix = typename LAI::ParallelMatrix;

  virtual void compute( Matrix const & mat )
  {
    GEOSX_LAI_ASSERT( mat.ready() );
    m_mat = &mat;
  }

  virtual void compute( Matrix const & mat,
                        DofManager const & dofManager )
  {
    GEOSX_UNUSED_VAR( dofManager );
    compute( 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();
  }

  bool ready() const
  {
    return m_mat != nullptr;
  }

  Matrix const & matrix() const
  {
    GEOSX_LAI_ASSERT( ready() );
    return *m_mat;
  }

  virtual bool hasPreconditionerMatrix() const
  {
    return false;
  }

  virtual Matrix const & preconditionerMatrix() const
  {
    GEOSX_ERROR( "PreconditionerBase::preconditionerMatrix called!. Should be overridden." );
    // This is here just to be able to compile ...
    return *m_mat;
  }

private:

  Matrix const * m_mat;
};

}

#endif //GEOSX_LINEARALGEBRA_SOLVERS_PRECONDITIONERBASE_HPP_