A class to handle Vectors in a block fashion. More...

#include <blockvector.hpp>

Inheritance diagram for mfem::BlockVector:

Collaboration diagram for mfem::BlockVector:

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 &	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 (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...

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...

void	UseDevice (bool use_dev) const
	Enable execution of Vector operations using the mfem::Device. More...

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	MakeDataOwner () const
	Set the Vector data (host pointer) ownership flag. More...

void	Destroy ()
	Destroy a vector. 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...

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)
	Update the memory location of the vector to match v. More...

void	SyncAliasMemory (const Vector &v)
	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...

Vector &	operator= (const double *v)
	Copy Size() entries from v. More...

Vector &	operator= (const Vector &v)
	Copy assignment. More...

Vector &	operator= (double value)
	Redefine '=' for vector = constant. More...

Vector &	operator*= (double c)

Vector &	operator/= (double c)

Vector &	operator-= (double c)

Vector &	operator-= (const Vector &v)

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	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

void	GetSubVector (const Array< int > &dofs, double *elem_data) const

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)

void	SetSubVector (const Array< int > &dofs, double *elem_data)

void	AddElementVector (const Array< int > &dofs, const Vector &elemvect)
	Add (element) subvector to the vector. More...

void	AddElementVector (const Array< int > &dofs, double *elem_data)

void	AddElementVector (const Array< int > &dofs, const double a, const Vector &elemvect)

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_HYPRE (std::ostream &out) const
	Prints vector to stream out in HYPRE_Vector format. 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...

const double *	Read (bool on_dev=true) const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev). More...

const double *	HostRead () const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false). More...

double *	Write (bool on_dev=true)
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev). More...

double *	HostWrite ()
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false). More...

double *	ReadWrite (bool on_dev=true)
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev). More...

double *	HostReadWrite ()
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false). More...

	Vector (N_Vector nv)
	Construct a wrapper Vector from SUNDIALS N_Vector. More...

virtual N_Vector	ToNVector ()
	Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...

virtual void	ToNVector (N_Vector &nv)
	Update an existing wrapper SUNDIALS N_Vector to point to this Vector. 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...

Protected Attributes inherited from mfem::Vector
Memory< double >	data

int	size

Detailed Description

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.

Constructor & Destructor Documentation

mfem::BlockVector::BlockVector ( )

empty constructor

Definition at line 29 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 39 of file blockvector.cpp.

mfem::BlockVector::BlockVector	(	const Array< int > &	bOffsets,
		MemoryType	mt
	)

Construct a BlockVector with the given MemoryType mt.

Definition at line 48 of file blockvector.cpp.

mfem::BlockVector::BlockVector ( const BlockVector & block )

Copy constructor.

Definition at line 58 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 68 of file blockvector.cpp.

mfem::BlockVector::~BlockVector ( )

Destructor.

Definition at line 157 of file blockvector.cpp.

Member Function Documentation

int mfem::BlockVector::BlockSize ( int i )

inline

Definition at line 91 of file blockvector.hpp.

Vector& mfem::BlockVector::GetBlock ( int i )

inline

Get the i-th vector in the block.

Definition at line 84 of file blockvector.hpp.

const Vector& mfem::BlockVector::GetBlock ( int i ) const

inline

Get the i-th vector in the block (const version).

Definition at line 86 of file blockvector.hpp.

void mfem::BlockVector::GetBlockView	(	int	i,
		Vector &	blockView
	)

Get the i-th vector in the block.

Definition at line 162 of file blockvector.cpp.

BlockVector & mfem::BlockVector::operator= ( const BlockVector & original )

Assignment operator. this and original must have the same block structure.

Definition at line 130 of file blockvector.cpp.

BlockVector & mfem::BlockVector::operator= ( double val )

Set each entry of this equal to val.

Definition at line 150 of file blockvector.cpp.

void mfem::BlockVector::SetBlocks ( )

protected

Definition at line 19 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 77 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:

the offsets bOffsets are different from the current offsets, or
currently, the block-vector does not own its data.

Definition at line 90 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:

the offsets bOffsets are different from the current offsets, or
currently, the block-vector does not own its data, or
currently, the block-vector does not use MemoryType mt.

Definition at line 95 of file blockvector.cpp.

Member Data Documentation

const int* mfem::BlockVector::blockOffsets

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.

Vector* mfem::BlockVector::blocks

protected

array of Vector objects used to extract blocks without allocating memory.

This array is owned.

Definition at line 45 of file blockvector.hpp.

int mfem::BlockVector::numBlocks

protected

Number of blocks in the blockVector.

Definition at line 35 of file blockvector.hpp.

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

linalg/blockvector.hpp
linalg/blockvector.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation