#include <vector.hpp>

Inheritance diagram for mfem::Vector:

Collaboration diagram for mfem::Vector:

Public Member Functions
	Vector ()

	Vector (const Vector &)
	Copy constructor. Allocates a new data array and copies the data.

	Vector (Vector &&v)
	Move constructor. "Steals" data from its argument.

	Vector (int s)
	Creates vector of size s.

	Vector (real_t *data_, int size_)
	Creates a vector referencing an array of doubles, owned by someone else.

	Vector (Vector &base, int base_offset, int size_)
	Create a Vector referencing a sub-vector of the Vector base starting at the given offset, base_offset, and size size_.

	Vector (int size_, MemoryType mt)
	Create a Vector of size size_ using MemoryType mt.

	Vector (int size_, MemoryType h_mt, MemoryType d_mt)
	Create a Vector of size size_ using host MemoryType h_mt and device MemoryType d_mt.

template<typename CT , int N>
	Vector (const CT(&values)[N])
	Create a vector from a statically sized C-style array of convertible type.

template<typename CT , typename std::enable_if< std::is_convertible< CT, real_t >::value, bool >::type = true>
	Vector (std::initializer_list< CT > values)
	Create a vector using a braced initializer list.

virtual void	UseDevice (bool use_dev) const
	Enable execution of Vector operations using the mfem::Device.

virtual bool	UseDevice () const
	Return the device flag of the Memory object used by the Vector.

void	Load (std::istream *in, int np, int dim)
	Reads a vector from multiple files.

void	Load (std::istream &in, int Size)
	Load a vector from an input stream.

void	Load (std::istream &in)
	Load a vector from an input stream, reading the size from the stream.

void	SetSize (int s)
	Resize the vector to size s.

void	SetSize (int s, MemoryType mt)
	Resize the vector to size s using MemoryType mt.

void	SetSize (int s, const Vector &v)
	Resize the vector to size s using the MemoryType of v.

void	Reserve (int res)
	Update Capacity() to res (if less than current), keeping existing entries.

void	DeleteAt (const Array< int > &indices)

void	SetData (real_t *d)

void	SetDataAndSize (real_t *d, int s)
	Set the Vector data and size.

void	NewDataAndSize (real_t *d, int s)
	Set the Vector data and size, deleting the old data, if owned.

void	NewMemoryAndSize (const Memory< real_t > &mem, int s, bool own_mem)
	Reset the Vector to use the given external Memory mem and size s.

void	MakeRef (Vector &base, int offset, int size)
	Reset the Vector to be a reference to a sub-vector of base.

void	MakeRef (Vector &base, int offset)
	Reset the Vector to be a reference to a sub-vector of base without changing its current size.

void	MakeDataOwner () const
	Set the Vector data (host pointer) ownership flag.

void	Destroy ()
	Destroy a vector.

void	DeleteDevice (bool copy_to_host=true)
	Delete the device pointer, if owned. If copy_to_host is true and the data is valid only on device, move it to host before deleting. Invalidates the device memory.

int	Size () const
	Returns the size of the vector.

int	Capacity () const
	Return the size of the currently allocated data array.

real_t *	GetData () const
	Return a pointer to the beginning of the Vector data.

MFEM_DEPRECATED	operator real_t * ()
	Conversion to `double *`. Deprecated.

MFEM_DEPRECATED	operator const real_t * () const
	Conversion to `const double *`. Deprecated.

real_t *	begin ()
	STL-like begin.

real_t *	end ()
	STL-like end.

const real_t *	begin () const
	STL-like begin (const version).

const real_t *	end () const
	STL-like end (const version).

Memory< real_t > &	GetMemory ()
	Return a reference to the Memory object used by the Vector.

const Memory< real_t > &	GetMemory () const
	Return a reference to the Memory object used by the Vector, const version.

void	SyncMemory (const Vector &v) const
	Update the memory location of the vector to match v.

void	SyncAliasMemory (const Vector &v) const
	Update the alias memory location of the vector to match v.

bool	OwnsData () const
	Read the Vector data (host pointer) ownership flag.

void	StealData (real_t **p)
	Changes the ownership of the data; after the call the Vector is empty.

real_t *	StealData ()
	Changes the ownership of the data; after the call the Vector is empty.

real_t &	Elem (int i)
	Access Vector entries. Index i = 0 .. size-1.

const real_t &	Elem (int i) const
	Read only access to Vector entries. Index i = 0 .. size-1.

real_t &	operator() (int i)
	Access Vector entries using () for 0-based indexing.

const real_t &	operator() (int i) const
	Read only access to Vector entries using () for 0-based indexing.

real_t &	operator[] (int i)
	Access Vector entries using [] for 0-based indexing.

const real_t &	operator[] (int i) const
	Read only access to Vector entries using [] for 0-based indexing.

real_t	operator* (const real_t *v) const

