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