MFEM  v4.5.0
Finite element discretization library
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. More...
 
 Vector (Vector &&v)
 Move constructor. "Steals" data from its argument. More...
 
 Vector (int s)
 Creates vector of size s. More...
 
 Vector (double *data_, int size_)
 Creates a vector referencing an array of doubles, owned by someone else. More...
 
 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_. More...
 
 Vector (int size_, MemoryType mt)
 Create a Vector of size size_ using MemoryType mt. More...
 
 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. More...
 
template<int N>
 Vector (const double(&values)[N])
 Create a vector using a braced initializer list. More...
 
virtual void UseDevice (bool use_dev) const
 Enable execution of Vector operations using the mfem::Device. More...
 
virtual bool UseDevice () const
 Return the device flag of the Memory object used by the Vector. More...
 
void Load (std::istream **in, int np, int *dim)
 Reads a vector from multiple files. More...
 
void Load (std::istream &in, int Size)
 Load a vector from an input stream. More...
 
void Load (std::istream &in)
 Load a vector from an input stream, reading the size from the stream. More...
 
void SetSize (int s)
 Resize the vector to size s. More...
 
void SetSize (int s, MemoryType mt)
 Resize the vector to size s using MemoryType mt. More...
 
void SetSize (int s, Vector &v)
 Resize the vector to size s using the MemoryType of v. More...
 
void SetData (double *d)
 
void SetDataAndSize (double *d, int s)
 Set the Vector data and size. More...
 
void NewDataAndSize (double *d, int s)
 Set the Vector data and size, deleting the old data, if owned. More...
 
void NewMemoryAndSize (const Memory< double > &mem, int s, bool own_mem)
 Reset the Vector to use the given external Memory mem and size s. More...
 
void MakeRef (Vector &base, int offset, int size)
 Reset the Vector to be a reference to a sub-vector of base. More...
 
void MakeRef (Vector &base, int offset)
 Reset the Vector to be a reference to a sub-vector of base without changing its current size. More...
 
void MakeDataOwner () const
 Set the Vector data (host pointer) ownership flag. More...
 
void Destroy ()
 Destroy a vector. More...
 
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. More...
 
int Size () const
 Returns the size of the vector. More...
 
int Capacity () const
 Return the size of the currently allocated data array. More...
 
double * GetData () const
 Return a pointer to the beginning of the Vector data. More...
 
 operator double * ()
 Conversion to double *. More...
 
 operator const double * () const
 Conversion to const double *. More...
 
double * begin ()
 STL-like begin. More...
 
double * end ()
 STL-like end. More...
 
const double * begin () const
 STL-like begin (const version). More...
 
const double * end () const
 STL-like end (const version). More...
 
Memory< double > & GetMemory ()
 Return a reference to the Memory object used by the Vector. More...
 
const Memory< double > & GetMemory () const
 Return a reference to the Memory object used by the Vector, const version. More...
 
void SyncMemory (const Vector &v) const
 Update the memory location of the vector to match v. More...
 
void SyncAliasMemory (const Vector &v) const
 Update the alias memory location of the vector to match v. More...
 
bool OwnsData () const
 Read the Vector data (host pointer) ownership flag. More...
 
void StealData (double **p)
 Changes the ownership of the data; after the call the Vector is empty. More...
 
double * StealData ()
 Changes the ownership of the data; after the call the Vector is empty. More...
 
double & Elem (int i)
 Access Vector entries. Index i = 0 .. size-1. More...
 
const double & Elem (int i) const
 Read only access to Vector entries. Index i = 0 .. size-1. More...
 
double & operator() (int i)
 Access Vector entries using () for 0-based indexing. More...
 
const double & operator() (int i) const
 Read only access to Vector entries using () for 0-based indexing. More...
 
double operator* (const double *) const
 Dot product with a double * array. More...
 
double operator* (const Vector &v) const
 Return the inner-product. More...
 
Vectoroperator= (const double *v)
 Copy Size() entries from v. More...
 