real_t	operator* (const Vector &v) const
	Return the inner-product.

Vector &	operator= (const real_t *v)
	Copy Size() entries from v.

Vector &	operator= (const Vector &v)
	Copy assignment.

Vector &	operator= (Vector &&v)
	Move assignment.

Vector &	operator= (real_t value)
	Redefine '=' for vector = constant.

Vector &	operator*= (real_t c)

Vector &	operator*= (const Vector &v)
	Component-wise scaling: (this)(i) = v(i)

Vector &	operator/= (real_t c)

Vector &	operator/= (const Vector &v)
	Component-wise division: (*this)(i) /= v(i)

Vector &	operator-= (real_t c)

Vector &	operator-= (const Vector &v)

Vector &	operator+= (real_t c)

Vector &	operator+= (const Vector &v)

Vector &	Add (const real_t a, const Vector &Va)
	(this) += a Va

Vector &	Set (const real_t a, const Vector &x)
	(this) = a x

void	SetVector (const Vector &v, int offset)
	(*this)[i + offset] = v[i]

void	AddSubVector (const Vector &v, int offset)
	(*this)[i + offset] += v[i]

void	Neg ()
	(this) = -(this)

void	Reciprocal ()
	(this)(i) = 1.0 / (this)(i)

void	Abs ()
	(this)(i) = abs((this)(i))

void	Pow (const real_t p)
	(this)(i) = pow((this)(i), p)

void	Swap (Vector &other)
	Swap the contents of two Vectors.

void	cross3D (const Vector &vin, Vector &vout) const

void	median (const Vector &lo, const Vector &hi)
	v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi.

void	GetSubVector (const Array< int > &dofs, Vector &elemvect) const
	Extract entries listed in dofs to the output Vector elemvect.

void	GetSubVector (const Array< int > &dofs, real_t *elem_data) const
	Extract entries listed in dofs to the output array elem_data.

void	SetSubVector (const Array< int > &dofs, const real_t value)
	Set the entries listed in dofs to the given value.

void	SetSubVectorHost (const Array< int > &dofs, const real_t value)
	Set the entries listed in dofs to the given value (always on host).

void	SetSubVector (const Array< int > &dofs, const Vector &elemvect)
	Set the entries listed in dofs to the values given in the elemvect Vector. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elemvect.

void	SetSubVector (const Array< int > &dofs, real_t *elem_data)
	Set the entries listed in dofs to the values given the , elem_data array. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elem_data.

void	AddElementVector (const Array< int > &dofs, const Vector &elemvect)
	Add elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elemvect.

void	AddElementVector (const Array< int > &dofs, real_t *elem_data)
	Add elements of the elem_data array to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elem_data.

void	AddElementVector (const Array< int > &dofs, const real_t a, const Vector &elemvect)
	Add times the elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -aval from elemvect*.

void	SetSubVectorComplement (const Array< int > &dofs, const real_t val)
	Set all vector entries NOT in the dofs Array to the given val.

void	Print (std::ostream &out=mfem::out, int width=8) const
	Prints vector to stream out.

void	Print (adios2stream &out, const std::string &variable_name) const

void	Print_HYPRE (std::ostream &out) const
	Prints vector to stream out in HYPRE_Vector format.

void	PrintMathematica (std::ostream &out=mfem::out) const
	Prints vector as a List for importing into Mathematica.

void	PrintHash (std::ostream &out) const
	Print the Vector size and hash of its data.

void	Randomize (int seed=0)
	Set random values in the vector.

real_t	Norml2 () const
	Returns the l2 norm of the vector.

real_t	Normlinf () const
	Returns the l_infinity norm of the vector.

real_t	Norml1 () const
	Returns the l_1 norm of the vector.

real_t	Normlp (real_t p) const
	Returns the l_p norm of the vector.

real_t	Max () const
	Returns the maximal element of the vector.

real_t	Min () const
	Returns the minimal element of the vector.

real_t	Sum () const
	Return the sum of the vector entries.

real_t	DistanceSquaredTo (const real_t *p) const
	Compute the square of the Euclidean distance to another vector.

real_t	DistanceSquaredTo (const Vector &p) const
	Compute the square of the Euclidean distance to another vector.

real_t	DistanceTo (const real_t *p) const
	Compute the Euclidean distance to another vector.

real_t	DistanceTo (const Vector &p) const
	Compute the Euclidean distance to another vector.

int	CheckFinite () const
	Count the number of entries in the Vector for which isfinite is false, i.e. the entry is a NaN or +/-Inf.

virtual	~Vector ()
	Destroys vector.

virtual const real_t *	Read (bool on_dev=true) const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).

virtual const real_t *	HostRead () const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).

virtual real_t *	Write (bool on_dev=true)
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).

virtual real_t *	HostWrite ()
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).

virtual real_t *	ReadWrite (bool on_dev=true)
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).

