Advanced Multi-Physics (AMP)
On-Line Documentation
VectorOperationsDevice.h
Go to the documentation of this file.
1#ifndef included_AMP_VectorOperationsDevice
2#define included_AMP_VectorOperationsDevice
3
4
5#include "AMP/vectors/operations/default/VectorOperationsDefault.h"
6
7
8namespace AMP {
9namespace LinearAlgebra {
10
11
17template<typename TYPE = double>
19{
20public:
21 // Constructor
23
26
28 virtual std::shared_ptr<VectorOperations> cloneOperations() const override;
29
30public:
31 // functions that operate on VectorData
32 std::string VectorOpName() const override { return "VectorOperationsDevice"; }
33 void zero( VectorData &z ) override;
34 void setToScalar( const Scalar &alpha, VectorData &z ) override;
35 void setRandomValues( VectorData &x ) override;
36 void copy( const VectorData &x, VectorData &z ) override;
37 void copyCast( const VectorData &x, VectorData &z ) override;
38 void scale( const Scalar &alpha, const VectorData &x, VectorData &y ) override;
39 void scale( const Scalar &alpha, VectorData &x ) override;
40 void add( const VectorData &x, const VectorData &y, VectorData &z ) override;
41 void subtract( const VectorData &x, const VectorData &y, VectorData &z ) override;
42 void multiply( const VectorData &x, const VectorData &y, VectorData &z ) override;
43 void divide( const VectorData &x, const VectorData &y, VectorData &z ) override;
44 void reciprocal( const VectorData &x, VectorData &y ) override;
45 void linearSum( const Scalar &alpha,
46 const VectorData &x,
47 const Scalar &beta,
48 const VectorData &y,
49 VectorData &z ) override;
50 void
51 axpy( const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z ) override;
52 void
53 axpby( const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y ) override;
54 void abs( const VectorData &x, VectorData &z ) override;
55 void addScalar( const VectorData &x, const Scalar &alpha_in, VectorData &y ) override;
56
57 void setMax( const Scalar &val, VectorData &x ) override;
58 void setMin( const Scalar &val, VectorData &x ) override;
59
60 Scalar localMin( const VectorData & ) const override;
61 Scalar localMax( const VectorData & ) const override;
62 Scalar localSum( const VectorData & ) const override;
63 Scalar localL1Norm( const VectorData & ) const override;
64 Scalar localL2Norm( const VectorData & ) const override;
65 Scalar localMaxNorm( const VectorData & ) const override;
66 Scalar localDot( const VectorData &x, const VectorData &y ) const override;
67 Scalar localMinQuotient( const VectorData &x, const VectorData &y ) const override;
68 Scalar localWrmsNorm( const VectorData &x, const VectorData &y ) const override;
70 const VectorData &mask,
71 const VectorData &y ) const override;
72 bool localEquals( const VectorData &x,
73 const VectorData &y,
74 const Scalar &tol = 1e-6 ) const override;
75
76public: // Pull VectorOperations into the current scope
94
95private:
99};
100
101
102} // namespace LinearAlgebra
103} // namespace AMP
104
105
106#endif
A class used to hold vector data.
Definition VectorData.h:38
A default set of vector operations.
void copyCast(const VectorData &x, VectorData &z) override
Set vector equal to x (with different precision) For Vectors, .
void scale(const Scalar &alpha, VectorData &x) override
Scale a vector. For Vectors, .
Scalar localWrmsNormMask(const VectorData &x, const VectorData &mask, const VectorData &y) const override
Return a weighted norm of a subset of a vector.
Scalar localMin(const VectorData &) const override
Return the local minimum value of the vector. .
void add(const VectorData &x, const VectorData &y, VectorData &z) override
Adds two vectors. For Vectors, .
void addScalar(const VectorData &x, const Scalar &alpha_in, VectorData &y) override
set vector to .
void linearSum(const Scalar &alpha, const VectorData &x, const Scalar &beta, const VectorData &y, VectorData &z) override
Set a vector to be a linear combination of two vectors. .
void axpby(const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y) override
Set this vector alpha * x + this. .
Scalar localWrmsNorm(const VectorData &x, const VectorData &y) const override
Return a weighted norm of a vector.
bool localEquals(const VectorData &x, const VectorData &y, const Scalar &tol=1e-6) const override
Determine if the local portion of two vectors are equal using an absolute tolerance.
void abs(const VectorData &x, VectorData &z) override
Set this to the component-wise absolute value of a vector. .
void setRandomValues(VectorData &x) override
Set data in this vector to random values.
void scale(const Scalar &alpha, const VectorData &x, VectorData &y) override
Set vector equal to scaled input. For Vectors, .
void multiply(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise multiply one vector with another. For Vectors, .
virtual std::shared_ptr< VectorOperations > cloneOperations() const override
Clone the operations.
std::string VectorOpName() const override
Get the type name.
Scalar localMax(const VectorData &) const override
Return the local maximum value of the vector. .
VectorOperationsDefault< TYPE > * d_default_ops
Scalar localSum(const VectorData &) const override
Return the local sum of the vector.
void copy(const VectorData &x, VectorData &z) override
Set vector equal to x For Vectors, .
void setToScalar(const Scalar &alpha, VectorData &z) override
Set all compenents of a vector to a scalar. For Vectors, the components of z are set to .
Scalar localDot(const VectorData &x, const VectorData &y) const override
Return the local dot product of this vector with the argument vector.
void reciprocal(const VectorData &x, VectorData &y) override
Set this to the component-wise reciprocal of a vector. .
void setMin(const Scalar &val, VectorData &x) override
modify vector to set .
void axpy(const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z) override
Set this vector to alpha * x + y. .
void subtract(const VectorData &x, const VectorData &y, VectorData &z) override
Subtracts one vector from another. For Vectors, .
Scalar localL1Norm(const VectorData &) const override
Return local discrete -norm of this vector.
void zero(VectorData &z) override
Set vector entries (including ghosts) to zero.
Scalar localMinQuotient(const VectorData &x, const VectorData &y) const override
Returns the local minimum of the quotient of two vectors:
Scalar localMaxNorm(const VectorData &) const override
Return the local -norm of this vector.
void setMax(const Scalar &val, VectorData &x) override
modify vector to set .
void divide(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise divide one vector by another. For Vectors, .
const VectorOperationsDefault< TYPE > * getDefaultOps(void) const
VectorOperationsDefault< TYPE > * getDefaultOps(void)
Scalar localL2Norm(const VectorData &) const override
Return local discrete -norm of this vector.
A class used to hold vector operations.
virtual Scalar wrmsNorm(const VectorData &x, const VectorData &y) const
Return a weighted norm of a vector.
virtual void scale(const Scalar &alpha, const VectorData &x, VectorData &y)=0
Set vector equal to scaled input. For Vectors, .
virtual void linearSum(const Scalar &alpha, const VectorData &x, const Scalar &beta, const VectorData &y, VectorData &z)=0
Set a vector to be a linear combination of two vectors. .
virtual void multiply(const VectorData &x, const VectorData &y, VectorData &z)=0
Component-wise multiply one vector with another. For Vectors, .
virtual void setRandomValues(VectorData &x)=0
Set data in this vector to random values.
virtual void abs(const VectorData &x, VectorData &z)=0
Set this to the component-wise absolute value of a vector. .
virtual Scalar wrmsNormMask(const VectorData &x, const VectorData &mask, const VectorData &y) const
Return a weighted norm of a subset of a vector.
virtual Scalar minQuotient(const VectorData &x, const VectorData &y) const
Returns the minimum of the quotient of two vectors:
virtual Scalar dot(const VectorData &x, const VectorData &y) const
Return the dot product of this vector with the argument vector.
virtual void addScalar(const VectorData &x, const Scalar &alpha, VectorData &y)=0
set vector to .
virtual bool equals(const VectorData &x, const VectorData &y, const Scalar &tol) const
Check if two vectors are equal.
virtual void reciprocal(const VectorData &x, VectorData &y)=0
Set this to the component-wise reciprocal of a vector. .
virtual void axpy(const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z)=0
Set this vector to alpha * x + y. .
virtual void divide(const VectorData &x, const VectorData &y, VectorData &z)=0
Component-wise divide one vector by another. For Vectors, .
virtual void add(const VectorData &x, const VectorData &y, VectorData &z)=0
Adds two vectors. For Vectors, .
virtual void axpby(const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y)=0
Set this vector alpha * x + this. .
virtual void subtract(const VectorData &x, const VectorData &y, VectorData &z)=0
Subtracts one vector from another. For Vectors, .
Scalar is a class used to store a scalar variable that may be different types/precision.
Definition Scalar.h:21



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:41.
Comments on this page