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

Wrapper for hypre's parallel vector class. More...

#include <hypre.hpp>

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

Public Member Functions

 HypreParVector ()
 Default constructor, no underlying hypre_ParVector is created.
 
 HypreParVector (MPI_Comm comm, HYPRE_BigInt glob_size, HYPRE_BigInt *col)
 Creates vector with given global size and parallel partitioning of the rows/columns given by col.
 
 HypreParVector (MPI_Comm comm, HYPRE_BigInt glob_size, real_t *data_, HYPRE_BigInt *col, bool is_device_ptr=false)
 Creates vector with given global size, partitioning of the columns, and data.
 
 HypreParVector (const HypreParVector &y)
 Creates a deep copy of y.
 
 HypreParVector (HypreParVector &&other)
 Move constructor for HypreParVector. "Steals" data from its argument.
 
 HypreParVector (const HypreParMatrix &A, int transpose=0)
 Creates vector compatible with (i.e. in the domain of) A or A^T.
 
 HypreParVector (HYPRE_ParVector y)
 Creates vector wrapping y.
 
 HypreParVector (ParFiniteElementSpace *pfes)
 Create a true dof parallel vector on a given ParFiniteElementSpace.
 
HypreParVector CreateCompatibleVector () const
 Constructs a HypreParVector compatible with the calling vector.
 
MPI_Comm GetComm () const
 MPI communicator.
 
void WrapHypreParVector (hypre_ParVector *y, bool owner=true)
 Converts hypre's format to HypreParVector.
 
const HYPRE_BigIntPartitioning () const
 Returns the parallel row/column partitioning.
 
MFEM_DEPRECATED HYPRE_BigIntPartitioning ()
 Returns a non-const pointer to the parallel row/column partitioning. Deprecated in favor of HypreParVector::Partitioning() const.
 
HYPRE_BigInt GlobalSize () const
 Returns the global number of rows.
 
 operator hypre_ParVector * () const
 Typecasting to hypre's hypre_ParVector*.
 
 operator HYPRE_ParVector () const
 Typecasting to hypre's HYPRE_ParVector, a.k.a. void *.
 
hypre_ParVector * StealParVector ()
 Changes the ownership of the vector.
 
void SetOwnership (int own)
 Sets ownership of the internal hypre_ParVector.
 
int GetOwnership () const
 Gets ownership of the internal hypre_ParVector.
 
VectorGlobalVector () const
 Returns the global vector in each processor.
 
HypreParVectoroperator= (real_t d)
 Set constant values.
 
HypreParVectoroperator= (const HypreParVector &y)
 Define '=' for hypre vectors.
 
HypreParVectoroperator= (HypreParVector &&y)
 Move assignment.
 
void SetData (real_t *data_)
 Sets the data of the Vector and the hypre_ParVector to data_.
 
void HypreRead () const
 Prepare the HypreParVector for read access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
void HypreReadWrite ()
 Prepare the HypreParVector for read and write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
void HypreWrite ()
 Prepare the HypreParVector for write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
void WrapMemoryRead (const Memory< real_t > &mem)
 Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for read access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
void WrapMemoryReadWrite (Memory< real_t > &mem)
 Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for read and write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
void WrapMemoryWrite (Memory< real_t > &mem)
 Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.
 
HYPRE_Int Randomize (HYPRE_Int seed)
 Set random values.
 
void Print (const char *fname) const
 Prints the locally owned rows in parallel.
 
void Read (MPI_Comm comm, const char *fname)
 Reads a HypreParVector from files saved with HypreParVector::Print.
 
 ~HypreParVector ()
 Calls hypre's destroy function.
 
virtual const real_tRead (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
 
- Public Member Functions inherited from mfem::Vector
 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).
 

Friends

class HypreParMatrix
 

Additional Inherited Members

- Protected Attributes inherited from mfem::Vector
Memory< real_tdata
 
int size
 

Detailed Description

Wrapper for hypre's parallel vector class.

Definition at line 205 of file hypre.hpp.

Constructor & Destructor Documentation

◆ HypreParVector() [1/8]

mfem::HypreParVector::HypreParVector ( )
inline

Default constructor, no underlying hypre_ParVector is created.

Definition at line 221 of file hypre.hpp.

◆ HypreParVector() [2/8]

mfem::HypreParVector::HypreParVector ( MPI_Comm  comm,
HYPRE_BigInt  glob_size,
HYPRE_BigInt col 
)

Creates vector with given global size and parallel partitioning of the rows/columns given by col.

