MFEM  v3.4
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]

Public Member Functions

 Vector ()
 Default constructor for Vector. Sets size = 0 and data = NULL. More...
 
 Vector (const Vector &)
 Copy constructor. Allocates a new data array and copies the data. 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...
 
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 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 MakeDataOwner ()
 
void Destroy ()
 Destroy a vector. 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...
 
bool OwnsData () const
 
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)
 Redefine '=' for vector = vector. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator/= (double c)
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (const Vector &v)
 
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 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
 
void GetSubVector (const Array< int > &dofs, double *elem_data) const
 
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)
 
void SetSubVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const Vector &elemvect)
 Add (element) subvector to the vector. More...
 
void AddElementVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const double a, const Vector &elemvect)
 
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_HYPRE (std::ostream &out) const
 Prints vector to stream out in HYPRE_Vector format. More...
 
void Randomize (int seed=0)
 Set random values in the vector. 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
 
virtual ~Vector ()
 Destroys vector. More...
 
 Vector (N_Vector nv)
 Construct a wrapper Vector from SUNDIALS N_Vector. More...
 
virtual N_Vector ToNVector ()
 Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...
 
virtual void ToNVector (N_Vector &nv)
 Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More...
 

Protected Attributes

int size
 
int allocsize
 
double * data
 

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

Constructor & Destructor Documentation

◆ Vector() [1/5]

mfem::Vector::Vector ( )
inline

Default constructor for Vector. Sets size = 0 and data = NULL.

Definition at line 58 of file vector.hpp.

◆ Vector() [2/5]

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/5]

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

Creates vector of size s.

Warning
Entries are not initialized to zero!

Definition at line 314 of file vector.hpp.

◆ Vector() [4/5]

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

◆ ~Vector()

mfem::Vector::~Vector ( )
inlinevirtual

Destroys vector.

Definition at line 386 of file vector.hpp.

◆ Vector() [5/5]

mfem::Vector::Vector ( N_Vector  nv)
explicit

Construct a wrapper Vector from SUNDIALS N_Vector.

Definition at line 819 of file vector.cpp.

Member Function Documentation

◆ Add()

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

(*this) += a * Va

Definition at line 201 of file vector.cpp.

◆ AddElementVector() [1/3]

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

Add (element) subvector to the vector.

Definition at line 546 of file vector.cpp.

◆ AddElementVector() [2/3]

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

Definition at line 564 of file vector.cpp.

◆ AddElementVector() [3/3]

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

Definition at line 581 of file vector.cpp.

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

◆ Destroy()

void mfem::Vector::Destroy ( )
inline

Destroy a vector.

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

◆ DistanceTo()

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

Compute the Euclidean distance to another vector.

Definition at line 416 of file vector.hpp.

◆ Elem() [1/2]

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

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

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

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

◆ GetSubVector() [1/2]

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

Definition at line 458 of file vector.cpp.

◆ GetSubVector() [2/2]

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

Definition at line 477 of file vector.cpp.

◆ Load() [1/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.

◆ Load() [2/3]

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

Load a vector from an input stream.

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

◆ MakeDataOwner()

void mfem::Vector::MakeDataOwner ( )
inline

Definition at line 114 of file vector.hpp.

◆ Max()

double mfem::Vector::Max ( ) const

Returns the maximal element of the vector.

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

◆ Min()

double mfem::Vector::Min ( ) const

Returns the minimal element of the vector.

Definition at line 785 of file vector.cpp.

◆ Neg()

void mfem::Vector::Neg ( )

(*this) = -(*this)

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

◆ Norml1()

double mfem::Vector::Norml1 ( ) const

Returns the l_1 norm of the vector.

Definition at line 713 of file vector.cpp.

◆ Norml2()

double mfem::Vector::Norml2 ( ) const

Returns the l2 norm of the vector.

Definition at line 666 of file vector.cpp.

◆ Normlinf()

double mfem::Vector::Normlinf ( ) const

Returns the l_infinity norm of the vector.

Definition at line 703 of file vector.cpp.

◆ Normlp()

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

Returns the l_p norm of the vector.

Definition at line 723 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 139 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 134 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 357 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 365 of file vector.hpp.

◆ operator*() [1/2]

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

Dot product with a double * array.

Definition at line 89 of file vector.cpp.

◆ operator*() [2/2]

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

Return the inner-product.

Definition at line 104 of file vector.cpp.

◆ operator*=()

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

Definition at line 143 of file vector.cpp.

◆ operator+=()

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

Definition at line 186 of file vector.cpp.

◆ operator-=() [1/2]

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

Definition at line 162 of file vector.cpp.

◆ operator-=() [2/2]

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

Definition at line 171 of file vector.cpp.

◆ operator/=()

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

Definition at line 152 of file vector.cpp.

◆ operator=() [1/3]

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

Copy Size() entries from v.

Definition at line 116 of file vector.cpp.

◆ operator=() [2/3]

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

Redefine '=' for vector = vector.

Definition at line 126 of file vector.cpp.

◆ operator=() [3/3]

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

Redefine '=' for vector = constant.

Definition at line 132 of file vector.cpp.

◆ OwnsData()

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

Definition at line 141 of file vector.hpp.

◆ Print()

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

Prints vector to stream out.

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

◆ Randomize()

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

Set random values in the vector.

Definition at line 647 of file vector.cpp.

◆ Set()

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

(*this) = a * x

Definition at line 219 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 94 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 101 of file vector.hpp.

◆ SetSize()

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 328 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.

Definition at line 494 of file vector.cpp.

◆ SetSubVector() [2/3]

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

Definition at line 512 of file vector.cpp.

◆ SetSubVector() [3/3]

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

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

◆ SetVector()

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

Definition at line 234 of file vector.cpp.

◆ Size()

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

Returns the size of the vector.

Definition at line 120 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 144 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 148 of file vector.hpp.

◆ Sum()

double mfem::Vector::Sum ( ) const

Return the sum of the vector entries.

Definition at line 798 of file vector.cpp.

◆ Swap()

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

Swap the contents of two Vectors.

Definition at line 373 of file vector.hpp.

◆ ToNVector() [1/2]

virtual N_Vector mfem::Vector::ToNVector ( )
inlinevirtual

Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL.

The returned N_Vector must be destroyed by the caller.

Reimplemented in mfem::HypreParVector.

Definition at line 283 of file vector.hpp.

◆ ToNVector() [2/2]

void mfem::Vector::ToNVector ( N_Vector &  nv)
virtual

Update an existing wrapper SUNDIALS N_Vector to point to this Vector.

Reimplemented in mfem::HypreParVector.

Definition at line 843 of file vector.cpp.

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 260 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 278 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 309 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 341 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 386 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 408 of file vector.cpp.

Member Data Documentation

◆ allocsize

int mfem::Vector::allocsize
protected

Definition at line 52 of file vector.hpp.

◆ data

double* mfem::Vector::data
protected

Definition at line 53 of file vector.hpp.

◆ size

int mfem::Vector::size
protected

Definition at line 52 of file vector.hpp.


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