GEOS
HypreVector.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_LINEARALGEBRA_INTERFACES_HYPREVECTOR_HPP_
21 #define GEOS_LINEARALGEBRA_INTERFACES_HYPREVECTOR_HPP_
22 
24 
32 
33 extern "C"
34 {
36 struct hypre_ParVector_struct;
37 }
38 
40 
41 namespace geos
42 {
43 
50 class HypreVector final : private VectorBase< HypreVector >
51 {
52 public:
53 
58 
64 
69  HypreVector( HypreVector const & src );
70 
75  HypreVector( HypreVector && src ) noexcept;
76 
82  HypreVector & operator=( HypreVector const & src );
83 
89  HypreVector & operator=( HypreVector && src ) noexcept;
90 
95 
97 
102 
103  using VectorBase::setName;
104  using VectorBase::closed;
105  using VectorBase::ready;
106  using VectorBase::open;
107  using VectorBase::zero;
108  using VectorBase::values;
109 
113  virtual bool created() const override;
114 
115  virtual void create( localIndex const localSize,
116  MPI_Comm const & comm ) override;
117 
118  virtual void close() override;
119 
120  virtual void touch() override;
121 
122  virtual void reset() override;
123 
124  virtual void set( real64 const value ) override;
125 
126  virtual void rand( unsigned const seed ) override;
127 
128  virtual void scale( real64 const scalingFactor ) override;
129 
130  virtual void reciprocal() override;
131 
132  virtual real64 dot( HypreVector const & vec ) const override;
133 
134  virtual void copy( HypreVector const & x ) override;
135 
136  virtual void axpy( real64 const alpha,
137  HypreVector const & x ) override;
138 
139  virtual void axpby( real64 const alpha,
140  HypreVector const & x,
141  real64 const beta ) override;
142 
146  virtual void pointwiseProduct( HypreVector const & x ) override;
147 
151  virtual void pointwiseDivide( HypreVector const & x ) override;
152 
156  virtual real64 norm1() const override;
157 
161  virtual real64 norm2() const override;
162 
166  virtual real64 normInf() const override;
167 
171  virtual globalIndex globalSize() const override;
172 
176  virtual localIndex localSize() const override;
177 
181  virtual globalIndex ilower() const override;
182 
186  virtual globalIndex iupper() const override;
187 
191  virtual MPI_Comm comm() const override;
192 
193  virtual void print( std::ostream & os = std::cout ) const override;
194 
195  virtual void write( string const & filename,
196  LAIOutputFormat const format = LAIOutputFormat::MATRIX_MARKET ) const override;
197 
199 
200 private:
201 
203  using HYPRE_ParVector = struct hypre_ParVector_struct *;
204 
205 public:
206 
211  HYPRE_ParVector const & unwrapped() const;
212 
213 private:
214 
218  HYPRE_ParVector m_vec;
219 
220 };
221 
222 }// end namespace geos
223 
224 #endif /*GEOS_LINEARALGEBRA_INTERFACES_HYPREVECTOR_HPP_*/
Wrapper class for hypre's ParVector.
Definition: HypreVector.hpp:51
~HypreVector()
Destructor.
virtual bool created() const override
Query vector creation status.
HypreVector & operator=(HypreVector &&src) noexcept
Move assignment.
virtual real64 normInf() const override
Infinity-norm of the vector.
HypreVector(HypreVector &&src) noexcept
Move constructor.
virtual void create(localIndex const localSize, MPI_Comm const &comm) override
Create a vector based on local number of elements.
virtual void print(std::ostream &os=std::cout) const override
Print the vector in Trilinos format to the terminal.
virtual void close() override
Close vector for modification.
virtual void pointwiseProduct(HypreVector const &x) override
Element-wise multiplication of this vector with another vector.
virtual localIndex localSize() const override
Returns the local size of the vector.
virtual void axpby(real64 const alpha, HypreVector const &x, real64 const beta) override
Update vector y as y = alpha*x + beta*y.
virtual real64 dot(HypreVector const &vec) const override
Dot product with the vector vec.
virtual void reciprocal() override
Replace vector elements by their reciprocals.
virtual void set(real64 const value) override
Set all elements to a constant value.
virtual MPI_Comm comm() const override
Get the communicator used by this vector.
HypreVector()
Empty vector constructor. Create an empty (distributed) vector.
virtual void copy(HypreVector const &x) override
Update vector y as y = x.
virtual void rand(unsigned const seed) override
Set vector elements to random entries.
virtual real64 norm2() const override
2-norm of the vector.
virtual void pointwiseDivide(HypreVector const &x) override
Element-wise division of this vector by another vector.
virtual void touch() override
Notify the vector about external modification through direct data pointer.
virtual void write(string const &filename, LAIOutputFormat const format=LAIOutputFormat::MATRIX_MARKET) const override
Write the vector to a file.
virtual globalIndex globalSize() const override
Returns the global of the vector.
virtual globalIndex ilower() const override
Get lower bound of local partition.
virtual void scale(real64 const scalingFactor) override
Multiply all elements by factor.
virtual globalIndex iupper() const override
Get upper bound of local partition.
virtual real64 norm1() const override
1-norm of the vector.
virtual void axpy(real64 const alpha, HypreVector const &x) override
Update vector y as y = alpha*x + y.
HypreVector(HypreVector const &src)
Copy constructor.
virtual void reset() override
Reset the vector to default state.
HYPRE_ParVector const & unwrapped() const
Returns a pointer to the implementation.
HypreVector & operator=(HypreVector const &src)
Copy assignment.
Common base template for all vector wrapper types.
Definition: VectorBase.hpp:49
bool ready() const
Query vector ready status.
Definition: VectorBase.hpp:76
virtual arrayView1d< real64 > open()
Open the vector for modifying entries.
Definition: VectorBase.hpp:129
arrayView1d< real64 const > values() const
Definition: VectorBase.hpp:311
virtual void zero()
Set vector elements to zero.
Definition: VectorBase.hpp:181
bool closed() const
Query vector closed status.
Definition: VectorBase.hpp:64
void setName(string const &name)
Set a name for the vector (mainly used during various logging).
Definition: VectorBase.hpp:113
GEOS_GLOBALINDEX_TYPE globalIndex
Global index type (for indexing objects across MPI partitions).
Definition: DataTypes.hpp:87
LAIOutputFormat
Definition: common.hpp:142
double real64
64-bit floating point type.
Definition: DataTypes.hpp:98
GEOS_LOCALINDEX_TYPE localIndex
Local index type (for indexing objects within an MPI partition).
Definition: DataTypes.hpp:84