A class used to hold vector operations. More...

#include <VectorOperations.h>

Inheritance diagram for AMP::LinearAlgebra::VectorOperations:

[legend]

Public Member Functions
virtual void	abs (const VectorData &x, VectorData &z)=0
	Set this to the component-wise absolute value of a vector. \(z_i = \|x_i\|\).

virtual void	add (const VectorData &x, const VectorData &y, VectorData &z)=0
	Adds two vectors. For Vectors, \(\mathit{this}_i = x_i + y_i\).

virtual void	addScalar (const VectorData &x, const Scalar &alpha, VectorData &y)=0
	set vector to \(x + \alpha \bar{1}\).

virtual void	axpby (const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y)=0
	Set this vector alpha * x + this. \(y_i = \alpha x_i + \beta y_i \).

virtual void	axpy (const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z)=0
	Set this vector to alpha * x + y. \(z_i = \alpha x_i + y_i\).

virtual std::shared_ptr< VectorOperations >	cloneOperations () const =0
	Clone the operations.

virtual void	copy (const VectorData &x, VectorData &z)=0
	Set vector equal to x For Vectors, \(z_i = x_i\).

virtual void	copyCast (const VectorData &x, VectorData &z)=0
	Set vector equal to x (with different precision) For Vectors, \(z_i = x_i\).

virtual void	divide (const VectorData &x, const VectorData &y, VectorData &z)=0
	Component-wise divide one vector by another. For Vectors, \(z_i = x_i / y_i\).

virtual Scalar	dot (const VectorData &x, const VectorData &y) const
	Return the dot product of this vector with the argument vector.

virtual bool	equals (const VectorData &x, const VectorData &y, const Scalar &tol) const
	Check if two vectors are equal.

uint64_t	getID () const
	Get a unique id hash for the vector.

virtual Scalar	L1Norm (const VectorData &x) const
	Return discrete \( L_1 \) -norm of this vector.

virtual Scalar	L2Norm (const VectorData &x) const
	Return discrete \( L_2 \) -norm of this vector.

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. \(z_i = \alpha x_i + \beta y_i\).

virtual Scalar	localDot (const VectorData &x, const VectorData &y) const =0
	Return the local dot product of this vector with the argument vector.

virtual bool	localEquals (const VectorData &x, const VectorData &y, const Scalar &tol=1e-6) const =0
	Determine if the local portion of two vectors are equal using an absolute tolerance.

virtual Scalar	localL1Norm (const VectorData &x) const =0
	Return local discrete \( L_1 \) -norm of this vector.

virtual Scalar	localL2Norm (const VectorData &x) const =0
	Return local discrete \( L_2 \) -norm of this vector.

virtual Scalar	localMax (const VectorData &x) const =0
	Return the local maximum value of the vector. \(\max_i x_i\).

virtual Scalar	localMaxNorm (const VectorData &x) const =0
	Return the local \( L_\infty \) -norm of this vector.

virtual Scalar	localMin (const VectorData &x) const =0
	Return the local minimum value of the vector. \(\min_i x_i\).

virtual Scalar	localMinQuotient (const VectorData &x, const VectorData &y) const =0
	Returns the local minimum of the quotient of two vectors:

virtual Scalar	localSum (const VectorData &x) const =0
	Return the local sum of the vector.

virtual Scalar	localWrmsNorm (const VectorData &x, const VectorData &y) const =0
	Return a weighted norm of a vector.

virtual Scalar	localWrmsNormMask (const VectorData &x, const VectorData &mask, const VectorData &y) const =0
	Return a weighted norm of a subset of a vector.

virtual Scalar	max (const VectorData &x) const
	Return the maximum value of the vector. \(\max_i x_i\).

virtual Scalar	maxNorm (const VectorData &x) const
	Return the \( L_\infty \) -norm of this vector.

Scalar	mean (const VectorData &x) const
	Return the mean of the values of the vector.

