mfem::SundialsNVector Class Reference

Vector interface for SUNDIALS N_Vectors. More...

#include <sundials.hpp>

Inheritance diagram for mfem::SundialsNVector:

Collaboration diagram for mfem::SundialsNVector:

Public Member Functions
	SundialsNVector ()
	Creates an empty SundialsNVector.
	SundialsNVector (double *data_, int size_)
	Creates a SundialsNVector referencing an array of doubles, owned by someone else.
	SundialsNVector (N_Vector nv)
	Creates a SundialsNVector out of a SUNDIALS N_Vector object.
	SundialsNVector (MPI_Comm comm)
	Creates an empty SundialsNVector.
	SundialsNVector (MPI_Comm comm, int loc_size, long glob_size)
	Creates a SundialsNVector with the given local and global sizes.
	SundialsNVector (MPI_Comm comm, double *data_, int loc_size, long glob_size)
	Creates a SundialsNVector referencing an array of doubles, owned by someone else.
	SundialsNVector (HypreParVector &vec)
	Creates a SundialsNVector from a HypreParVector.
	~SundialsNVector ()
	Calls SUNDIALS N_VDestroy function if the N_Vector is owned by 'this'.
N_Vector_ID	GetNVectorID () const
	Returns the N_Vector_ID for the internal N_Vector.
N_Vector_ID	GetNVectorID (N_Vector x_) const
	Returns the N_Vector_ID for the N_Vector x_.
MPI_Comm	GetComm () const
	Returns the MPI communicator for the internal N_Vector x.
long	GlobalSize () const
	Returns the MPI global length for the internal N_Vector x.
void	SetSize (int s, long glob_size=0)
	Resize the vector to size s.
void	SetData (double *d)
void	SetDataAndSize (double *d, int s, long glob_size=0)
	Set the vector data and size.
void	MakeRef (Vector &base, int offset, int s)
	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.
	operator N_Vector () const
	Typecasting to SUNDIALS' N_Vector type.
N_Vector	StealNVector ()
	Changes the ownership of the the vector.
void	SetOwnership (int own)
	Sets ownership of the internal N_Vector.
int	GetOwnership () const
	Gets ownership of the internal N_Vector.
bool	MPIPlusX () const
bool	MPIPlusX () const
Vector &	operator= (const real_t *v)
	Copy assignment.
Vector &	operator= (const Vector &v)
	Copy assignment.
Vector &	operator= (Vector &&v)
	Copy assignment.
Vector &	operator= (real_t value)
	Copy assignment.
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_t *	GetData () const
	Return a pointer to the beginning of the Vector data.
MFEM_DEPRECATED	operator real_t * ()
	Conversion to double *. Deprecated.
MFEM_DEPRECATED	operator const real_t * () const
	Conversion to const double *. Deprecated.
real_t *	begin ()
	STL-like begin.
real_t *	end ()
	STL-like end.
const real_t *	begin () const
	STL-like begin (const version).
const real_t *	end () const
	STL-like end (const version).
Memory< real_t > &	GetMemory ()
	Return a reference to the Memory object used by the Vector.
const Memory< real_t > &	GetMemory () const
	Return a reference to the Memory object used by the Vector, const version.
void	SyncMemory (const Vector &v) const
	Update the memory location of the vector to match v.
void	SyncAliasMemory (const Vector &v) const
	Update the alias memory location of the vector to match v.
bool	OwnsData () const
	Read the Vector data (host pointer) ownership flag.
void	StealData (real_t **p)
	Changes the ownership of the data; after the call the Vector is empty.
real_t *	StealData ()
	Changes the ownership of the data; after the call the Vector is empty.
real_t &	Elem (int i)
	Access Vector entries. Index i = 0 .. size-1.
const real_t &	Elem (int i) const
	Read only access to Vector entries. Index i = 0 .. size-1.
real_t &	operator() (int i)
	Access Vector entries using () for 0-based indexing.
const real_t &	operator() (int i) const
	Read only access to Vector entries using () for 0-based indexing.
real_t &	operator[] (int i)
	Access Vector entries using [] for 0-based indexing.
const real_t &	operator[] (int i) const
	Read only access to Vector entries using [] for 0-based indexing.
real_t	operator* (const real_t *) const
	Dot product with a double * array.
real_t	operator* (const Vector &v) const
	Return the inner-product.
Vector &	operator= (const real_t *v)
	Copy Size() entries from v.
Vector &	operator= (const Vector &v)
	Copy assignment.
Vector &	operator= (Vector &&v)
	Move assignment.
