SeparateComponentPreconditioner.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_SEPARATECOMPONENTPRECONDITIONER_HPP_
#define GEOS_LINEARALGEBRA_SOLVERS_SEPARATECOMPONENTPRECONDITIONER_HPP_
 
#include "linearAlgebra/common/PreconditionerBase.hpp"
 
#include <memory>
 
namespace geos
{
 
template< typename LAI >
class SeparateComponentPreconditioner : public PreconditionerBase< LAI >
{
public:
 
  using Base = PreconditionerBase< LAI >;
 
  using Vector = typename Base::Vector;
 
  using Matrix = typename Base::Matrix;
 
  SeparateComponentPreconditioner( localIndex const numComp,
                                   std::unique_ptr< PreconditionerBase< LAI > > precond );
 
  virtual ~SeparateComponentPreconditioner() override;
 
  virtual void setup( Matrix const & mat ) override;
 
  virtual void apply( Vector const & src, Vector & dst ) const override;
 
  virtual void clear() override;
 
  virtual bool hasPreconditionerMatrix() const override
  {
    return m_precond->hasPreconditionerMatrix();
  }
 
  virtual Matrix const & preconditionerMatrix() const override
  {
    return m_precond->preconditionerMatrix();
  }
 
  Matrix const & separateComponentMatrix() const
  {
    GEOS_LAI_ASSERT( Base::ready() );
    return m_matSC;
  }
 
  PreconditionerBase< LAI > const & innerPrecond() const
  {
    return *m_precond;
  }
 
private:
 
  localIndex m_numComp;
 
  Matrix m_matSC;
 
  std::unique_ptr< PreconditionerBase< LAI > > m_precond;
};
 
}
 
#endif //GEOS_LINEARALGEBRA_SOLVERS_SEPARATECOMPONENTPRECONDITIONER_HPP_