virtual Scalar	min (const VectorData &x) const
	Return the minimum value of the vector. \(\min_i x_i\).

virtual Scalar	minQuotient (const VectorData &x, const VectorData &y) const
	Returns the minimum of the quotient of two vectors:

virtual void	multiply (const VectorData &x, const VectorData &y, VectorData &z)=0
	Component-wise multiply one vector with another. For Vectors, \(z_i = x_i y_i\).

virtual void	reciprocal (const VectorData &x, VectorData &y)=0
	Set this to the component-wise reciprocal of a vector. \(y_i = 1/x_i\).

virtual void	registerChildObjects (AMP::IO::RestartManager *manager) const
	Register any child objects.

virtual void	scale (const Scalar &alpha, const VectorData &x, VectorData &y)=0
	Set vector equal to scaled input. For Vectors, \(y_i = \alpha x_i\).

virtual void	scale (const Scalar &alpha, VectorData &x)=0
	Scale a vector. For Vectors, \(x_i = \alpha x_i\).

virtual void	setMax (const Scalar &val, VectorData &x)=0
	modify vector to set \(x_i = max(x_i, val)\).

virtual void	setMin (const Scalar &val, VectorData &x)=0
	modify vector to set \(x_i = min(x_i, val)\).

virtual void	setRandomValues (VectorData &x)=0
	Set data in this vector to random values.

virtual void	setToScalar (const Scalar &alpha, VectorData &z)=0
	Set all compenents of a vector to a scalar. For Vectors, the components of z are set to \(\alpha\).

virtual void	subtract (const VectorData &x, const VectorData &y, VectorData &z)=0
	Subtracts one vector from another. For Vectors, \(z_i = x_i - y_i\).

virtual Scalar	sum (const VectorData &x) const
	Return the sum of the values of the vector.

virtual std::string	VectorOpName () const =0
	Get the type name.

virtual void	writeRestart (int64_t fid) const
	Write restart data to file.

virtual Scalar	wrmsNorm (const VectorData &x, const VectorData &y) const
	Return a weighted norm 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 void	zero (VectorData &x)=0
	Set vector entries (including ghosts) to zero.

virtual	~VectorOperations ()
	Destructor.

Protected Member Functions
	VectorOperations ()

Protected Attributes
uint64_t	d_hash = 0

Detailed Description

A class used to hold vector operations.

VectorOperations is a class used to perform vector operations such as dot product, norms, etc.

Definition at line 26 of file VectorOperations.h.

Constructor & Destructor Documentation

◆ ~VectorOperations()

virtual AMP::LinearAlgebra::VectorOperations::~VectorOperations ( )

inlinevirtual

Destructor.

Definition at line 30 of file VectorOperations.h.

◆ VectorOperations()

AMP::LinearAlgebra::VectorOperations::VectorOperations ( )

protected

Member Function Documentation

◆ abs()

virtual void AMP::LinearAlgebra::VectorOperations::abs	(	const VectorData &	x,
		VectorData &	z
	)

pure virtual

Set this to the component-wise absolute value of a vector. \(z_i = |x_i|\).

Parameters

[in]	x	a vector
[out]	z	Output vector z

◆ add()

