MFEM  v4.3.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
mfem::SundialsNVector Class Reference

Vector interface for SUNDIALS N_Vectors. More...

#include <sundials.hpp>

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

Public Member Functions

 SundialsNVector ()
 Creates an empty SundialsNVector. More...
 
 SundialsNVector (double *data_, int size_)
 Creates a SundialsNVector referencing an array of doubles, owned by someone else. More...
 
 SundialsNVector (N_Vector nv)
 Creates a SundialsNVector out of a SUNDIALS N_Vector object. More...
 
 SundialsNVector (MPI_Comm comm)
 Creates an empty SundialsNVector. More...
 
 SundialsNVector (MPI_Comm comm, int loc_size, long glob_size)
 Creates a SundialsNVector with the given local and global sizes. More...
 
 SundialsNVector (MPI_Comm comm, double *data_, int loc_size, long glob_size)
 Creates a SundialsNVector referencing an array of doubles, owned by someone else. More...
 
 SundialsNVector (HypreParVector &vec)
 Creates a SundialsNVector from a HypreParVector. More...
 
 ~SundialsNVector ()
 Calls SUNDIALS N_VDestroy function if the N_Vector is owned by 'this'. More...
 
N_Vector_ID GetNVectorID () const
 Returns the N_Vector_ID for the internal N_Vector. More...
 
N_Vector_ID GetNVectorID (N_Vector x_) const
 Returns the N_Vector_ID for the N_Vector x_. More...
 
MPI_Comm GetComm () const
 Returns the MPI communicator for the internal N_Vector x. More...
 
long GlobalSize () const
 Returns the MPI global length for the internal N_Vector x. More...
 
void SetSize (int s, long glob_size=0)
 Resize the vector to size s. More...
 
void SetData (double *d)
 
void SetDataAndSize (double *d, int s, long glob_size=0)
 Set the vector data and size. More...
 
void MakeRef (Vector &base, int offset, int s)
 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...
 
 operator N_Vector () const
 Typecasting to SUNDIALS' N_Vector type. More...
 
N_Vector StealNVector ()
 Changes the ownership of the the vector. More...
 
void SetOwnership (int own)
 Sets ownership of the internal N_Vector. More...
 
int GetOwnership () const
 Gets ownership of the internal N_Vector. More...
 
bool MPIPlusX () const
 
bool MPIPlusX () const
 
- Public Member Functions inherited from mfem::Vector
 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...
 
 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= (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)
 
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
 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...
 
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...
 
MFEM_DEPRECATED Vector (N_Vector nv)
 (DEPRECATED) Construct a wrapper Vector from SUNDIALS N_Vector. More...
 
virtual MFEM_DEPRECATED N_Vector ToNVector ()
 (DEPRECATED) Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...
 
virtual MFEM_DEPRECATED void ToNVector (N_Vector &nv, long global_length=0)
 Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More...
 

Static Public Member Functions

static N_Vector MakeNVector (bool use_device)
 Create a N_Vector. More...
 
static N_Vector MakeNVector (MPI_Comm comm, bool use_device)
 Create a parallel N_Vector. More...
 
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'. More...
 
void _SetDataAndSize_ ()
 Set data and length from the internal N_Vector x. More...
 

Protected Attributes

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

Friends

class SundialsSolver
 

Detailed Description

Vector interface for SUNDIALS N_Vectors.

Definition at line 51 of file sundials.hpp.

Constructor & Destructor Documentation

mfem::SundialsNVector::SundialsNVector ( )

Creates an empty SundialsNVector.

Definition at line 273 of file sundials.cpp.

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 283 of file sundials.cpp.

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 292 of file sundials.cpp.

mfem::SundialsNVector::SundialsNVector ( MPI_Comm  comm)

Creates an empty SundialsNVector.

Definition at line 300 of file sundials.cpp.

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 308 of file sundials.cpp.

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 317 of file sundials.cpp.

mfem::SundialsNVector::SundialsNVector ( HypreParVector vec)

Creates a SundialsNVector from a HypreParVector.

Ownership of the data will not change.

Definition at line 327 of file sundials.cpp.

mfem::SundialsNVector::~SundialsNVector ( )

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

Definition at line 332 of file sundials.cpp.

Member Function Documentation

void mfem::SundialsNVector::_SetDataAndSize_ ( )
protected

Set data and length from the internal N_Vector x.

Definition at line 225 of file sundials.cpp.

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

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

Definition at line 152 of file sundials.cpp.

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

Returns the MPI communicator for the internal N_Vector x.

Definition at line 108 of file sundials.hpp.

N_Vector_ID mfem::SundialsNVector::GetNVectorID ( ) const
inline

Returns the N_Vector_ID for the internal N_Vector.

Definition at line 101 of file sundials.hpp.

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

Returns the N_Vector_ID for the N_Vector x_.

Definition at line 104 of file sundials.hpp.

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

Gets ownership of the internal N_Vector.

Definition at line 156 of file sundials.hpp.

long mfem::SundialsNVector::GlobalSize ( ) const
inline

Returns the MPI global length for the internal N_Vector x.

Definition at line 111 of file sundials.hpp.

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

Create a N_Vector.

Parameters
[in]use_deviceIf true, use the SUNDIALS CUDA N_Vector.

Definition at line 364 of file sundials.cpp.

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

Create a parallel N_Vector.

Parameters
[in]commThe MPI communicator to use.
[in]use_deviceIf true, use the SUNDIALS CUDA N_Vector.

Definition at line 386 of file sundials.cpp.

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 128 of file sundials.hpp.

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 138 of file sundials.hpp.

bool mfem::SundialsNVector::MPIPlusX ( ) const
inline

Definition at line 164 of file sundials.hpp.

bool mfem::SundialsNVector::MPIPlusX ( ) const
inline

Definition at line 167 of file sundials.hpp.

mfem::SundialsNVector::operator N_Vector ( ) const
inline

Typecasting to SUNDIALS' N_Vector type.

Definition at line 147 of file sundials.hpp.

void mfem::SundialsNVector::SetData ( double *  d)

Set the vector data.

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

Definition at line 352 of file sundials.cpp.

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 358 of file sundials.cpp.

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

Sets ownership of the internal N_Vector.

Definition at line 153 of file sundials.hpp.

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

Resize the vector to size s.

Definition at line 346 of file sundials.cpp.

N_Vector mfem::SundialsNVector::StealNVector ( )
inline

Changes the ownership of the the vector.

Definition at line 150 of file sundials.hpp.

static bool mfem::SundialsNVector::UseManagedMemory ( )
inlinestatic

Definition at line 182 of file sundials.hpp.

static bool mfem::SundialsNVector::UseManagedMemory ( )
inlinestatic

Definition at line 187 of file sundials.hpp.

Friends And Related Function Documentation

friend class SundialsSolver
friend

Definition at line 59 of file sundials.hpp.

Member Data Documentation

int mfem::SundialsNVector::own_NVector
protected

Definition at line 54 of file sundials.hpp.

N_Vector mfem::SundialsNVector::x
protected

The actual SUNDIALS object.

Definition at line 57 of file sundials.hpp.


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