virtual real_t *	HostReadWrite ()
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).

Protected Attributes
Memory< real_t >	data

int	size

Friends
void	add (const Vector &v1, const Vector &v2, Vector &v)
	Set v = v1 + v2.

void	add (const Vector &v1, real_t alpha, const Vector &v2, Vector &v)
	Set v = v1 + alpha * v2.

void	add (const real_t a, const Vector &x, const Vector &y, Vector &z)
	z = a * (x + y)

void	add (const real_t a, const Vector &x, const real_t b, const Vector &y, Vector &z)
	z = a * x + b * y

void	subtract (const Vector &v1, const Vector &v2, Vector &v)
	Set v = v1 - v2.

void	subtract (const real_t a, const Vector &x, const Vector &y, Vector &z)
	z = a * (x - y)

Detailed Description

Vector data type.

Definition at line 81 of file vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/10]

mfem::Vector::Vector ( )

inline

Default constructor for Vector. Sets size = 0, and calls Memory::Reset on data through Memory<double>'s default constructor.

Definition at line 92 of file vector.hpp.

◆ Vector() [2/10]

mfem::Vector::Vector ( const Vector & v )

Copy constructor. Allocates a new data array and copies the data.

Definition at line 108 of file vector.cpp.

◆ Vector() [3/10]

mfem::Vector::Vector ( Vector && v )

Move constructor. "Steals" data from its argument.

Definition at line 121 of file vector.cpp.

◆ Vector() [4/10]

mfem::Vector::Vector ( int s )

inlineexplicit

Creates vector of size s.

Warning: Entries are not initialized to zero!

Definition at line 574 of file vector.hpp.

◆ Vector() [5/10]

mfem::Vector::Vector	(	real_t *	data_,
		int	size_ )

inline

Creates a vector referencing an array of doubles, owned by someone else.

The pointer data_ can be NULL. The data array can be replaced later with SetData().

Definition at line 107 of file vector.hpp.

◆ Vector() [6/10]

mfem::Vector::Vector	(	Vector &	base,
		int	base_offset,
		int	size_ )

inline

Create a Vector referencing a sub-vector of the Vector base starting at the given offset, base_offset, and size size_.

Definition at line 112 of file vector.hpp.

◆ Vector() [7/10]

mfem::Vector::Vector	(	int	size_,
		MemoryType	mt )

inline

Create a Vector of size size_ using MemoryType mt.

Definition at line 116 of file vector.hpp.

◆ Vector() [8/10]

mfem::Vector::Vector	(	int	size_,
		MemoryType	h_mt,
		MemoryType	d_mt )

inline

Create a Vector of size size_ using host MemoryType h_mt and device MemoryType d_mt.

Definition at line 121 of file vector.hpp.

◆ Vector() [9/10]

template<typename CT , int N>

mfem::Vector::Vector ( const CT(&) values[N] )

inlineexplicit

Create a vector from a statically sized C-style array of convertible type.

Definition at line 126 of file vector.hpp.

◆ Vector() [10/10]

template<typename CT , typename std::enable_if< std::is_convertible< CT, real_t >::value, bool >::type = true>

mfem::Vector::Vector ( std::initializer_list< CT > values )

inlineexplicit

Create a vector using a braced initializer list.

Definition at line 132 of file vector.hpp.

◆ ~Vector()

mfem::Vector::~Vector ( )

inlinevirtual

Destroys vector.

Definition at line 710 of file vector.hpp.

Member Function Documentation

◆ Abs()

void mfem::Vector::Abs ( )

(*this)(i) = abs((*this)(i))

Definition at line 392 of file vector.cpp.

◆ Add()

Vector & mfem::Vector::Add	(	const real_t	a,
		const Vector &	Va )

(*this) += a * Va

Definition at line 326 of file vector.cpp.

◆ AddElementVector() [1/3]

void mfem::Vector::AddElementVector	(	const Array< int > &	dofs,
		const real_t	a,
		const Vector &	elemvect )

Add times the elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -a*val from elemvect.

Definition at line 828 of file vector.cpp.

◆ AddElementVector() [2/3]

void mfem::Vector::AddElementVector	(	const Array< int > &	dofs,
		const Vector &	elemvect )

Add elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elemvect.

Definition at line 785 of file vector.cpp.

◆ AddElementVector() [3/3]

void mfem::Vector::AddElementVector	(	const Array< int > &	dofs,
		real_t *	elem_data )

Add elements of the elem_data array to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elem_data.

Definition at line 810 of file vector.cpp.

◆ AddSubVector()

void mfem::Vector::AddSubVector	(	const Vector &	v,
		int	offset )

(*this)[i + offset] += v[i]

Definition at line 365 of file vector.cpp.

◆ begin() [1/2]

real_t * mfem::Vector::begin ( )

inline

STL-like begin.