virtual void AMP::LinearAlgebra::VectorOperations::add	(	const VectorData &	x,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Adds two vectors. For Vectors, \(\mathit{this}_i = x_i + y_i\).

Parameters

[in]	x	Input vector x
[in]	y	Input vector y
[out]	z	Output vector z

◆ addScalar()

virtual void AMP::LinearAlgebra::VectorOperations::addScalar	(	const VectorData &	x,
		const Scalar &	alpha,
		VectorData &	y
	)

pure virtual

set vector to \(x + \alpha \bar{1}\).

for vectors, \(y_i = x_i + \alpha\).

Parameters

[in]	x	a vector
[in]	alpha	a scalar
[out]	y	Output vector y

◆ axpby()

virtual void AMP::LinearAlgebra::VectorOperations::axpby	(	const Scalar &	alpha,
		const Scalar &	beta,
		const VectorData &	x,
		VectorData &	y
	)

pure virtual

Set this vector alpha * x + this. \(y_i = \alpha x_i + \beta y_i \).

Parameters

[in]	alpha	a scalar
[in]	beta	a scalar
[in]	x	a vector
[in,out]	y	Output vector z

◆ axpy()

virtual void AMP::LinearAlgebra::VectorOperations::axpy	(	const Scalar &	alpha,
		const VectorData &	x,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Set this vector to alpha * x + y. \(z_i = \alpha x_i + y_i\).

Parameters

[in]	alpha	a scalar
[in]	x	a vector
[in]	y	a vector
[out]	z	Output vector z

◆ cloneOperations()

virtual std::shared_ptr< VectorOperations > AMP::LinearAlgebra::VectorOperations::cloneOperations ( ) const

pure virtual

Clone the operations.

Implemented in AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, and AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >.

◆ copy()

virtual void AMP::LinearAlgebra::VectorOperations::copy	(	const VectorData &	x,
		VectorData &	z
	)

pure virtual

Set vector equal to x For Vectors, \(z_i = x_i\).

Parameters

[in]	x	a vector
[out]	z	a vector

◆ copyCast()

virtual void AMP::LinearAlgebra::VectorOperations::copyCast	(	const VectorData &	x,
		VectorData &	z
	)

pure virtual

Set vector equal to x (with different precision) For Vectors, \(z_i = x_i\).

Parameters

[in]	x	a vector
[out]	z	a vector

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::ManagedVectorOperations, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::MultiVectorOperations, and AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >.

◆ divide()

virtual void AMP::LinearAlgebra::VectorOperations::divide	(	const VectorData &	x,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Component-wise divide one vector by another. For Vectors, \(z_i = x_i / y_i\).

Parameters

[in]	x	Input vector x
[in]	y	Input vector y
[out]	z	Output vector z

◆ dot()

virtual Scalar AMP::LinearAlgebra::VectorOperations::dot	(	const VectorData &	x,
		const VectorData &	y
	)		const

virtual

Return the dot product of this vector with the argument vector.

Returns

\[\sum_i x_i y_i\]

Parameters

[in]	x	a vector
[in,out]	y	a vector

◆ equals()

virtual bool AMP::LinearAlgebra::VectorOperations::equals	(	const VectorData &	x,
		const VectorData &	y,
		const Scalar &	tol
	)		const

virtual

Check if two vectors are equal.

Returns true if all values are equal within tolerance

Parameters

[in]	x	a vector
[in]	y	a vector
[in]	tol	tolerance to use

Reimplemented in AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::ManagedVectorOperations, AMP::LinearAlgebra::MultiVectorOperations, and AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >.

◆ getID()

uint64_t AMP::LinearAlgebra::VectorOperations::getID ( ) const

Get a unique id hash for the vector.

◆ L1Norm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::L1Norm ( const VectorData & x ) const

virtual

Return discrete \( L_1 \) -norm of this vector.

Returns

\[\sum_i |x_i|\]

Parameters

[in] x a vector

◆ L2Norm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::L2Norm ( const VectorData & x ) const

virtual

Return discrete \( L_2 \) -norm of this vector.

Returns

\[\sqrt{\sum_i x_i^2}\]

Parameters

[in] x a vector

◆ linearSum()

virtual void AMP::LinearAlgebra::VectorOperations::linearSum	(	const Scalar &	alpha,
		const VectorData &	x,
		const Scalar &	beta,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Set a vector to be a linear combination of two vectors. \(z_i = \alpha x_i + \beta y_i\).

Parameters

[in]	alpha	a scalar
[in]	x	a vector
[in]	beta	a scalar
[in]	y	a vector
[out]	z	Output vector z

◆ localDot()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localDot	(	const VectorData &	x,
		const VectorData &	y
	)		const

pure virtual

Return the local dot product of this vector with the argument vector.

Returns

\[\sum_i x_i y_i\]

Parameters

[in]	x	a vector
[in]	y	a vector

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::NativePetscVectorOperations, and AMP::LinearAlgebra::EpetraVectorOperations.

◆ localEquals()

virtual bool AMP::LinearAlgebra::VectorOperations::localEquals	(	const VectorData &	x,
		const VectorData &	y,
		const Scalar &	tol = `1e-6`
	)		const

pure virtual

Determine if the local portion of two vectors are equal using an absolute tolerance.

Parameters

[in]	x	a vector
[in]	y	a vector
[in]	tol	Tolerance of comparison

Returns: True iff \(||y - x||_\infty < \mathit{tol}\)

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::VectorOperationsDevice< TYPE >.

◆ localL1Norm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localL1Norm ( const VectorData & x ) const

pure virtual

Return local discrete \( L_1 \) -norm of this vector.

Returns

\[\sum_i |x_i|\]

Parameters

[in] x a vector

◆ localL2Norm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localL2Norm ( const VectorData & x ) const

pure virtual

Return local discrete \( L_2 \) -norm of this vector.

Returns

\[\sqrt{\sum_i x_i^2}\]

Parameters

[in] x a vector

◆ localMax()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localMax ( const VectorData & x ) const

pure virtual

Return the local maximum value of the vector. \(\max_i x_i\).

Parameters

[in] x a vector

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::EpetraVectorOperations.

◆ localMaxNorm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localMaxNorm ( const VectorData & x ) const

pure virtual

Return the local \( L_\infty \) -norm of this vector.

Returns

\[\max_i |x_i|\]

Parameters

[in] x a vector

◆ localMin()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localMin ( const VectorData & x ) const

pure virtual

Return the local minimum value of the vector. \(\min_i x_i\).

Parameters

[in] x a vector

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::EpetraVectorOperations.

◆ localMinQuotient()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localMinQuotient	(	const VectorData &	x,
		const VectorData &	y
	)		const

pure virtual

Returns the local minimum of the quotient of two vectors:

\[\min_{i,y_i\neq0} x_i/y_i\]

Parameters

[in]	x	a vector
[in]	y	a vector

Returns: \[\min_{i,y_i\neq0} x_i/y_i\]

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::VectorOperationsDevice< TYPE >.

◆ localSum()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localSum ( const VectorData & x ) const

pure virtual

Return the local sum of the vector.

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::MultiVectorOperations, and AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >.

◆ localWrmsNorm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localWrmsNorm	(	const VectorData &	x,
		const VectorData &	y
	)		const

pure virtual

Return a weighted norm of a vector.

Parameters

[in]	x	a vector
[in]	y	a vector

Returns: \[\sqrt{\frac{\displaystyle \sum_i x^2_i y^2_i}{n}}\]

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::VectorOperationsDevice< TYPE >.

◆ localWrmsNormMask()

virtual Scalar AMP::LinearAlgebra::VectorOperations::localWrmsNormMask	(	const VectorData &	x,
		const VectorData &	mask,
		const VectorData &	y
	)		const

pure virtual

Return a weighted norm of a subset of a vector.

Parameters

[in]	x	a vector
[in]	y	a vector
[in]	mask	a vector

Returns: \[\sqrt{\frac{\displaystyle \sum_{i,\mathit{mask}_i>0} y^2_iy^2_i}{n}}\]

Implemented in AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::VectorOperationsDevice< TYPE >.

◆ max()

virtual Scalar AMP::LinearAlgebra::VectorOperations::max ( const VectorData & x ) const

virtual

Return the maximum value of the vector. \(\max_i x_i\).

Parameters

[in] x a vector

◆ maxNorm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::maxNorm ( const VectorData & x ) const

virtual

Return the \( L_\infty \) -norm of this vector.

Returns

\[\max_i |x_i|\]

Parameters

[in] x a vector

◆ mean()

Scalar AMP::LinearAlgebra::VectorOperations::mean ( const VectorData & x ) const

Return the mean of the values of the vector.

Parameters

[in] x a vector

◆ min()

virtual Scalar AMP::LinearAlgebra::VectorOperations::min ( const VectorData & x ) const

virtual

Return the minimum value of the vector. \(\min_i x_i\).

Parameters

[in] x a vector

◆ minQuotient()

virtual Scalar AMP::LinearAlgebra::VectorOperations::minQuotient	(	const VectorData &	x,
		const VectorData &	y
	)		const

virtual

Returns the minimum of the quotient of two vectors:

\[\min_{i,y_i\neq0} x_i/x_i\]

Parameters

[in]	x	a vector
[in]	y	a vector

Returns: \[\min_{i,y_i\neq0} x_i/y_i\]

◆ multiply()

virtual void AMP::LinearAlgebra::VectorOperations::multiply	(	const VectorData &	x,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Component-wise multiply one vector with another. For Vectors, \(z_i = x_i y_i\).

Parameters

[in]	x	Input vector x
[in]	y	Input vector y
[out]	z	Output vector z

◆ reciprocal()

virtual void AMP::LinearAlgebra::VectorOperations::reciprocal	(	const VectorData &	x,
		VectorData &	y
	)

pure virtual

Set this to the component-wise reciprocal of a vector. \(y_i = 1/x_i\).

Parameters

x	a vector
y	a vector

◆ registerChildObjects()

virtual void AMP::LinearAlgebra::VectorOperations::registerChildObjects ( AMP::IO::RestartManager * manager ) const

virtual

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented in AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::MultiVectorOperations.

◆ scale() [1/2]

virtual void AMP::LinearAlgebra::VectorOperations::scale	(	const Scalar &	alpha,
		const VectorData &	x,
		VectorData &	y
	)

pure virtual

Set vector equal to scaled input. For Vectors, \(y_i = \alpha x_i\).

Parameters

[in]	alpha	a scalar
[in]	x	a vector
[out]	y	a vector

◆ scale() [2/2]

virtual void AMP::LinearAlgebra::VectorOperations::scale	(	const Scalar &	alpha,
		VectorData &	x
	)

pure virtual

Scale a vector. For Vectors, \(x_i = \alpha x_i\).

Parameters

[in]	alpha	a scalar
[in,out]	x	a vector

◆ setMax()

virtual void AMP::LinearAlgebra::VectorOperations::setMax	(	const Scalar &	val,
		VectorData &	x
	)

pure virtual

modify vector to set \(x_i = max(x_i, val)\).

Parameters

[in]	x	a vector
[in]	val	a scalar

◆ setMin()

virtual void AMP::LinearAlgebra::VectorOperations::setMin	(	const Scalar &	val,
		VectorData &	x
	)

pure virtual

modify vector to set \(x_i = min(x_i, val)\).

Parameters

[in]	x	a vector
[in]	val	a scalar

◆ setRandomValues()

virtual void AMP::LinearAlgebra::VectorOperations::setRandomValues ( VectorData & x )

pure virtual

Set data in this vector to random values.

Parameters

[out] x a vector

◆ setToScalar()

virtual void AMP::LinearAlgebra::VectorOperations::setToScalar	(	const Scalar &	alpha,
		VectorData &	z
	)

pure virtual

Set all compenents of a vector to a scalar. For Vectors, the components of z are set to \(\alpha\).

Parameters

[in]	alpha	scalar value
[out]	z	a vector

◆ subtract()

virtual void AMP::LinearAlgebra::VectorOperations::subtract	(	const VectorData &	x,
		const VectorData &	y,
		VectorData &	z
	)

pure virtual

Subtracts one vector from another. For Vectors, \(z_i = x_i - y_i\).

Parameters

[in]	x	Input vector x
[in]	y	Input vector y
[out]	z	Output vector z

◆ sum()

virtual Scalar AMP::LinearAlgebra::VectorOperations::sum ( const VectorData & x ) const

virtual

Return the sum of the values of the vector.

Parameters

[in] x a vector

◆ VectorOpName()

virtual std::string AMP::LinearAlgebra::VectorOperations::VectorOpName ( ) const

pure virtual

Get the type name.

Implemented in AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, AMP::LinearAlgebra::ManagedVectorOperations, AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, and AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >.

◆ writeRestart()

virtual void AMP::LinearAlgebra::VectorOperations::writeRestart ( int64_t fid ) const

virtual

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented in AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, and AMP::LinearAlgebra::MultiVectorOperations.

◆ wrmsNorm()

virtual Scalar AMP::LinearAlgebra::VectorOperations::wrmsNorm	(	const VectorData &	x,
		const VectorData &	y
	)		const

virtual

Return a weighted norm of a vector.

Parameters

[in]	x	a vector
[in]	y	a vector

Returns: \[\sqrt{\frac{\displaystyle \sum_i x^2_iy^2_i}{n}}\]

◆ wrmsNormMask()

virtual Scalar AMP::LinearAlgebra::VectorOperations::wrmsNormMask	(	const VectorData &	x,
		const VectorData &	mask,
		const VectorData &	y
	)		const

virtual

Return a weighted norm of a subset of a vector.

Parameters

[in]	x	a vector
[in]	y	a vector
[in]	mask	a vector

Returns: \[\sqrt{\frac{\displaystyle \sum_{i,\mathit{mask}_i>0} x^2_iy^2_i}{n}}\]

◆ zero()

virtual void AMP::LinearAlgebra::VectorOperations::zero ( VectorData & x )

pure virtual

Set vector entries (including ghosts) to zero.

This is equivalent (but more efficient) to calling setToScalar ( 0.0 ) followed by a makeConsistent(SET)

Implemented in AMP::LinearAlgebra::MultiVectorOperations, AMP::LinearAlgebra::VectorOperationsOpenMP< TYPE >, AMP::LinearAlgebra::NativePetscVectorOperations, AMP::LinearAlgebra::TpetraVectorOperations< ST, LO, GO, NT >, AMP::LinearAlgebra::VectorOperationsDefault< TYPE >, AMP::LinearAlgebra::VectorOperationsDefault< double >, AMP::LinearAlgebra::VectorOperationsDefault< PetscScalar >, AMP::LinearAlgebra::VectorOperationsDevice< TYPE >, and AMP::LinearAlgebra::ManagedVectorOperations.

Member Data Documentation

◆ d_hash

uint64_t AMP::LinearAlgebra::VectorOperations::d_hash = 0

protected

Definition at line 399 of file VectorOperations.h.

The documentation for this class was generated from the following file:

src/vectors/operations/VectorOperations.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~VectorOperations()

◆ VectorOperations()

Member Function Documentation

◆ abs()

◆ add()

◆ addScalar()

◆ axpby()

◆ axpy()

◆ cloneOperations()

◆ copy()

◆ copyCast()

◆ divide()

◆ dot()

◆ equals()

◆ getID()

◆ L1Norm()

◆ L2Norm()

◆ linearSum()

◆ localDot()

◆ localEquals()

◆ localL1Norm()

◆ localL2Norm()

◆ localMax()

◆ localMaxNorm()

◆ localMin()

◆ localMinQuotient()

◆ localSum()

◆ localWrmsNorm()

◆ localWrmsNormMask()

◆ max()

◆ maxNorm()

◆ mean()

◆ min()

◆ minQuotient()

◆ multiply()

◆ reciprocal()

◆ registerChildObjects()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setMax()

◆ setMin()

◆ setRandomValues()

◆ setToScalar()

◆ subtract()

◆ sum()

◆ VectorOpName()

◆ writeRestart()

◆ wrmsNorm()

◆ wrmsNormMask()

◆ zero()

Member Data Documentation

◆ d_hash