Vector &	operator= (real_t value)
	Redefine '=' for vector = constant.
Vector &	operator*= (real_t c)
Vector &	operator*= (const Vector &v)
	Component-wise scaling: (*this)(i) *= v(i)
Vector &	operator/= (real_t c)
Vector &	operator/= (const Vector &v)
	Component-wise division: (*this)(i) /= v(i)
Vector &	operator-= (real_t c)
Vector &	operator-= (const Vector &v)
Vector &	operator+= (real_t c)
Vector &	operator+= (const Vector &v)
Vector &	Add (const real_t a, const Vector &Va)
	(*this) += a * Va
Vector &	Set (const real_t a, const Vector &x)
	(*this) = a * x
void	SetVector (const Vector &v, int offset)
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_t *	Read (bool on_dev=true) const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
virtual const real_t *	HostRead () const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
virtual real_t *	Write (bool on_dev=true)
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
virtual real_t *	HostWrite ()
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
virtual real_t *	ReadWrite (bool on_dev=true)
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
virtual real_t *	HostReadWrite ()
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).

Static Public Member Functions
static N_Vector	MakeNVector (bool use_device)
	Create a N_Vector.
static N_Vector	MakeNVector (MPI_Comm comm, bool use_device)
	Create a parallel N_Vector.
static bool	UseManagedMemory ()
static bool	UseManagedMemory ()

Protected Member Functions
void	_SetNvecDataAndSize_ (long glob_size=0)
	Set data and length of internal N_Vector x from 'this'.
void	_SetDataAndSize_ ()
	Set data and length from the internal N_Vector x.

Protected Attributes
int	own_NVector
N_Vector	x
	The actual SUNDIALS object.
Protected Attributes inherited from mfem::Vector
Memory< real_t >	data
int	size

Friends
class	SundialsSolver

Detailed Description

Vector interface for SUNDIALS N_Vectors.

Definition at line 184 of file sundials.hpp.

Constructor & Destructor Documentation

SundialsNVector() [1/7]

mfem::SundialsNVector::SundialsNVector

(

)

Creates an empty SundialsNVector.

Definition at line 445 of file sundials.cpp.

SundialsNVector() [2/7]

mfem::SundialsNVector::SundialsNVector	(	double *	data_,
		int	size_ )

Creates a SundialsNVector 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 455 of file sundials.cpp.

SundialsNVector() [3/7]

mfem::SundialsNVector::SundialsNVector

(

N_Vector

nv

)

Creates a SundialsNVector out of a SUNDIALS N_Vector object.

The N_Vector nv must be destroyed outside.

Definition at line 464 of file sundials.cpp.

SundialsNVector() [4/7]

mfem::SundialsNVector::SundialsNVector

(

MPI_Comm

comm

)

Creates an empty SundialsNVector.

Definition at line 472 of file sundials.cpp.

SundialsNVector() [5/7]

mfem::SundialsNVector::SundialsNVector	(	MPI_Comm	comm,
		int	loc_size,
		long	glob_size )

Creates a SundialsNVector with the given local and global sizes.

Definition at line 480 of file sundials.cpp.

SundialsNVector() [6/7]

mfem::SundialsNVector::SundialsNVector	(	MPI_Comm	comm,
		double *	data_,
		int	loc_size,
		long	glob_size )

Creates a SundialsNVector 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 489 of file sundials.cpp.

SundialsNVector() [7/7]

mfem::SundialsNVector::SundialsNVector

(

HypreParVector &

vec

)

Creates a SundialsNVector from a HypreParVector.

Ownership of the data will not change.

Definition at line 499 of file sundials.cpp.

~SundialsNVector()

mfem::SundialsNVector::~SundialsNVector

(

)

Calls SUNDIALS N_VDestroy function if the N_Vector is owned by 'this'.

Definition at line 504 of file sundials.cpp.

Member Function Documentation

_SetDataAndSize_()

void mfem::SundialsNVector::_SetDataAndSize_ ( )

protected

Set data and length from the internal N_Vector x.

Definition at line 397 of file sundials.cpp.

_SetNvecDataAndSize_()

void mfem::SundialsNVector::_SetNvecDataAndSize_ ( long glob_size = 0 )

protected

Set data and length of internal N_Vector x from 'this'.

Definition at line 323 of file sundials.cpp.

GetComm()

MPI_Comm mfem::SundialsNVector::GetComm ( ) const

inline

Returns the MPI communicator for the internal N_Vector x.

Definition at line 241 of file sundials.hpp.

GetNVectorID() [1/2]

