Advanced Multi-Physics (AMP)
On-Line Documentation
ManagedVectorOperations.h
Go to the documentation of this file.
1#ifndef included_AMP_ManagedVectorOperations
2#define included_AMP_ManagedVectorOperations
3
4#include "AMP/vectors/operations/default/VectorOperationsDefault.h"
5
6
7namespace AMP::LinearAlgebra {
8
15{
16
17public:
19
20public:
21 //**********************************************************************
22 // functions that operate on VectorData
23 std::string VectorOpName() const override { return "ManagedVectorOperations"; }
24 void copy( const VectorData &src, VectorData &dst ) override;
25 void copyCast( const VectorData &src, VectorData &dst ) override;
26 void setToScalar( const Scalar &alpha, VectorData &z ) override;
27 void setRandomValues( VectorData &x ) override;
28 void scale( const Scalar &alpha, const VectorData &x, VectorData &y ) override;
29 void scale( const Scalar &alpha, VectorData &x ) override;
30 void add( const VectorData &x, const VectorData &y, VectorData &z ) override;
31 void subtract( const VectorData &x, const VectorData &y, VectorData &z ) override;
32 void multiply( const VectorData &x, const VectorData &y, VectorData &z ) override;
33 void divide( const VectorData &x, const VectorData &y, VectorData &z ) override;
34 void reciprocal( const VectorData &x, VectorData &y ) override;
35 void linearSum( const Scalar &alpha,
36 const VectorData &x,
37 const Scalar &beta,
38 const VectorData &y,
39 VectorData &z ) override;
40 void
41 axpy( const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z ) override;
42 void
43 axpby( const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y ) override;
44 void abs( const VectorData &x, VectorData &z ) override;
45
46 Scalar min( const VectorData &x ) const override;
47 Scalar max( const VectorData &x ) const override;
48 Scalar dot( const VectorData &x, const VectorData &y ) const override;
49 Scalar L1Norm( const VectorData &x ) const override;
50 Scalar L2Norm( const VectorData &x ) const override;
51 Scalar maxNorm( const VectorData &x ) const override;
52
53public: // Pull VectorOperations into the current scope
77};
78
79
80} // namespace AMP::LinearAlgebra
81
82
83#endif
Class used to control data and kernels of various vector libraries.
Scalar maxNorm(const VectorData &x) const override
Return the -norm of this vector.
Scalar dot(const VectorData &x, const VectorData &y) const override
Return the dot product of this vector with the argument vector.
void scale(const Scalar &alpha, VectorData &x) override
Scale a vector. For Vectors, .
std::string VectorOpName() const override
Get the type name.
void abs(const VectorData &x, VectorData &z) override
Set this to the component-wise absolute value of a vector. .
void scale(const Scalar &alpha, const VectorData &x, VectorData &y) override
Set vector equal to scaled input. For Vectors, .
void copyCast(const VectorData &src, VectorData &dst) override
Set vector equal to x (with different precision) For Vectors, .
Scalar min(const VectorData &x) const override
Return the minimum value of the vector. .
void multiply(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise multiply one vector with another. For Vectors, .
void divide(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise divide one vector by another. For Vectors, .
void reciprocal(const VectorData &x, VectorData &y) override
Set this to the component-wise reciprocal of a vector. .
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 max(const VectorData &x) const override
Return the maximum value of the vector. .
void copy(const VectorData &src, VectorData &dst) override
Set vector equal to x For Vectors, .
void axpy(const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z) override
Set this vector to alpha * x + y. .
Scalar L2Norm(const VectorData &x) const override
Return discrete -norm of this vector.
void subtract(const VectorData &x, const VectorData &y, VectorData &z) override
Subtracts one vector from another. For Vectors, .
void setRandomValues(VectorData &x) override
Set data in this vector to random values.
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 L1Norm(const VectorData &x) const override
Return discrete -norm of this vector.
void add(const VectorData &x, const VectorData &y, VectorData &z) override
Adds two vectors. For Vectors, .
A class used to hold vector data.
Definition VectorData.h:38
virtual Scalar wrmsNorm(const VectorData &x, const VectorData &y) const
Return a weighted norm of a vector.
void axpby(const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y) override
Set this vector alpha * x + this. .
void scale(const Scalar &alpha, const VectorData &x, VectorData &y) override
Set vector equal to scaled input. For Vectors, .
virtual Scalar max(const VectorData &x) const
Return the maximum value of the vector. .
void multiply(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise multiply one vector with another. For Vectors, .
virtual Scalar min(const VectorData &x) const
Return the minimum value of the vector. .
virtual Scalar maxNorm(const VectorData &x) const
Return the -norm of this vector.
virtual Scalar L1Norm(const VectorData &x) const
Return discrete -norm of this 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:
void add(const VectorData &x, const VectorData &y, VectorData &z) override
Adds two vectors. For Vectors, .
virtual Scalar dot(const VectorData &x, const VectorData &y) const
Return the dot product of this vector with the argument vector.
void abs(const VectorData &x, VectorData &z) override
Set this to the component-wise absolute value of a vector. .
void axpy(const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z) override
Set this vector to alpha * x + y. .
void zero(VectorData &z) override
Set vector entries (including ghosts) to zero.
void divide(const VectorData &x, const VectorData &y, VectorData &z) override
Component-wise divide one vector by another. For Vectors, .
virtual bool equals(const VectorData &x, const VectorData &y, const Scalar &tol) const
Check if two vectors are equal.
void subtract(const VectorData &x, const VectorData &y, VectorData &z) override
Subtracts one vector from another. For Vectors, .
void setRandomValues(VectorData &x) override
Set data in this vector to random values.
void reciprocal(const VectorData &x, VectorData &y) override
Set this to the component-wise reciprocal of a vector. .
virtual Scalar L2Norm(const VectorData &x) const
Return discrete -norm of this vector.
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 addScalar(const VectorData &x, const Scalar &alpha, VectorData &y) override
set vector to .
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