Vectoroperator= (const Vector &v)
 Copy assignment. More...
 
Vectoroperator= (Vector &&v)
 Move assignment. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator*= (const Vector &v)
 Component-wise scaling: (*this)(i) *= v(i) More...
 
Vectoroperator/= (double c)
 
Vectoroperator/= (const Vector &v)
 Component-wise division: (*this)(i) /= v(i) More...
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (double c)
 
Vectoroperator+= (const Vector &v)
 
Vectoroperator- (const Vector &v)=delete
 operator- is not supported. Use subtract or Add. More...
 
Vectoroperator+ (const Vector &v)=delete
 operator+ is not supported. Use Add. More...
 
VectorAdd (const double a, const Vector &Va)
 (*this) += a * Va More...
 
VectorSet (const double a, const Vector &x)
 (*this) = a * x More...
 
void SetVector (const Vector &v, int offset)
 
void AddSubVector (const Vector &v, int offset)
 
void Neg ()
 (*this) = -(*this) More...
 
void Swap (Vector &other)
 Swap the contents of two Vectors. More...
 
void median (const Vector &lo, const Vector &hi)
 v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi. More...
 
void GetSubVector (const Array< int > &dofs, Vector &elemvect) const
 Extract entries listed in dofs to the output Vector elemvect. More...
 
void GetSubVector (const Array< int > &dofs, double *elem_data) const
 Extract entries listed in dofs to the output array elem_data. More...
 
void SetSubVector (const Array< int > &dofs, const double value)
 Set the entries listed in dofs to the given value. More...
 
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. More...
 
void SetSubVector (const Array< int > &dofs, double *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. More...
 
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. More...
 
void AddElementVector (const Array< int > &dofs, double *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. More...
 
void AddElementVector (const Array< int > &dofs, const double 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. More...
 
void SetSubVectorComplement (const Array< int > &dofs, const double val)
 Set all vector entries NOT in the dofs Array to the given val. More...
 
void Print (std::ostream &out=mfem::out, int width=8) const
 Prints vector to stream out. More...
 
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. More...
 
void PrintHash (std::ostream &out) const
 Print the Vector size and hash of its data. More...
 
void Randomize (int seed=0)
 Set random values in the vector. More...
 
void SetGlobalSeed (int gseed)
 Set global seed for random values in sequential calls to Randomize(). More...
 
double Norml2 () const
 Returns the l2 norm of the vector. More...
 
double Normlinf () const
 Returns the l_infinity norm of the vector. More...
 
double Norml1 () const
 Returns the l_1 norm of the vector. More...
 
double Normlp (double p) const
 Returns the l_p norm of the vector. More...
 
double Max () const
 Returns the maximal element of the vector. More...
 
double Min () const
 Returns the minimal element of the vector. More...
 
double Sum () const
 Return the sum of the vector entries. More...
 
double DistanceSquaredTo (const double *p) const
 Compute the square of the Euclidean distance to another vector. More...
 
double DistanceTo (const double *p) const
 Compute the Euclidean distance to another vector. More...
 
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. More...
 
virtual ~Vector ()
 Destroys vector. More...
 
virtual const double * Read (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev). More...
 
virtual const double * HostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false). More...
 
virtual double * Write (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev). More...
 
virtual double * HostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false). More...
 
virtual double * ReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev). More...
 
virtual double * HostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false). More...
 

Protected Attributes

Memory< double > data
 
int size
 
bool global_seed_set = false
 

Friends

void add (const Vector &v1, const Vector &v2, Vector &v)
 Set v = v1 + v2. More...
 
void add (const Vector &v1, double alpha, const Vector &v2, Vector &v)
 Set v = v1 + alpha * v2. More...
 
void add (const double a, const Vector &x, const Vector &y, Vector &z)
 z = a * (x + y) More...
 
void add (const double a, const Vector &x, const double b, const Vector &y, Vector &z)
 z = a * x + b * y More...
 
