![]() |
MFEM
v4.5.2
Finite element discretization library
|
Vector interface for SUNDIALS N_Vectors. More...
#include <sundials.hpp>
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 |
Vector & | operator= (const double *v) |
Copy assignment. More... | |
Vector & | operator= (const Vector &v) |
Copy assignment. More... | |
Vector & | operator= (Vector &&v) |
Copy assignment. More... | |
Vector & | operator= (double value) |
Copy assignment. More... | |
![]() | |
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... | |
MFEM_DEPRECATED | operator double * () |
Conversion to double * . Deprecated. More... | |
MFEM_DEPRECATED | operator const double * () const |
Conversion to const double * . Deprecated. 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[] (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... | |
Vector & | operator= (const double *v) |
Copy Size() entries from v. More... | |
Vector & | operator= (const Vector &v) |
Copy assignment. More... | |
Vector & | operator= (Vector &&v) |
Move assignment. More... | |
Vector & | operator= (double value) |
Redefine '=' for vector = constant. More... | |
Vector & | operator*= (double c) |
Vector & | operator*= (const Vector &v) |
Component-wise scaling: (*this)(i) *= v(i) More... | |
Vector & | operator/= (double c) |
Vector & | operator/= (const Vector &v) |
Component-wise division: (*this)(i) /= v(i) More... | |
Vector & | operator-= (double c) |
Vector & | operator-= (const Vector &v) |
Vector & | operator+= (double c) |
Vector & | operator+= (const Vector &v) |
Vector & | Add (const double a, const Vector &Va) |
(*this) += a * Va More... | |
Vector & | Set (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... | |
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 | DistanceSquaredTo (const Vector &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... | |
double | DistanceTo (const Vector &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... | |
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... | |
![]() | |
Memory< double > | data |
int | size |
Friends | |
class | SundialsSolver |
Vector interface for SUNDIALS N_Vectors.
Definition at line 173 of file sundials.hpp.
mfem::SundialsNVector::SundialsNVector | ( | ) |
Creates an empty SundialsNVector.
Definition at line 434 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 444 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 453 of file sundials.cpp.
mfem::SundialsNVector::SundialsNVector | ( | MPI_Comm | comm | ) |
Creates an empty SundialsNVector.
Definition at line 461 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 469 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 478 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 488 of file sundials.cpp.
mfem::SundialsNVector::~SundialsNVector | ( | ) |
Calls SUNDIALS N_VDestroy function if the N_Vector is owned by 'this'.
Definition at line 493 of file sundials.cpp.
|
protected |
Set data and length from the internal N_Vector x.
Definition at line 386 of file sundials.cpp.
|
protected |
Set data and length of internal N_Vector x from 'this'.
Definition at line 313 of file sundials.cpp.
|
inline |
Returns the MPI communicator for the internal N_Vector x.
Definition at line 230 of file sundials.hpp.
|
inline |
Returns the N_Vector_ID for the internal N_Vector.
Definition at line 223 of file sundials.hpp.
|
inline |
Returns the N_Vector_ID for the N_Vector x_.
Definition at line 226 of file sundials.hpp.
|
inline |
Gets ownership of the internal N_Vector.
Definition at line 278 of file sundials.hpp.
|
inline |
Returns the MPI global length for the internal N_Vector x.
Definition at line 233 of file sundials.hpp.
|
static |
Create a N_Vector.
[in] | use_device | If true, use the SUNDIALS CUDA N_Vector. |
Definition at line 525 of file sundials.cpp.
|
static |
Create a parallel N_Vector.
[in] | comm | The MPI communicator to use. |
[in] | use_device | If true, use the SUNDIALS CUDA N_Vector. |
Definition at line 548 of file sundials.cpp.
|
inline |
Reset the Vector to be a reference to a sub-vector of base.
Definition at line 250 of file sundials.hpp.
|
inline |
Reset the Vector to be a reference to a sub-vector of base without changing its current size.
Definition at line 260 of file sundials.hpp.
|
inline |
Definition at line 286 of file sundials.hpp.
|
inline |
Definition at line 289 of file sundials.hpp.
|
inline |
Typecasting to SUNDIALS' N_Vector type.
Definition at line 269 of file sundials.hpp.
Vector & mfem::Vector::operator= |
Copy assignment.
Definition at line 124 of file vector.cpp.
Vector & mfem::Vector::operator= |
Copy assignment.
Definition at line 149 of file vector.cpp.
Vector & mfem::Vector::operator= |
Copy assignment.
Definition at line 159 of file vector.cpp.
Vector & mfem::Vector::operator= |
Copy assignment.
Definition at line 130 of file vector.cpp.
void mfem::SundialsNVector::SetData | ( | double * | d | ) |
Set the vector data.
Definition at line 513 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().
Definition at line 519 of file sundials.cpp.
|
inline |
Sets ownership of the internal N_Vector.
Definition at line 275 of file sundials.hpp.
void mfem::SundialsNVector::SetSize | ( | int | s, |
long | glob_size = 0 |
||
) |
Resize the vector to size s.
Definition at line 507 of file sundials.cpp.
|
inline |
Changes the ownership of the the vector.
Definition at line 272 of file sundials.hpp.
|
inlinestatic |
Definition at line 304 of file sundials.hpp.
|
inlinestatic |
Definition at line 309 of file sundials.hpp.
|
friend |
Definition at line 181 of file sundials.hpp.
|
protected |
Definition at line 176 of file sundials.hpp.
|
protected |
The actual SUNDIALS object.
Definition at line 179 of file sundials.hpp.