Definition at line 253 of file vector.hpp.

◆ begin() [2/2]

const real_t * mfem::Vector::begin ( ) const

inline

STL-like begin (const version).

Definition at line 259 of file vector.hpp.

◆ Capacity()

int mfem::Vector::Capacity ( ) const

inline

Return the size of the currently allocated data array.

It is always true that Capacity() >= Size().

Definition at line 238 of file vector.hpp.

◆ CheckFinite()

int mfem::Vector::CheckFinite ( ) const

inline

Count the number of entries in the Vector for which isfinite is false, i.e. the entry is a NaN or +/-Inf.

Definition at line 514 of file vector.hpp.

◆ cross3D()

void mfem::Vector::cross3D	(	const Vector &	vin,
		Vector &	vout ) const

Computes cross product of this vector with another 3D vector. vout = this x vin.

Definition at line 639 of file vector.cpp.

◆ DeleteAt()

void mfem::Vector::DeleteAt ( const Array< int > & indices )

Delete entries at indices and resize vector accordingly.

Warning: Indices must be unique!

Definition at line 1260 of file vector.cpp.

◆ DeleteDevice()

void mfem::Vector::DeleteDevice ( bool copy_to_host = true )

inline

Delete the device pointer, if owned. If copy_to_host is true and the data is valid only on device, move it to host before deleting. Invalidates the device memory.

Definition at line 230 of file vector.hpp.

◆ Destroy()

void mfem::Vector::Destroy ( )

inline

Destroy a vector.

Definition at line 673 of file vector.hpp.

◆ DistanceSquaredTo() [1/2]

real_t mfem::Vector::DistanceSquaredTo ( const real_t * p ) const

inline

Compute the square of the Euclidean distance to another vector.

Definition at line 737 of file vector.hpp.

◆ DistanceSquaredTo() [2/2]

real_t mfem::Vector::DistanceSquaredTo ( const Vector & p ) const

inline

Compute the square of the Euclidean distance to another vector.

Definition at line 742 of file vector.hpp.

◆ DistanceTo() [1/2]

real_t mfem::Vector::DistanceTo ( const real_t * p ) const

inline

Compute the Euclidean distance to another vector.

Definition at line 748 of file vector.hpp.

◆ DistanceTo() [2/2]

real_t mfem::Vector::DistanceTo ( const Vector & p ) const

inline

Compute the Euclidean distance to another vector.

Definition at line 753 of file vector.hpp.

◆ Elem() [1/2]

real_t & mfem::Vector::Elem ( int i )

Access Vector entries. Index i = 0 .. size-1.

Definition at line 173 of file vector.cpp.

◆ Elem() [2/2]

const real_t & mfem::Vector::Elem ( int i ) const

Read only access to Vector entries. Index i = 0 .. size-1.

Definition at line 178 of file vector.cpp.

◆ end() [1/2]

real_t * mfem::Vector::end ( )

inline

STL-like end.

Definition at line 256 of file vector.hpp.

◆ end() [2/2]

const real_t * mfem::Vector::end ( ) const

inline

STL-like end (const version).

Definition at line 262 of file vector.hpp.

◆ GetData()

real_t * mfem::Vector::GetData ( ) const

inline

Return a pointer to the beginning of the Vector data.

Warning: This method should be used with caution as it gives write access to the data of const-qualified Vectors.

Definition at line 243 of file vector.hpp.

◆ GetMemory() [1/2]

Memory< real_t > & mfem::Vector::GetMemory ( )

inline

Return a reference to the Memory object used by the Vector.

Definition at line 265 of file vector.hpp.

◆ GetMemory() [2/2]

const Memory< real_t > & mfem::Vector::GetMemory ( ) const

inline

Return a reference to the Memory object used by the Vector, const version.

Definition at line 269 of file vector.hpp.

◆ GetSubVector() [1/2]

void mfem::Vector::GetSubVector	(	const Array< int > &	dofs,
		real_t *	elem_data ) const

Extract entries listed in dofs to the output array elem_data.

Negative dof values cause the -dof-1 position in elem_data to receive the -val in from this Vector.

Definition at line 691 of file vector.cpp.

◆ GetSubVector() [2/2]

void mfem::Vector::GetSubVector	(	const Array< int > &	dofs,
		Vector &	elemvect ) const

Extract entries listed in dofs to the output Vector elemvect.

Negative dof values cause the -dof-1 position in elemvect to receive the -val in from this Vector.

Definition at line 676 of file vector.cpp.

◆ HostRead()

virtual const real_t * mfem::Vector::HostRead ( ) const

inlinevirtual

Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).

Reimplemented in mfem::PetscParVector.

Definition at line 524 of file vector.hpp.

◆ HostReadWrite()

virtual real_t * mfem::Vector::HostReadWrite ( )

inlinevirtual

Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).

Reimplemented in mfem::PetscParVector.