void subtract (const Vector &v1, const Vector &v2, Vector &v)
 Set v = v1 - v2. More...
 
void subtract (const double a, const Vector &x, const Vector &y, Vector &z)
 z = a * (x - y) More...
 

Detailed Description

Vector data type.

Definition at line 60 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 72 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 39 of file vector.cpp.

◆ Vector() [3/9]

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

Move constructor. "Steals" data from its argument.

Definition at line 52 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 503 of file vector.hpp.

◆ Vector() [5/9]

mfem::Vector::Vector ( double *  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 87 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 92 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 96 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 101 of file vector.hpp.

◆ Vector() [9/9]

template<int N>
mfem::Vector::Vector ( const double(&)  values[N])
inlineexplicit

Create a vector using a braced initializer list.

Definition at line 106 of file vector.hpp.

◆ ~Vector()

mfem::Vector::~Vector ( )
inlinevirtual

Destroys vector.

Definition at line 627 of file vector.hpp.

Member Function Documentation

◆ Add()

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

(*this) += a * Va

Definition at line 252 of file vector.cpp.

◆ AddElementVector() [1/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 639 of file vector.cpp.

◆ AddElementVector() [2/3]

void mfem::Vector::AddElementVector ( const Array< int > &  dofs,
double *  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 664 of file vector.cpp.

◆ AddElementVector() [3/3]

void mfem::Vector::AddElementVector ( const Array< int > &  dofs,
const double  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 682 of file vector.cpp.

◆ AddSubVector()

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

Definition at line 292 of file vector.cpp.

◆ begin() [1/2]

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

STL-like begin.

Definition at line 223 of file vector.hpp.

◆ begin() [2/2]

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

STL-like begin (const version).

Definition at line 229 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 204 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 443 of file vector.hpp.

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

◆ Destroy()

void mfem::Vector::Destroy ( )
inline

Destroy a vector.

Definition at line 590 of file vector.hpp.

◆ DistanceSquaredTo()

double mfem::Vector::DistanceSquaredTo ( const double *  p) const
inline

Compute the square of the Euclidean distance to another vector.

Definition at line 649 of file vector.hpp.

◆ DistanceTo()

double mfem::Vector::DistanceTo ( const double *  p) const
inline

Compute the Euclidean distance to another vector.

Definition at line 654 of file vector.hpp.

◆ Elem() [1/2]

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

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

Definition at line 101 of file vector.cpp.

◆ Elem() [2/2]

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

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

Definition at line 106 of file vector.cpp.

◆ end() [1/2]

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

STL-like end.

Definition at line 226 of file vector.hpp.

◆ end() [2/2]

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

STL-like end (const version).

Definition at line 232 of file vector.hpp.

◆ GetData()

double* 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 209 of file vector.hpp.

◆ GetMemory() [1/2]

Memory<double>& mfem::Vector::GetMemory ( )
inline

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

Definition at line 235 of file vector.hpp.

◆ GetMemory() [2/2]

const Memory<double>& mfem::Vector::GetMemory ( ) const
inline

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

Definition at line 239 of file vector.hpp.

◆ GetSubVector() [1/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 547 of file vector.cpp.

◆ GetSubVector() [2/2]

void mfem::Vector::GetSubVector ( const Array< int > &  dofs,
double *  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 562 of file vector.cpp.

◆ HostRead()

virtual const double* mfem::Vector::HostRead ( ) const
inlinevirtual

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

Reimplemented in mfem::PetscParVector.

Definition at line 453 of file vector.hpp.

◆ HostReadWrite()

virtual double* mfem::Vector::HostReadWrite ( )
inlinevirtual

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

Reimplemented in mfem::PetscParVector.

Definition at line 469 of file vector.hpp.

◆ HostWrite()

virtual double* mfem::Vector::HostWrite ( )
inlinevirtual

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

Reimplemented in mfem::PetscParVector.

Definition at line 461 of file vector.hpp.

◆ Load() [1/3]

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

Reads a vector from multiple files.

Definition at line 57 of file vector.cpp.

◆ Load() [2/3]

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

Load a vector from an input stream.

Definition at line 85 of file vector.cpp.

◆ Load() [3/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 130 of file vector.hpp.

◆ MakeDataOwner()

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

Set the Vector data (host pointer) ownership flag.

Definition at line 188 of file vector.hpp.

◆ MakeRef() [1/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 577 of file vector.hpp.

◆ MakeRef() [2/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 584 of file vector.hpp.

◆ Max()

double mfem::Vector::Max ( ) const

Returns the maximal element of the vector.

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

◆ Min()

double mfem::Vector::Min ( ) const

Returns the minimal element of the vector.

Definition at line 1202 of file vector.cpp.

◆ Neg()

void mfem::Vector::Neg ( )

(*this) = -(*this)

Definition at line 305 of file vector.cpp.

◆ NewDataAndSize()

void mfem::Vector::NewDataAndSize ( double *  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 163 of file vector.hpp.

◆ NewMemoryAndSize()

void mfem::Vector::NewMemoryAndSize ( const Memory< double > &  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 562 of file vector.hpp.

◆ Norml1()

double mfem::Vector::Norml1 ( ) const

Returns the l_1 norm of the vector.

Definition at line 841 of file vector.cpp.

◆ Norml2()

double mfem::Vector::Norml2 ( ) const

Returns the l2 norm of the vector.

Definition at line 812 of file vector.cpp.

◆ Normlinf()

double mfem::Vector::Normlinf ( ) const

Returns the l_infinity norm of the vector.

Definition at line 830 of file vector.cpp.

◆ Normlp()

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

Returns the l_p norm of the vector.

Definition at line 852 of file vector.cpp.

◆ operator const double *()

mfem::Vector::operator const double * ( ) const
inline

Conversion to const double *.

Note
This conversion function makes it possible to use [] for indexing in addition to the overloaded operator()(int).

Definition at line 220 of file vector.hpp.

◆ operator double *()

mfem::Vector::operator double * ( )
inline

Conversion to double *.

Note
This conversion function makes it possible to use [] for indexing in addition to the overloaded operator()(int).

Definition at line 215 of file vector.hpp.

◆ operator()() [1/2]

double & 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 599 of file vector.hpp.

◆ operator()() [2/2]

const double & 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 607 of file vector.hpp.

◆ operator*() [1/2]

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

Dot product with a double * array.

Definition at line 111 of file vector.cpp.

◆ operator*() [2/2]

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

Return the inner-product.

Definition at line 1111 of file vector.cpp.

◆ operator*=() [1/2]

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

Definition at line 167 of file vector.cpp.

◆ operator*=() [2/2]

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

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

Definition at line 176 of file vector.cpp.

◆ operator+()

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

operator+ is not supported. Use Add.

◆ operator+=() [1/2]

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

Definition at line 231 of file vector.cpp.

◆ operator+=() [2/2]

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

Definition at line 240 of file vector.cpp.

◆ operator-()

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

operator- is not supported. Use subtract or Add.

◆ operator-=() [1/2]

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

Definition at line 210 of file vector.cpp.

◆ operator-=() [2/2]

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

Definition at line 219 of file vector.cpp.

◆ operator/=() [1/2]

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

Definition at line 188 of file vector.cpp.

◆ operator/=() [2/2]

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

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

Definition at line 198 of file vector.cpp.

◆ operator=() [1/4]

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

Copy Size() entries from v.

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

◆ operator=() [3/4]

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

Move assignment.

Definition at line 149 of file vector.cpp.

◆ operator=() [4/4]

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

Redefine '=' for vector = constant.

Definition at line 158 of file vector.cpp.

◆ OwnsData()

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

Read the Vector data (host pointer) ownership flag.

Definition at line 249 of file vector.hpp.

◆ Print() [1/2]

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

Prints vector to stream out.

Definition at line 724 of file vector.cpp.

◆ Print() [2/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 749 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 758 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 777 of file vector.cpp.

◆ Randomize()

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

Set random values in the vector.

Definition at line 785 of file vector.cpp.

◆ Read()

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

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

Reimplemented in mfem::PetscParVector.

Definition at line 449 of file vector.hpp.

◆ ReadWrite()

virtual double* 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 465 of file vector.hpp.

◆ Set()

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

(*this) = a * x

Definition at line 267 of file vector.cpp.

◆ SetData()

void mfem::Vector::SetData ( double *  d)
inline

Set the Vector data.

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

Definition at line 150 of file vector.hpp.

◆ SetDataAndSize()

void mfem::Vector::SetDataAndSize ( double *  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 157 of file vector.hpp.

◆ SetGlobalSeed()

void mfem::Vector::SetGlobalSeed ( int  gseed)

Set global seed for random values in sequential calls to Randomize().

Definition at line 806 of file vector.cpp.

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

◆ SetSize() [2/3]

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

Resize the vector to size s using MemoryType mt.

Definition at line 533 of file vector.hpp.

◆ SetSize() [3/3]

void mfem::Vector::SetSize ( int  s,
Vector v 
)
inline

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

Definition at line 146 of file vector.hpp.

◆ SetSubVector() [1/3]

void mfem::Vector::SetSubVector ( const Array< int > &  dofs,
const double  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 573 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 594 of file vector.cpp.

◆ SetSubVector() [3/3]

void mfem::Vector::SetSubVector ( const Array< int > &  dofs,
double *  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 620 of file vector.cpp.

◆ SetSubVectorComplement()

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

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

Definition at line 708 of file vector.cpp.

◆ SetVector()

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

Definition at line 279 of file vector.cpp.

◆ Size()

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

Returns the size of the vector.

Definition at line 200 of file vector.hpp.

◆ StealData() [1/2]

void mfem::Vector::StealData ( double **  p)
inline

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

Definition at line 252 of file vector.hpp.

◆ StealData() [2/2]

double* mfem::Vector::StealData ( )
inline

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

Definition at line 256 of file vector.hpp.

◆ Sum()

double mfem::Vector::Sum ( ) const

Return the sum of the vector entries.

Definition at line 920 of file vector.cpp.

◆ Swap()

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

Swap the contents of two Vectors.

Definition at line 615 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 245 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 242 of file vector.hpp.

◆ UseDevice() [1/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 118 of file vector.hpp.

◆ UseDevice() [2/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 121 of file vector.hpp.

◆ Write()

virtual double* 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 457 of file vector.hpp.

Friends And Related Function Documentation

◆ add [1/4]

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

Set v = v1 + v2.

Definition at line 313 of file vector.cpp.

◆ add [2/4]

void add ( const Vector v1,
double  alpha,
const Vector v2,
Vector v 
)
friend

Set v = v1 + alpha * v2.

Definition at line 335 of file vector.cpp.

◆ add [3/4]

void add ( const double  a,
const Vector x,
const Vector y,
Vector z 
)
friend

z = a * (x + y)

Definition at line 371 of file vector.cpp.

◆ add [4/4]

void add ( const double  a,
const Vector x,
const double  b,
const Vector y,
Vector z 
)
friend

z = a * x + b * y

Definition at line 408 of file vector.cpp.

◆ subtract [1/2]

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

Set v = v1 - v2.

Definition at line 460 of file vector.cpp.

◆ subtract [2/2]

void subtract ( const double  a,
const Vector x,
const Vector y,
Vector z 
)
friend

z = a * (x - y)

Definition at line 486 of file vector.cpp.

Member Data Documentation

◆ data

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

Definition at line 64 of file vector.hpp.

◆ global_seed_set

bool mfem::Vector::global_seed_set = false
protected

Definition at line 66 of file vector.hpp.

◆ size

int mfem::Vector::size
protected

Definition at line 65 of file vector.hpp.


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