MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Friends | List of all members
mfem::Vector Class Reference

Vector data type. More...

#include <vector.hpp>

Inheritance diagram for mfem::Vector:
[legend]
Collaboration diagram for mfem::Vector:
[legend]

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<int N, typename T = real_t>
 Vector (const T(&values)[N])
 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 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_tGetData () 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_tbegin ()
 STL-like begin.
 
real_tend ()
 STL-like end.
 
const real_tbegin () const
 STL-like begin (const version).
 
const real_tend () 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_tStealData ()
 Changes the ownership of the data; after the call the Vector is empty.
 
real_tElem (int i)
 Access Vector entries. Index i = 0 .. size-1.
 
const real_tElem (int i) const
 Read only access to Vector entries. Index i = 0 .. size-1.
 
real_toperator() (int i)
 Access Vector entries using () for 0-based indexing.
 
const real_toperator() (int i) const
 Read only access to Vector entries using () for 0-based indexing.
 
real_toperator[] (int i)
 Access Vector entries using [] for 0-based indexing.
 
const real_toperator[] (int i) const
 Read only access to Vector entries using [] for 0-based indexing.
 
real_t operator* (const real_t *) const
 Dot product with a double * array.
 
real_t operator* (const Vector &v) const
 Return the inner-product.
 
Vectoroperator= (const real_t *v)
 Copy Size() entries from v.
 
Vectoroperator= (const Vector &v)
 Copy assignment.
 
Vectoroperator= (Vector &&v)
 Move assignment.
 
Vectoroperator= (real_t value)
 Redefine '=' for vector = constant.
 
Vectoroperator*= (real_t c)
 
Vectoroperator*= (const Vector &v)
 Component-wise scaling: (*this)(i) *= v(i)
 
Vectoroperator/= (real_t c)
 
Vectoroperator/= (const Vector &v)
 Component-wise division: (*this)(i) /= v(i)
 