Definition at line 540 of file vector.hpp.

◆ HostWrite()

virtual real_t * mfem::Vector::HostWrite ( )

inlinevirtual

Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).

Reimplemented in mfem::PetscParVector.

Definition at line 532 of file vector.hpp.

◆ Load() [1/3]

void mfem::Vector::Load ( std::istream & in )

inline

Load a vector from an input stream, reading the size from the stream.

Definition at line 157 of file vector.hpp.

◆ Load() [2/3]

void mfem::Vector::Load	(	std::istream &	in,
		int	Size )

Load a vector from an input stream.

Definition at line 156 of file vector.cpp.

◆ Load() [3/3]

void mfem::Vector::Load	(	std::istream **	in,
		int	np,
		int *	dim )

Reads a vector from multiple files.

Definition at line 127 of file vector.cpp.

◆ MakeDataOwner()

void mfem::Vector::MakeDataOwner ( ) const

inline

Set the Vector data (host pointer) ownership flag.

Definition at line 222 of file vector.hpp.

◆ MakeRef() [1/2]

void mfem::Vector::MakeRef	(	Vector &	base,
		int	offset )

inline

Reset the Vector to be a reference to a sub-vector of base without changing its current size.

Definition at line 667 of file vector.hpp.

◆ MakeRef() [2/2]

void mfem::Vector::MakeRef	(	Vector &	base,
		int	offset,
		int	size )

inline

Reset the Vector to be a reference to a sub-vector of base.

Definition at line 660 of file vector.hpp.

◆ Max()

real_t mfem::Vector::Max ( ) const

Returns the maximal element of the vector.

Definition at line 1200 of file vector.cpp.

◆ median()

void mfem::Vector::median	(	const Vector &	lo,
		const Vector &	hi )

v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi.

Definition at line 652 of file vector.cpp.

◆ Min()

real_t mfem::Vector::Min ( ) const

Returns the minimal element of the vector.

Definition at line 1154 of file vector.cpp.

◆ Neg()

void mfem::Vector::Neg ( )

(*this) = -(*this)

Definition at line 376 of file vector.cpp.

◆ NewDataAndSize()

void mfem::Vector::NewDataAndSize	(	real_t *	d,
		int	s )

inline

Set the Vector data and size, deleting the old data, if owned.

The Vector does not assume ownership of the new data. The new size is also used as the new Capacity().

See also: SetDataAndSize().

Definition at line 197 of file vector.hpp.

◆ NewMemoryAndSize()

void mfem::Vector::NewMemoryAndSize	(	const Memory< real_t > &	mem,
		int	s,
		bool	own_mem )

inline

Reset the Vector to use the given external Memory mem and size s.

If own_mem is false, the Vector will not own any of the pointers of mem.

Note that when own_mem is true, the mem object can be destroyed immediately by the caller but mem.Delete() should NOT be called since the Vector object takes ownership of all pointers owned by mem.

See also: NewDataAndSize().

Definition at line 645 of file vector.hpp.

◆ Norml1()

real_t mfem::Vector::Norml1 ( ) const

Returns the l_1 norm of the vector.

Definition at line 1018 of file vector.cpp.

◆ Norml2()

real_t mfem::Vector::Norml2 ( ) const

Returns the l2 norm of the vector.

Definition at line 968 of file vector.cpp.

◆ Normlinf()

real_t mfem::Vector::Normlinf ( ) const

Returns the l_infinity norm of the vector.

Definition at line 1004 of file vector.cpp.

◆ Normlp()

real_t mfem::Vector::Normlp ( real_t p ) const

Returns the l_p norm of the vector.

Definition at line 1032 of file vector.cpp.

◆ operator const real_t *()

MFEM_DEPRECATED mfem::Vector::operator const real_t * ( ) const

inline

Conversion to const double *. Deprecated.

Definition at line 250 of file vector.hpp.

◆ operator real_t *()

MFEM_DEPRECATED mfem::Vector::operator real_t * ( )

inline

Conversion to double *. Deprecated.

Definition at line 247 of file vector.hpp.

◆ operator()() [1/2]

real_t & mfem::Vector::operator() ( int i )

inline

Access Vector entries using () for 0-based indexing.

Note: If MFEM_DEBUG is enabled, bounds checking is performed.

Definition at line 681 of file vector.hpp.

◆ operator()() [2/2]

const real_t & mfem::Vector::operator() ( int i ) const

inline

Read only access to Vector entries using () for 0-based indexing.

Note: If MFEM_DEBUG is enabled, bounds checking is performed.

Definition at line 689 of file vector.hpp.

◆ operator*() [1/2]

real_t mfem::Vector::operator* ( const real_t * v ) const

Dot product with a double * array. This function always executes on the CPU. A HostRead() will be called if required. To optionally execute on the device: Vector tmp(v, Size()); res = (*this) * tmp;

