![]() |
MFEM
v4.5.2
Finite element discretization library
|
A class to handle Vectors in a block fashion. More...
#include <blockvector.hpp>
Public Member Functions | |
BlockVector () | |
empty constructor More... | |
BlockVector (const Array< int > &bOffsets) | |
Constructor. More... | |
BlockVector (const Array< int > &bOffsets, MemoryType mt) | |
Construct a BlockVector with the given MemoryType mt. More... | |
BlockVector (const BlockVector &block) | |
Copy constructor. More... | |
BlockVector (double *data, const Array< int > &bOffsets) | |
View constructor. More... | |
BlockVector (Vector &v, const Array< int > &bOffsets) | |
Wrap a Vector as a BlockVector. More... | |
int | NumBlocks () const |
Return the number of blocks. More... | |
BlockVector & | operator= (const BlockVector &original) |
Assignment operator. this and original must have the same block structure. More... | |
BlockVector & | operator= (double val) |
Set each entry of this equal to val. More... | |
~BlockVector () | |
Destructor. More... | |
Vector & | GetBlock (int i) |
Get the i-th vector in the block. More... | |
const Vector & | GetBlock (int i) const |
Get the i-th vector in the block (const version). More... | |
void | GetBlockView (int i, Vector &blockView) |
Get the i-th vector in the block. More... | |
int | BlockSize (int i) |
void | Update (double *data, const Array< int > &bOffsets) |
Update method. More... | |
void | Update (Vector &data, const Array< int > &bOffsets) |
void | Update (const Array< int > &bOffsets) |
Update a BlockVector with new bOffsets and make sure it owns its data. More... | |
void | Update (const Array< int > &bOffsets, MemoryType mt) |
Update a BlockVector with new bOffsets and make sure it owns its data and uses the MemoryType mt. More... | |
void | SyncToBlocks () const |
Synchronize the memory location flags (i.e. the memory validity flags) of the big/monolithic block-vector with its sub-vector blocks. The big/monolithic vector has the correct memory location flags. More... | |
void | SyncFromBlocks () const |
Synchronize the memory location flags (i.e. the memory validity flags) of the big/monolithic block-vector with its sub-vector blocks. The sub-vector blocks have the correct memory location flags. 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... | |
Protected Member Functions | |
void | SetBlocks () |
Protected Attributes | |
int | numBlocks |
Number of blocks in the blockVector. More... | |
const int * | blockOffsets |
Offset for each block start. (length numBlocks+1) More... | |
Vector * | blocks |
array of Vector objects used to extract blocks without allocating memory. More... | |
![]() | |
Memory< double > | data |
int | size |
A class to handle Vectors in a block fashion.
All data is contained in Vector::data, while blockVector is just a viewer for this data.
Definition at line 30 of file blockvector.hpp.
mfem::BlockVector::BlockVector | ( | ) |
empty constructor
Definition at line 27 of file blockvector.cpp.
mfem::BlockVector::BlockVector | ( | const Array< int > & | bOffsets | ) |
Constructor.
Standard constructor.
bOffsets is an array of integers (length nBlocks+1) that tells the offsets of each block start.
Definition at line 37 of file blockvector.cpp.
mfem::BlockVector::BlockVector | ( | const Array< int > & | bOffsets, |
MemoryType | mt | ||
) |
Construct a BlockVector with the given MemoryType mt.
Definition at line 46 of file blockvector.cpp.
mfem::BlockVector::BlockVector | ( | const BlockVector & | block | ) |
Copy constructor.
Definition at line 56 of file blockvector.cpp.
mfem::BlockVector::BlockVector | ( | double * | data, |
const Array< int > & | bOffsets | ||
) |
View constructor.
data is an array of double of length at least blockOffsets[numBlocks] that contain all the values of the monolithic vector. bOffsets is an array of integers (length nBlocks+1) that tells the offsets of each block start. nBlocks is the number of blocks.
Definition at line 66 of file blockvector.cpp.
Wrap a Vector as a BlockVector.
Definition at line 75 of file blockvector.cpp.
mfem::BlockVector::~BlockVector | ( | ) |
Destructor.
Definition at line 182 of file blockvector.cpp.
|
inline |
Definition at line 97 of file blockvector.hpp.
|
inline |
Get the i-th vector in the block.
Definition at line 90 of file blockvector.hpp.
|
inline |
Get the i-th vector in the block (const version).
Definition at line 92 of file blockvector.hpp.
void mfem::BlockVector::GetBlockView | ( | int | i, |
Vector & | blockView | ||
) |
Get the i-th vector in the block.
Definition at line 187 of file blockvector.cpp.
|
inline |
Return the number of blocks.
Definition at line 79 of file blockvector.hpp.
BlockVector & mfem::BlockVector::operator= | ( | const BlockVector & | original | ) |
Assignment operator. this and original must have the same block structure.
Definition at line 155 of file blockvector.cpp.
BlockVector & mfem::BlockVector::operator= | ( | double | val | ) |
Set each entry of this equal to val.
Definition at line 175 of file blockvector.cpp.
|
protected |
Definition at line 19 of file blockvector.cpp.
void mfem::BlockVector::SyncFromBlocks | ( | ) | const |
Synchronize the memory location flags (i.e. the memory validity flags) of the big/monolithic block-vector with its sub-vector blocks. The sub-vector blocks have the correct memory location flags.
This method will copy/move the data of the sub-vector blocks (if necessary) so that each block matches the memory location flags of the big/monolithic block-vector.
Definition at line 200 of file blockvector.cpp.
void mfem::BlockVector::SyncToBlocks | ( | ) | const |
Synchronize the memory location flags (i.e. the memory validity flags) of the big/monolithic block-vector with its sub-vector blocks. The big/monolithic vector has the correct memory location flags.
This method will copy the data validity flags from the big/monolithic block-vector to its sub-vector block.
Definition at line 192 of file blockvector.cpp.
void mfem::BlockVector::Update | ( | double * | data, |
const Array< int > & | bOffsets | ||
) |
Update method.
data is an array of double of length at least blockOffsets[numBlocks] that contain all the values of the monolithic vector. bOffsets is an array of integers (length nBlocks+1) that tells the offsets of each block start. nBlocks is the number of blocks.
Definition at line 85 of file blockvector.cpp.
Definition at line 98 of file blockvector.cpp.
void mfem::BlockVector::Update | ( | const Array< int > & | bOffsets | ) |
Update a BlockVector with new bOffsets and make sure it owns its data.
The block-vector will be re-allocated if either:
Definition at line 115 of file blockvector.cpp.
void mfem::BlockVector::Update | ( | const Array< int > & | bOffsets, |
MemoryType | mt | ||
) |
Update a BlockVector with new bOffsets and make sure it owns its data and uses the MemoryType mt.
The block-vector will be re-allocated if either:
Definition at line 120 of file blockvector.cpp.
|
protected |
Offset for each block start. (length numBlocks+1)
blockOffsets[i+1] - blockOffsets[i] is the size of block i.
This array is not owned.
Definition at line 42 of file blockvector.hpp.
|
protected |
array of Vector objects used to extract blocks without allocating memory.
This array is owned.
Definition at line 45 of file blockvector.hpp.
|
protected |
Number of blocks in the blockVector.
Definition at line 35 of file blockvector.hpp.