The partitioning is defined in one of two ways depending on the configuration of HYPRE:

  1. If HYPRE_AssumedPartitionCheck() returns true (the default), then col is of length 2 and the local processor owns columns [col[0],col[1]).
  2. If HYPRE_AssumedPartitionCheck() returns false, then col is of length (number of processors + 1) and processor P owns columns [col[P],col[P+1]) i.e. each processor has a copy of the same col array.

Definition at line 167 of file hypre.cpp.

◆ HypreParVector() [3/8]

mfem::HypreParVector::HypreParVector ( MPI_Comm  comm,
HYPRE_BigInt  glob_size,
real_t data_,
HYPRE_BigInt col,
bool  is_device_ptr = false 
)

Creates vector with given global size, partitioning of the columns, and data.

The data must be allocated and destroyed outside. If data_ is NULL, a dummy vector without a valid data array will be created. See here for a description of the col array.

If is_device_ptr is true, the pointer data_ is assumed to be allocated in the memory location HYPRE_MEMORY_DEVICE.

Definition at line 182 of file hypre.cpp.

◆ HypreParVector() [4/8]

mfem::HypreParVector::HypreParVector ( const HypreParVector y)

Creates a deep copy of y.

Definition at line 212 of file hypre.cpp.

◆ HypreParVector() [5/8]

mfem::HypreParVector::HypreParVector ( HypreParVector &&  other)

Move constructor for HypreParVector. "Steals" data from its argument.

Definition at line 220 of file hypre.cpp.

◆ HypreParVector() [6/8]

mfem::HypreParVector::HypreParVector ( const HypreParMatrix A,
int  transpose = 0 
)
explicit

Creates vector compatible with (i.e. in the domain of) A or A^T.

Definition at line 226 of file hypre.cpp.

◆ HypreParVector() [7/8]

mfem::HypreParVector::HypreParVector ( HYPRE_ParVector  y)
explicit

Creates vector wrapping y.

Definition at line 241 of file hypre.cpp.

◆ HypreParVector() [8/8]

mfem::HypreParVector::HypreParVector ( ParFiniteElementSpace pfes)
explicit

Create a true dof parallel vector on a given ParFiniteElementSpace.

Definition at line 248 of file hypre.cpp.

◆ ~HypreParVector()

mfem::HypreParVector::~HypreParVector ( )

Calls hypre's destroy function.

Definition at line 430 of file hypre.cpp.

Member Function Documentation

◆ CreateCompatibleVector()

HypreParVector mfem::HypreParVector::CreateCompatibleVector ( ) const

Constructs a HypreParVector compatible with the calling vector.

  • meaning that it will be the same size and have the same partitioning.

Definition at line 263 of file hypre.cpp.

◆ GetComm()

MPI_Comm mfem::HypreParVector::GetComm ( ) const
inline

MPI communicator.

Definition at line 266 of file hypre.hpp.

◆ GetOwnership()

int mfem::HypreParVector::GetOwnership ( ) const
inline

Gets ownership of the internal hypre_ParVector.

Definition at line 298 of file hypre.hpp.

◆ GlobalSize()

HYPRE_BigInt mfem::HypreParVector::GlobalSize ( ) const
inline

Returns the global number of rows.

Definition at line 283 of file hypre.hpp.

◆ GlobalVector()

Vector * mfem::HypreParVector::GlobalVector ( ) const

Returns the global vector in each processor.

Definition at line 289 of file hypre.cpp.

◆ HypreRead()

void mfem::HypreParVector::HypreRead ( ) const

Prepare the HypreParVector for read access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

Definition at line 337 of file hypre.cpp.

◆ HypreReadWrite()

void mfem::HypreParVector::HypreReadWrite ( )

Prepare the HypreParVector for read and write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

Definition at line 347 of file hypre.cpp.

◆ HypreWrite()

void mfem::HypreParVector::HypreWrite ( )

Prepare the HypreParVector for write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

Definition at line 356 of file hypre.cpp.

◆ operator HYPRE_ParVector()

mfem::HypreParVector::operator HYPRE_ParVector ( ) const
inline

Typecasting to hypre's HYPRE_ParVector, a.k.a. void *.

Definition at line 289 of file hypre.hpp.

◆ operator hypre_ParVector *()

mfem::HypreParVector::operator hypre_ParVector * ( ) const
inline

Typecasting to hypre's hypre_ParVector*.

Definition at line 286 of file hypre.hpp.

◆ operator=() [1/3]

HypreParVector & mfem::HypreParVector::operator= ( const HypreParVector y)