Definition at line 183 of file vector.cpp.

◆ operator*() [2/2]

real_t mfem::Vector::operator* ( const Vector & v ) const

Return the inner-product.

Definition at line 1079 of file vector.cpp.

◆ operator*=() [1/2]

Vector & mfem::Vector::operator*= ( const Vector & v )

Component-wise scaling: (*this)(i) *= v(i)

Definition at line 250 of file vector.cpp.

◆ operator*=() [2/2]

Vector & mfem::Vector::operator*= ( real_t c )

Definition at line 241 of file vector.cpp.

◆ operator+=() [1/2]

Vector & mfem::Vector::operator+= ( const Vector & v )

Definition at line 314 of file vector.cpp.

◆ operator+=() [2/2]

Vector & mfem::Vector::operator+= ( real_t c )

Definition at line 305 of file vector.cpp.

◆ operator-=() [1/2]

Vector & mfem::Vector::operator-= ( const Vector & v )

Definition at line 293 of file vector.cpp.

◆ operator-=() [2/2]

Vector & mfem::Vector::operator-= ( real_t c )

Definition at line 284 of file vector.cpp.

◆ operator/=() [1/2]

Vector & mfem::Vector::operator/= ( const Vector & v )

Component-wise division: (*this)(i) /= v(i)

Definition at line 272 of file vector.cpp.

◆ operator/=() [2/2]

Vector & mfem::Vector::operator/= ( real_t c )

Definition at line 262 of file vector.cpp.

◆ operator=() [1/4]

Vector & mfem::Vector::operator= ( const real_t * v )

Copy Size() entries from v.

Definition at line 197 of file vector.cpp.

◆ operator=() [2/4]

Vector & mfem::Vector::operator= ( const Vector & v )

Copy assignment.

Note: Defining this method overwrites the implicitly defined copy assignment operator.

Definition at line 203 of file vector.cpp.

◆ operator=() [3/4]

Vector & mfem::Vector::operator= ( real_t value )

Redefine '=' for vector = constant.

Definition at line 232 of file vector.cpp.

◆ operator=() [4/4]

Vector & mfem::Vector::operator= ( Vector && v )

Move assignment.

Definition at line 222 of file vector.cpp.

◆ operator[]() [1/2]

real_t & mfem::Vector::operator[] ( int i )

inline

Access Vector entries using [] for 0-based indexing.

Note: If MFEM_DEBUG is enabled, bounds checking is performed.

Definition at line 304 of file vector.hpp.

◆ operator[]() [2/2]

const real_t & mfem::Vector::operator[] ( int i ) const

inline

Read only access to Vector entries using [] for 0-based indexing.

Note: If MFEM_DEBUG is enabled, bounds checking is performed.

Definition at line 308 of file vector.hpp.

◆ OwnsData()

bool mfem::Vector::OwnsData ( ) const

inline

Read the Vector data (host pointer) ownership flag.

Definition at line 279 of file vector.hpp.

◆ Pow()

void mfem::Vector::Pow ( const real_t p )

(*this)(i) = pow((*this)(i), p)

Definition at line 403 of file vector.cpp.

◆ Print() [1/2]

void mfem::Vector::Print	(	adios2stream &	out,
		const std::string &	variable_name ) const

Prints vector to stream out.

Parameters

out	adios2stream output
variable_name	variable name associated with current Vector

Definition at line 895 of file vector.cpp.

◆ Print() [2/2]

void mfem::Vector::Print	(	std::ostream &	out = mfem::out,
		int	width = 8 ) const

Prints vector to stream out.

Definition at line 870 of file vector.cpp.

◆ Print_HYPRE()

void mfem::Vector::Print_HYPRE ( std::ostream & out ) const

Prints vector to stream out in HYPRE_Vector format.

Definition at line 904 of file vector.cpp.

◆ PrintHash()

void mfem::Vector::PrintHash ( std::ostream & out ) const

Print the Vector size and hash of its data.

This is a compact text representation of the Vector contents that can be used to compare vectors from different runs without the need to save the whole vector.

Definition at line 947 of file vector.cpp.

◆ PrintMathematica()

void mfem::Vector::PrintMathematica ( std::ostream & out = mfem::out ) const

Prints vector as a List for importing into Mathematica.

The resulting file can be read into Mathematica using an expression such as: myVec = Get["output_file_name"] The Mathematica variable "myVec" will then be assigned to a new List object containing the data from this MFEM Vector.

Definition at line 923 of file vector.cpp.

◆ Randomize()

void mfem::Vector::Randomize ( int seed = 0 )

Set random values in the vector.

Definition at line 955 of file vector.cpp.

◆ Read()

virtual const real_t * mfem::Vector::Read ( bool on_dev = true ) const

inlinevirtual

Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented in mfem::HypreParVector, and mfem::PetscParVector.

