LinearOperator.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_INTERFACES_LINEAROPERATOR_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_LINEAROPERATOR_HPP_
 
#include "common/DataTypes.hpp"
 
namespace geos
{
 
template< typename VECTOR >
class LinearOperator
{
public:
 
  using Vector = VECTOR;
 
  LinearOperator() = default;
 
  virtual ~LinearOperator() = default;
 
  virtual void apply( Vector const & src, Vector & dst ) const = 0;
 
  virtual void residual( Vector const & x, Vector const & b, Vector & r ) const
  {
    this->apply( x, r );
    r.axpby( 1.0, b, -1.0 );
  }
 
  virtual globalIndex numGlobalRows() const = 0;
 
  virtual globalIndex numGlobalCols() const = 0;
 
  virtual globalIndex numGlobalNonzeros() const
  {
    return 0;
  }
 
  virtual localIndex numLocalRows() const = 0;
 
  virtual localIndex numLocalCols() const = 0;
 
  virtual localIndex numLocalNonzeros() const
  {
    return 0;
  }
 
  virtual MPI_Comm comm() const = 0;
};
 
}
 
#endif //GEOS_LINEARALGEBRA_INTERFACES_LINEAROPERATOR_HPP_