Define '=' for hypre vectors.

Definition at line 305 of file hypre.cpp.

◆ operator=() [2/3]

HypreParVector & mfem::HypreParVector::operator= ( HypreParVector &&  y)

Move assignment.

Definition at line 318 of file hypre.cpp.

◆ operator=() [3/3]

HypreParVector & mfem::HypreParVector::operator= ( real_t  d)

Set constant values.

Definition at line 299 of file hypre.cpp.

◆ Partitioning() [1/2]

MFEM_DEPRECATED HYPRE_BigInt * mfem::HypreParVector::Partitioning ( )
inline

Returns a non-const pointer to the parallel row/column partitioning. Deprecated in favor of HypreParVector::Partitioning() const.

Definition at line 280 of file hypre.hpp.

◆ Partitioning() [2/2]

const HYPRE_BigInt * mfem::HypreParVector::Partitioning ( ) const
inline

Returns the parallel row/column partitioning.

See here for a description of the partitioning array.

Definition at line 274 of file hypre.hpp.

◆ Print()

void mfem::HypreParVector::Print ( const char *  fname) const

Prints the locally owned rows in parallel.

Definition at line 413 of file hypre.cpp.

◆ Randomize()

HYPRE_Int mfem::HypreParVector::Randomize ( HYPRE_Int  seed)

Set random values.

Definition at line 408 of file hypre.cpp.

◆ Read() [1/2]

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

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

Reimplemented from mfem::Vector.

Definition at line 474 of file vector.hpp.

◆ Read() [2/2]

void mfem::HypreParVector::Read ( MPI_Comm  comm,
const char *  fname 
)

Reads a HypreParVector from files saved with HypreParVector::Print.

Definition at line 418 of file hypre.cpp.

◆ SetData()

void mfem::HypreParVector::SetData ( real_t data_)

Sets the data of the Vector and the hypre_ParVector to data_.

Must be used only for HypreParVectors that do not own the data, e.g. created with the constructor: HypreParVector(MPI_Comm, HYPRE_BigInt, double *, HYPRE_BigInt *).

Definition at line 331 of file hypre.cpp.

◆ SetOwnership()

void mfem::HypreParVector::SetOwnership ( int  own)
inline

Sets ownership of the internal hypre_ParVector.

Definition at line 295 of file hypre.hpp.

◆ StealParVector()

hypre_ParVector * mfem::HypreParVector::StealParVector ( )
inline

Changes the ownership of the vector.

Definition at line 292 of file hypre.hpp.

◆ WrapHypreParVector()

void mfem::HypreParVector::WrapHypreParVector ( hypre_ParVector *  y,
bool  owner = true 
)

Converts hypre's format to HypreParVector.

Definition at line 280 of file hypre.cpp.

◆ WrapMemoryRead()

void mfem::HypreParVector::WrapMemoryRead ( const Memory< real_t > &  mem)

Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for read access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

This method must be used with HypreParVectors that do not own the data, e.g. created with the constructor: HypreParVector(MPI_Comm, HYPRE_BigInt, double *, HYPRE_BigInt *).

The Memory mem must be accessible with the hypre MemoryClass defined by GetHypreMemoryClass().

Definition at line 365 of file hypre.cpp.

◆ WrapMemoryReadWrite()

void mfem::HypreParVector::WrapMemoryReadWrite ( Memory< real_t > &  mem)

Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for read and write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

This method must be used with HypreParVectors that do not own the data, e.g. created with the constructor: HypreParVector(MPI_Comm, HYPRE_BigInt, double *, HYPRE_BigInt *).

The Memory mem must be accessible with the hypre MemoryClass defined by GetHypreMemoryClass().

Definition at line 380 of file hypre.cpp.

◆ WrapMemoryWrite()

void mfem::HypreParVector::WrapMemoryWrite ( Memory< real_t > &  mem)

Replace the HypreParVector's data with the given Memory, mem, and prepare the vector for write access in hypre's device memory space, HYPRE_MEMORY_DEVICE.

This method must be used with HypreParVectors that do not own the data, e.g. created with the constructor: HypreParVector(MPI_Comm, HYPRE_BigInt, double *, HYPRE_BigInt *).

The Memory mem must be accessible with the hypre MemoryClass defined by GetHypreMemoryClass().

Definition at line 394 of file hypre.cpp.

Friends And Related Function Documentation

◆ HypreParMatrix

friend class HypreParMatrix
friend

Definition at line 213 of file hypre.hpp.


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