Definition at line 520 of file vector.hpp.

◆ ReadWrite()

virtual real_t * mfem::Vector::ReadWrite ( bool on_dev = true )

inlinevirtual

Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented in mfem::PetscParVector.

Definition at line 536 of file vector.hpp.

◆ Reciprocal()

void mfem::Vector::Reciprocal ( )

(*this)(i) = 1.0 / (*this)(i)

Definition at line 384 of file vector.cpp.

◆ Reserve()

void mfem::Vector::Reserve ( int res )

inline

Update Capacity() to res (if less than current), keeping existing entries.

Definition at line 633 of file vector.hpp.

◆ Set()

Vector & mfem::Vector::Set	(	const real_t	a,
		const Vector &	x )

(*this) = a * x

Definition at line 341 of file vector.cpp.

◆ SetData()

void mfem::Vector::SetData ( real_t * d )

inline

Set the Vector data.

Warning: This method should be called only when OwnsData() is false.

Definition at line 184 of file vector.hpp.

◆ SetDataAndSize()

void mfem::Vector::SetDataAndSize	(	real_t *	d,
		int	s )

inline

Set the Vector data and size.

The Vector does not assume ownership of the new data. The new size is also used as the new Capacity().

Warning: This method should be called only when OwnsData() is false.

See also: NewDataAndSize().

Definition at line 191 of file vector.hpp.

◆ SetSize() [1/3]

void mfem::Vector::SetSize ( int s )

inline

Resize the vector to size s.

If the new size is less than or equal to Capacity() then the internal data array remains the same. Otherwise, the old array is deleted, if owned, and a new array of size s is allocated without copying the previous content of the Vector.

Warning: In the second case above (new size greater than current one), the vector will allocate new data array, even if it did not own the original data! Also, new entries are not initialized!

Definition at line 584 of file vector.hpp.

◆ SetSize() [2/3]

void mfem::Vector::SetSize	(	int	s,
		const Vector &	v )

inline

Resize the vector to size s using the MemoryType of v.

Definition at line 173 of file vector.hpp.

◆ SetSize() [3/3]

void mfem::Vector::SetSize	(	int	s,
		MemoryType	mt )

inline

Resize the vector to size s using MemoryType mt.

Definition at line 604 of file vector.hpp.

◆ SetSubVector() [1/3]

void mfem::Vector::SetSubVector	(	const Array< int > &	dofs,
		const real_t	value )

Set the entries listed in dofs to the given value.

Negative dof values cause the -dof-1 position in this Vector to receive the -value.

Definition at line 702 of file vector.cpp.

◆ SetSubVector() [2/3]

void mfem::Vector::SetSubVector	(	const Array< int > &	dofs,
		const Vector &	elemvect )

Set the entries listed in dofs to the values given in the elemvect Vector. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elemvect.

Definition at line 740 of file vector.cpp.

◆ SetSubVector() [3/3]

void mfem::Vector::SetSubVector	(	const Array< int > &	dofs,
		real_t *	elem_data )

Set the entries listed in dofs to the values given the , elem_data array. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elem_data.

Definition at line 766 of file vector.cpp.

◆ SetSubVectorComplement()

void mfem::Vector::SetSubVectorComplement	(	const Array< int > &	dofs,
		const real_t	val )

Set all vector entries NOT in the dofs Array to the given val.

Definition at line 854 of file vector.cpp.

◆ SetSubVectorHost()

void mfem::Vector::SetSubVectorHost	(	const Array< int > &	dofs,
		const real_t	value )

Set the entries listed in dofs to the given value (always on host).

Negative dof values cause the -dof-1 position in this Vector to receive the -value.

As opposed to SetSubVector(const Array<int>&, const real_t), this function will execute only on host, even if the vector or the dofs array have the device flag set.

Definition at line 723 of file vector.cpp.

◆ SetVector()

void mfem::Vector::SetVector	(	const Vector &	v,
		int	offset )

(*this)[i + offset] = v[i]

Definition at line 353 of file vector.cpp.

◆ Size()

int mfem::Vector::Size ( ) const

inline

Returns the size of the vector.

Definition at line 234 of file vector.hpp.

◆ StealData() [1/2]

real_t * mfem::Vector::StealData ( )

inline

Changes the ownership of the data; after the call the Vector is empty.

Definition at line 286 of file vector.hpp.

◆ StealData() [2/2]

void mfem::Vector::StealData ( real_t ** p )

inline

Changes the ownership of the data; after the call the Vector is empty.

Definition at line 282 of file vector.hpp.

◆ Sum()

real_t mfem::Vector::Sum ( ) const

Return the sum of the vector entries.

Definition at line 1246 of file vector.cpp.

◆ Swap()

void mfem::Vector::Swap ( Vector & other )

inline

Swap the contents of two Vectors.

Implemented without using move assignment, avoiding Destroy() calls.

