HypreVector.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_HYPREVECTOR_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_HYPREVECTOR_HPP_
 
#include "linearAlgebra/interfaces/VectorBase.hpp"
 
 
extern "C"
{
struct hypre_ParVector_struct;
}
 
 
namespace geos
{
 
class HypreVector final : private VectorBase< HypreVector >
{
public:
 
 
  HypreVector();
 
  HypreVector( HypreVector const & src );
 
  HypreVector( HypreVector && src ) noexcept;
 
  HypreVector & operator=( HypreVector const & src );
 
  HypreVector & operator=( HypreVector && src ) noexcept;
 
  ~HypreVector();
 
 
 
  using VectorBase::setName;
  using VectorBase::closed;
  using VectorBase::ready;
  using VectorBase::open;
  using VectorBase::zero;
  using VectorBase::values;
 
  virtual bool created() const override;
 
  virtual void create( localIndex const localSize,
                       MPI_Comm const & comm ) override;
 
  virtual void close() override;
 
  virtual void touch() override;
 
  virtual void reset() override;
 
  virtual void set( real64 const value ) override;
 
  virtual void rand( unsigned const seed ) override;
 
  virtual void scale( real64 const scalingFactor ) override;
 
  virtual void reciprocal() override;
 
  virtual real64 dot( HypreVector const & vec ) const override;
 
  virtual void copy( HypreVector const & x ) override;
 
  virtual void axpy( real64 const alpha,
                     HypreVector const & x ) override;
 
  virtual void axpby( real64 const alpha,
                      HypreVector const & x,
                      real64 const beta ) override;
 
  virtual void pointwiseProduct( HypreVector const & x ) override;
 
  virtual void pointwiseDivide( HypreVector const & x ) override;
 
  virtual real64 norm1() const override;
 
  virtual real64 norm2() const override;
 
  virtual real64 normInf() const override;
 
  virtual globalIndex globalSize() const override;
 
  virtual localIndex localSize() const override;
 
  virtual globalIndex ilower() const override;
 
  virtual globalIndex iupper() const override;
 
  virtual MPI_Comm comm() const override;
 
  virtual void print( std::ostream & os = std::cout ) const override;
 
  virtual void write( string const & filename,
                      LAIOutputFormat const format = LAIOutputFormat::MATRIX_MARKET ) const override;
 
 
private:
 
  using HYPRE_ParVector = struct hypre_ParVector_struct *;
 
public:
 
  HYPRE_ParVector const & unwrapped() const;
 
private:
 
  HYPRE_ParVector m_vec;
 
};
 
}// end namespace geos
 
#endif /*GEOS_LINEARALGEBRA_INTERFACES_HYPREVECTOR_HPP_*/