GEOSX
EpetraVector.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
7  * Copyright (c) 2018-2020 TotalEnergies
8  * Copyright (c) 2019- GEOSX Contributors
9  * All rights reserved
10  *
11  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
12  * ------------------------------------------------------------------------------------------------------------
13  */
14 
19 #ifndef GEOS_LINEARALGEBRA_INTERFACES_EPETRAVECTOR_HPP_
20 #define GEOS_LINEARALGEBRA_INTERFACES_EPETRAVECTOR_HPP_
21 
23 
24 class Epetra_Vector;
25 
26 namespace geos
27 {
28 
32 class EpetraVector final : private VectorBase< EpetraVector >
33 {
34 public:
35 
40 
46 
51  EpetraVector( EpetraVector const & src );
52 
57  EpetraVector( EpetraVector && src ) noexcept;
58 
65 
71  EpetraVector & operator=( EpetraVector && src ) noexcept;
72 
77 
79 
84 
85  using VectorBase::setName;
86  using VectorBase::closed;
87  using VectorBase::ready;
88  using VectorBase::open;
89  using VectorBase::zero;
90  using VectorBase::values;
91 
95  virtual bool created() const override;
96 
97  virtual void create( localIndex const localSize,
98  MPI_Comm const & comm ) override;
99 
100  virtual void close() override;
101 
102  virtual void touch() override;
103 
104  virtual void reset() override;
105 
106  virtual void set( real64 const value ) override;
107 
108  virtual void rand( unsigned const seed ) override;
109 
110  virtual void scale( real64 const scalingFactor ) override;
111 
112  virtual void reciprocal() override;
113 
114  virtual real64 dot( EpetraVector const & vec ) const override;
115 
116  virtual void copy( EpetraVector const & x ) override;
117 
118  virtual void axpy( real64 const alpha,
119  EpetraVector const & x ) override;
120 
121  virtual void axpby( real64 const alpha,
122  EpetraVector const & x,
123  real64 const beta ) override;
124 
125  virtual void pointwiseProduct( EpetraVector const & x,
126  EpetraVector & y ) const override;
127 
131  virtual real64 norm1() const override;
132 
136  virtual real64 norm2() const override;
137 
141  virtual real64 normInf() const override;
142 
146  virtual globalIndex globalSize() const override;
147 
151  virtual localIndex localSize() const override;
152 
156  virtual globalIndex ilower() const override;
157 
161  virtual globalIndex iupper() const override;
162 
166  virtual MPI_Comm comm() const override;
167 
168  virtual void print( std::ostream & os = std::cout ) const override;
169 
170  virtual void write( string const & filename,
171  LAIOutputFormat const format = LAIOutputFormat::MATRIX_MARKET ) const override;
172 
174 
179  Epetra_Vector const & unwrapped() const;
180 
185  Epetra_Vector & unwrapped();
186 
187 private:
188 
190  std::unique_ptr< Epetra_Vector > m_vec;
191 };
192 
193 } // end geosx namespace
194 
195 #endif /*GEOS_LINEARALGEBRA_INTERFACES_EPETRAVECTOR_HPP_*/
Wrapper around Trilinos' Epetra_Vector object.
EpetraVector()
Empty vector constructor. Create an empty (distributed) vector.
virtual void close() override
Close vector for modification.
virtual void scale(real64 const scalingFactor) override
Multiply all elements by factor.
virtual void touch() override
Notify the vector about external modification through direct data pointer.
EpetraVector & operator=(EpetraVector &&src) noexcept
Move assignment.
virtual void write(string const &filename, LAIOutputFormat const format=LAIOutputFormat::MATRIX_MARKET) const override
Write the vector to a file.
virtual void copy(EpetraVector const &x) override
Update vector y as y = x.
Epetra_Vector const & unwrapped() const
Returns a const pointer to the underlying Epetra object.
virtual real64 norm2() const override
2-norm of the vector.
virtual void print(std::ostream &os=std::cout) const override
Print the vector in Trilinos format to the terminal.
virtual void set(real64 const value) override
Set all elements to a constant value.
virtual void pointwiseProduct(EpetraVector const &x, EpetraVector &y) const override
Compute the component-wise multiplication y = v * x.
virtual globalIndex iupper() const override
Get upper bound of local partition.
virtual localIndex localSize() const override
Returns the local size of the vector.
virtual void reciprocal() override
Replace vector elements by their reciprocals.
EpetraVector(EpetraVector &&src) noexcept
Move constructor.
EpetraVector(EpetraVector const &src)
Copy constructor.
virtual void axpy(real64 const alpha, EpetraVector const &x) override
Update vector y as y = alpha*x + y.
virtual globalIndex ilower() const override
Get lower bound of local partition.
virtual void rand(unsigned const seed) override
Set vector elements to random entries.
EpetraVector & operator=(EpetraVector const &src)
Copy assignment.
virtual real64 normInf() const override
Infinity-norm of the vector.
virtual void create(localIndex const localSize, MPI_Comm const &comm) override
Create a vector based on local number of elements.
virtual globalIndex globalSize() const override
Returns the global of the vector.
virtual bool created() const override
Query vector creation status.
virtual void axpby(real64 const alpha, EpetraVector const &x, real64 const beta) override
Update vector y as y = alpha*x + beta*y.
Epetra_Vector & unwrapped()
Returns a non-const pointer to the underlying Epetra object.
virtual real64 dot(EpetraVector const &vec) const override
Dot product with the vector vec.
~EpetraVector()
Destructor.
virtual void reset() override
Reset the vector to default state.
virtual MPI_Comm comm() const override
Get the communicator used by this vector.
virtual real64 norm1() const override
1-norm of the vector.
Common base template for all vector wrapper types.
Definition: VectorBase.hpp:48
bool ready() const
Query vector ready status.
Definition: VectorBase.hpp:75
virtual arrayView1d< real64 > open()
Open the vector for modifying entries.
Definition: VectorBase.hpp:128
arrayView1d< real64 const > values() const
Definition: VectorBase.hpp:304
virtual void zero()
Set vector elements to zero.
Definition: VectorBase.hpp:180
bool closed() const
Query vector closed status.
Definition: VectorBase.hpp:63
void setName(string const &name)
Set a name for the vector (mainly used during various logging).
Definition: VectorBase.hpp:112
LAIOutputFormat
Definition: common.hpp:140
double real64
64-bit floating point type.
Definition: DataTypes.hpp:139
GEOSX_GLOBALINDEX_TYPE globalIndex
Global index type (for indexing objects across MPI partitions).
Definition: DataTypes.hpp:128
GEOSX_LOCALINDEX_TYPE localIndex
Local index type (for indexing objects within an MPI partition).
Definition: DataTypes.hpp:125