N_Vector_ID mfem::SundialsNVector::GetNVectorID ( ) const

inline

Returns the N_Vector_ID for the internal N_Vector.

Definition at line 234 of file sundials.hpp.

GetNVectorID() [2/2]

N_Vector_ID mfem::SundialsNVector::GetNVectorID ( N_Vector x_ ) const

inline

Returns the N_Vector_ID for the N_Vector x_.

Definition at line 237 of file sundials.hpp.

GetOwnership()

int mfem::SundialsNVector::GetOwnership ( ) const

inline

Gets ownership of the internal N_Vector.

Definition at line 289 of file sundials.hpp.

GlobalSize()

long mfem::SundialsNVector::GlobalSize ( ) const

inline

Returns the MPI global length for the internal N_Vector x.

Definition at line 244 of file sundials.hpp.

MakeNVector() [1/2]

N_Vector mfem::SundialsNVector::MakeNVector ( bool use_device )

static

Create a N_Vector.

Parameters

[in]

use_device

If true, use the SUNDIALS CUDA or HIP N_Vector.

Definition at line 536 of file sundials.cpp.

MakeNVector() [2/2]

N_Vector mfem::SundialsNVector::MakeNVector ( MPI_Comm comm, bool use_device )

static

Create a parallel N_Vector.

Parameters

[in]	comm	The MPI communicator to use.
[in]	use_device	If true, use the SUNDIALS CUDA or HIP N_Vector.

Definition at line 560 of file sundials.cpp.

MakeRef() [1/2]

void mfem::SundialsNVector::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 271 of file sundials.hpp.

MakeRef() [2/2]

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

inline

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

Definition at line 261 of file sundials.hpp.

MPIPlusX() [1/2]

bool mfem::SundialsNVector::MPIPlusX ( ) const

inline

Definition at line 297 of file sundials.hpp.

MPIPlusX() [2/2]

bool mfem::SundialsNVector::MPIPlusX ( ) const

inline

Definition at line 300 of file sundials.hpp.

operator N_Vector()

mfem::SundialsNVector::operator N_Vector ( ) const

inline

Typecasting to SUNDIALS' N_Vector type.

Definition at line 280 of file sundials.hpp.

operator=() [1/4]

Vector & mfem::Vector::operator=

(

const real_t *

v

)

Copy assignment.

Note

Defining this method overwrites the implicitly defined copy assignment operator.

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

operator=() [3/4]

Vector & mfem::Vector::operator=

(

real_t

value

)

Copy assignment.

Note

Defining this method overwrites the implicitly defined copy assignment operator.

Definition at line 312 of file vector.cpp.

operator=() [4/4]

Vector & mfem::Vector::operator=

(

Vector &&

v

)

Copy assignment.

Note

Defining this method overwrites the implicitly defined copy assignment operator.

Definition at line 309 of file vector.cpp.

SetData()

void mfem::SundialsNVector::SetData

(

double *

d

)

Set the vector data.

Warning

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

Definition at line 524 of file sundials.cpp.

SetDataAndSize()

void mfem::SundialsNVector::SetDataAndSize	(	double *	d,
		int	s,
		long	glob_size = 0 )

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.

Definition at line 530 of file sundials.cpp.

SetOwnership()

void mfem::SundialsNVector::SetOwnership ( int own )

inline

Sets ownership of the internal N_Vector.

Definition at line 286 of file sundials.hpp.

SetSize()

void mfem::SundialsNVector::SetSize	(	int	s,
		long	glob_size = 0 )

Resize the vector to size s.

Definition at line 518 of file sundials.cpp.

StealNVector()

N_Vector mfem::SundialsNVector::StealNVector ( )

inline

Changes the ownership of the the vector.

Definition at line 283 of file sundials.hpp.

UseManagedMemory() [1/2]

static bool mfem::SundialsNVector::UseManagedMemory ( )

inlinestatic

Definition at line 315 of file sundials.hpp.

UseManagedMemory() [2/2]

static bool mfem::SundialsNVector::UseManagedMemory ( )

inlinestatic

Definition at line 320 of file sundials.hpp.

Friends And Related Symbol Documentation

SundialsSolver

friend class SundialsSolver

friend

Definition at line 192 of file sundials.hpp.

Member Data Documentation

own_NVector

int mfem::SundialsNVector::own_NVector

protected

Definition at line 187 of file sundials.hpp.

x

N_Vector mfem::SundialsNVector::x

protected

The actual SUNDIALS object.

Definition at line 190 of file sundials.hpp.

---

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

• linalg/sundials.hpp
• linalg/sundials.cpp