Vectoroperator-= (real_t c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (real_t c)
 
Vectoroperator+= (const Vector &v)
 
VectorAdd (const real_t a, const Vector &Va)
 (*this) += a * Va
 
VectorSet (const real_t a, const Vector &x)
 (*this) = a * x
 
void SetVector (const Vector &v, int offset)
 
void AddSubVector (const Vector &v, int offset)
 
void Neg ()
 (*this) = -(*this)
 
void Reciprocal ()
 (*this)(i) = 1.0 / (*this)(i)
 
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 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 -a*val 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 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_tRead (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
 
virtual const real_tHostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
 
virtual real_tWrite (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
 
virtual real_tReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).
 

Protected Attributes

Memory< real_tdata
 
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 79 of file vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/9]

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 90 of file vector.hpp.

◆ Vector() [2/9]

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

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

Definition at line 31 of file vector.cpp.

◆ Vector() [3/9]

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

Move constructor. "Steals" data from its argument.

Definition at line 44 of file vector.cpp.

◆ Vector() [4/9]

mfem::Vector::Vector ( int  s)
inlineexplicit

Creates vector of size s.

Warning
Entries are not initialized to zero!

Definition at line 528 of file vector.hpp.

◆ Vector() [5/9]

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 105 of file vector.hpp.

◆ Vector() [6/9]

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 110 of file vector.hpp.

◆ Vector() [7/9]

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

Create a Vector of size size_ using MemoryType mt.

Definition at line 114 of file vector.hpp.

◆ Vector() [8/9]

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 119 of file vector.hpp.

◆ Vector() [9/9]

template<int N, typename T = real_t>
mfem::Vector::Vector ( const T(&)  values[N])
inlineexplicit

Create a vector using a braced initializer list.

Definition at line 124 of file vector.hpp.

◆ ~Vector()

mfem::Vector::~Vector ( )
inlinevirtual

Destroys vector.

Definition at line 652 of file vector.hpp.

Member Function Documentation

◆ Add()

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

(*this) += a * Va

Definition at line 247 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 713 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 670 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 695 of file vector.cpp.

◆ AddSubVector()

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

Definition at line 287 of file vector.cpp.

◆ begin() [1/2]

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

STL-like begin.

Definition at line 237 of file vector.hpp.

◆ begin() [2/2]

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

STL-like begin (const version).

Definition at line 243 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 222 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 468 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 541 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 214 of file vector.hpp.

◆ Destroy()

void mfem::Vector::Destroy ( )
inline

Destroy a vector.

Definition at line 615 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 679 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 684 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 690 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 695 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 95 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 100 of file vector.cpp.

◆ end() [1/2]

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

STL-like end.

Definition at line 240 of file vector.hpp.

◆ end() [2/2]

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

STL-like end (const version).

Definition at line 246 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 227 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 249 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 253 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 593 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 578 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 478 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 494 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 486 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 148 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 78 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 49 of file vector.cpp.

◆ MakeDataOwner()

void mfem::Vector::MakeDataOwner ( ) const
inline

Set the Vector data (host pointer) ownership flag.

Definition at line 206 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 609 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 602 of file vector.hpp.

◆ Max()

real_t mfem::Vector::Max ( ) const

Returns the maximal element of the vector.

Definition at line 922 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 554 of file vector.cpp.

◆ Min()

real_t mfem::Vector::Min ( ) const

Returns the minimal element of the vector.

Definition at line 1212 of file vector.cpp.

◆ Neg()

void mfem::Vector::Neg ( )

(*this) = -(*this)

Definition at line 300 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 181 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 587 of file vector.hpp.

◆ Norml1()

real_t mfem::Vector::Norml1 ( ) const

Returns the l_1 norm of the vector.

Definition at line 861 of file vector.cpp.

◆ Norml2()

real_t mfem::Vector::Norml2 ( ) const

Returns the l2 norm of the vector.

Definition at line 832 of file vector.cpp.

◆ Normlinf()

real_t mfem::Vector::Normlinf ( ) const

Returns the l_infinity norm of the vector.

Definition at line 850 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 872 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 234 of file vector.hpp.

◆ operator real_t *()

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

Conversion to double *. Deprecated.

Definition at line 231 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 624 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 632 of file vector.hpp.

◆ operator*() [1/2]

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

Dot product with a double * array.

Definition at line 105 of file vector.cpp.

◆ operator*() [2/2]

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

Return the inner-product.

Definition at line 1118 of file vector.cpp.

◆ operator*=() [1/2]

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

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

Definition at line 171 of file vector.cpp.

◆ operator*=() [2/2]

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

Definition at line 162 of file vector.cpp.

◆ operator+=() [1/2]

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

Definition at line 235 of file vector.cpp.

◆ operator+=() [2/2]

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

Definition at line 226 of file vector.cpp.

◆ operator-=() [1/2]

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

Definition at line 214 of file vector.cpp.

◆ operator-=() [2/2]

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

Definition at line 205 of file vector.cpp.

◆ operator/=() [1/2]

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

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

Definition at line 193 of file vector.cpp.

◆ operator/=() [2/2]

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

Definition at line 183 of file vector.cpp.

◆ operator=() [1/4]

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

Copy Size() entries from v.

Definition at line 118 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 124 of file vector.cpp.

◆ operator=() [3/4]

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

Redefine '=' for vector = constant.

Definition at line 153 of file vector.cpp.

◆ operator=() [4/4]

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

Move assignment.

Definition at line 143 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 288 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 292 of file vector.hpp.

◆ OwnsData()

bool mfem::Vector::OwnsData ( ) const
inline

Read the Vector data (host pointer) ownership flag.

Definition at line 263 of file vector.hpp.

◆ Print() [1/2]

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

Prints vector to stream out.

Parameters
outadios2stream output
variable_namevariable name associated with current Vector

Definition at line 780 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 755 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 789 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 808 of file vector.cpp.

◆ Randomize()

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

Set random values in the vector.

Definition at line 816 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 474 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 490 of file vector.hpp.

◆ Reciprocal()

void mfem::Vector::Reciprocal ( )

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

Definition at line 308 of file vector.cpp.

◆ Set()

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

(*this) = a * x

Definition at line 262 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 168 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 175 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 538 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 164 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 558 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 604 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 625 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 651 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 739 of file vector.cpp.

◆ SetVector()

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

Definition at line 274 of file vector.cpp.

◆ Size()

int mfem::Vector::Size ( ) const
inline

Returns the size of the vector.

Definition at line 218 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 270 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 266 of file vector.hpp.

◆ Sum()

real_t mfem::Vector::Sum ( ) const

Return the sum of the vector entries.

Definition at line 1283 of file vector.cpp.

◆ Swap()

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

Swap the contents of two Vectors.

Definition at line 640 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 259 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 256 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 139 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 136 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 482 of file vector.hpp.

Friends And Related Function 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 417 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 377 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 316 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 338 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 501 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 472 of file vector.cpp.

Member Data Documentation

◆ data

Memory<real_t> mfem::Vector::data
protected

Definition at line 83 of file vector.hpp.

◆ size

int mfem::Vector::size
protected

Definition at line 84 of file vector.hpp.


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