Definition at line 697 of file vector.hpp.

◆ SyncAliasMemory()

void mfem::Vector::SyncAliasMemory ( const Vector & v ) const

inline

Update the alias memory location of the vector to match v.

Definition at line 275 of file vector.hpp.

◆ SyncMemory()

void mfem::Vector::SyncMemory ( const Vector & v ) const

inline

Update the memory location of the vector to match v.

Definition at line 272 of file vector.hpp.

◆ UseDevice() [1/2]

virtual bool mfem::Vector::UseDevice ( ) const

inlinevirtual

Return the device flag of the Memory object used by the Vector.

Reimplemented in mfem::PetscParVector.

Definition at line 148 of file vector.hpp.

◆ UseDevice() [2/2]

virtual void mfem::Vector::UseDevice ( bool use_dev ) const

inlinevirtual

Enable execution of Vector operations using the mfem::Device.

The default is to use Backend::CPU (serial execution on each MPI rank), regardless of the mfem::Device configuration.

When appropriate, MFEM functions and class methods will enable the use of the mfem::Device for their Vector parameters.

Some derived classes, e.g. GridFunction, enable the use of the mfem::Device by default.

Reimplemented in mfem::PetscParVector.

Definition at line 145 of file vector.hpp.

◆ Write()

virtual real_t * mfem::Vector::Write ( bool on_dev = true )

inlinevirtual

Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented in mfem::PetscParVector.

Definition at line 528 of file vector.hpp.

Friends And Related Symbol Documentation

◆ add [1/4]

void add	(	const real_t	a,
		const Vector &	x,
		const real_t	b,
		const Vector &	y,
		Vector &	z )

friend

z = a * x + b * y

Definition at line 515 of file vector.cpp.

◆ add [2/4]

void add	(	const real_t	a,
		const Vector &	x,
		const Vector &	y,
		Vector &	z )

friend

z = a * (x + y)

Definition at line 475 of file vector.cpp.

◆ add [3/4]

void add	(	const Vector &	v1,
		const Vector &	v2,
		Vector &	v )

friend

Set v = v1 + v2.

Definition at line 414 of file vector.cpp.

◆ add [4/4]

void add	(	const Vector &	v1,
		real_t	alpha,
		const Vector &	v2,
		Vector &	v )

friend

Set v = v1 + alpha * v2.

Definition at line 436 of file vector.cpp.

◆ subtract [1/2]

void subtract	(	const real_t	a,
		const Vector &	x,
		const Vector &	y,
		Vector &	z )

friend

z = a * (x - y)

Definition at line 599 of file vector.cpp.

◆ subtract [2/2]

void subtract	(	const Vector &	v1,
		const Vector &	v2,
		Vector &	v )

friend

Set v = v1 - v2.

Definition at line 570 of file vector.cpp.

Member Data Documentation

◆ data

Memory<real_t> mfem::Vector::data

protected

Definition at line 85 of file vector.hpp.

◆ size

int mfem::Vector::size

protected

Definition at line 86 of file vector.hpp.

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

linalg/vector.hpp
linalg/vector.cpp

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector() [1/10]

◆ Vector() [2/10]

◆ Vector() [3/10]

◆ Vector() [4/10]

◆ Vector() [5/10]

◆ Vector() [6/10]

◆ Vector() [7/10]

◆ Vector() [8/10]

◆ Vector() [9/10]

◆ Vector() [10/10]

◆ ~Vector()

Member Function Documentation

◆ Abs()

◆ Add()

◆ AddElementVector() [1/3]

◆ AddElementVector() [2/3]

◆ AddElementVector() [3/3]

◆ AddSubVector()

◆ begin() [1/2]

◆ begin() [2/2]

◆ Capacity()

◆ CheckFinite()

◆ cross3D()

◆ DeleteAt()

◆ DeleteDevice()

◆ Destroy()

◆ DistanceSquaredTo() [1/2]

◆ DistanceSquaredTo() [2/2]

◆ DistanceTo() [1/2]

◆ DistanceTo() [2/2]

◆ Elem() [1/2]

◆ Elem() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ GetData()

◆ GetMemory() [1/2]

◆ GetMemory() [2/2]

◆ GetSubVector() [1/2]

◆ GetSubVector() [2/2]

◆ HostRead()

◆ HostReadWrite()

◆ HostWrite()

◆ Load() [1/3]

◆ Load() [2/3]

◆ Load() [3/3]

◆ MakeDataOwner()

◆ MakeRef() [1/2]

◆ MakeRef() [2/2]

◆ Max()

◆ median()

◆ Min()

◆ Neg()

◆ NewDataAndSize()

◆ NewMemoryAndSize()

◆ Norml1()

◆ Norml2()

◆ Normlinf()

◆ Normlp()

◆ operator const real_t *()

◆ operator real_t *()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]