ParticleVector carries vector data (of a given vector dimension) for an arbitrary number of particles. Data is stored contiguously in memory in an either byNODES (x0,x1,x2,...,xN,y0,y1,y2...yN,z0.....zN) or byVDIM (x0,y0,z0,...,xN,yN,zN) ordering, where N+1 is the number of particles. ParticleVector provides convenient methods for accessing and manipulating data for individual particles (e.g., GetValues) or components across all particles (e.g., GetComponents). More...

#include <particlevector.hpp>

Inheritance diagram for mfem::ParticleVector:

[legend]

Collaboration diagram for mfem::ParticleVector:

[legend]

Public Member Functions
	ParticleVector ()

	ParticleVector (int vdim_, Ordering::Type ordering_)

	ParticleVector (int vdim_, Ordering::Type ordering_, int num_particles)

	ParticleVector (int vdim_, Ordering::Type ordering_, const Vector &vec)

int	GetVDim () const
	Get the Vector dimension of the ParticleVector.

Ordering::Type	GetOrdering () const
	Get the ordering of data in the ParticleVector.

int	GetNumParticles () const
	Get the number of particle data in the ParticleVector.

void	GetValues (int i, Vector &nvals) const
	Get a copy of particle `i` 's data.

void	GetValuesRef (int i, Vector &nref)
	For `GetOrdering` == Ordering::byVDIM, set `nref` to refer to particle `i` 's data.

void	GetComponents (int vd, Vector &comp)
	Get a copy of component `vd` for all particle vector data.

void	GetComponentsRef (int vd, Vector &nref)
	For `GetOrdering` == Ordering::byNODES, set `nref` to refer to component `vd` 's data.

void	SetValues (int i, const Vector &nvals)
	Set particle `i` 's data to `nvals` .

void	SetComponents (int vd, const Vector &comp)
	Set component `vd` values for all particle data to `comp` .

real_t &	operator() (int i, int comp)
	Reference to particle `i` component `comp` value.

const real_t &	operator() (int i, int comp) const
	Const reference to particle `i` component `comp` value.

void	DeleteParticles (const Array< int > &indices)
	Remove particle data at `indices`.

void	DeleteParticle (const int index)
	Remove particle data at `index`.

void	SetVDim (int vdim_, bool keep_data=true)
	Set the vector dimension of the ParticleVector.

void	SetOrdering (Ordering::Type ordering_, bool keep_data=true)
	Set the ordering of the particle Vector data in ParticleVector.

void	SetNumParticles (int num_vectors, bool keep_data=true)
	Set the number of particle Vector data to be held by the ParticleVector, keeping existing data.

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.

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<typename CT , int N>
	Vector (const CT(&values)[N])
	Create a vector from a statically sized C-style array of convertible type.

template<typename CT , typename std::enable_if< std::is_convertible< CT, real_t >::value, bool >::type = true>
	Vector (std::initializer_list< CT > values)
	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	Reserve (int res)
	Update Capacity() to res (if less than current), keeping existing entries.

void	DeleteAt (const Array< int > &indices)

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 *v) const

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)
	(*this)[i + offset] = v[i]

void	AddSubVector (const Vector &v, int offset)
	(*this)[i + offset] += v[i]

void	Neg ()
	(this) = -(this)

void	Reciprocal ()
	(this)(i) = 1.0 / (this)(i)

void	Abs ()
	(this)(i) = abs((this)(i))

void	Pow (const real_t p)
	(this)(i) = pow((this)(i), p)

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	SetSubVectorHost (const Array< int > &dofs, const real_t value)
	Set the entries listed in dofs to the given value (always on host).

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 -aval 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	PrintMathematica (std::ostream &out=mfem::out) const
	Prints vector as a List for importing into Mathematica.

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

Protected Member Functions
void	GrowSize (int min_num_vectors, bool keep_data)
	Re-allocate + copy memory. See Array::GrowSize.

Protected Attributes
int	vdim
	Vector dimension.

Ordering::Type	ordering
	Ordering of Vector data in ParticleVector.

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

int	size

Detailed Description

ParticleVector carries vector data (of a given vector dimension) for an arbitrary number of particles. Data is stored contiguously in memory in an either byNODES (x0,x1,x2,...,xN,y0,y1,y2...yN,z0.....zN) or byVDIM (x0,y0,z0,...,xN,yN,zN) ordering, where N+1 is the number of particles. ParticleVector provides convenient methods for accessing and manipulating data for individual particles (e.g., GetValues) or components across all particles (e.g., GetComponents).

Note that, since ParticleVector inherits from Vector, all Vector operations (e.g., device support) are available. We do recommend use of the methods SetNumParticles and SetVDim for manipulating container size, instead of Vector::SetSize, to ensure consistency.

Definition at line 36 of file particlevector.hpp.

Constructor & Destructor Documentation

◆ ParticleVector() [1/4]

mfem::ParticleVector::ParticleVector ( )

inline

Definition at line 54 of file particlevector.hpp.

◆ ParticleVector() [2/4]

mfem::ParticleVector::ParticleVector	(	int	vdim_,
		Ordering::Type	ordering_ )

Initialize an empty ParticleVector of vdim vdim_ with ordering ordering_.

Definition at line 27 of file particlevector.cpp.

◆ ParticleVector() [3/4]

mfem::ParticleVector::ParticleVector	(	int	vdim_,
		Ordering::Type	ordering_,
		int	num_particles )

Initialize a ParticleVector with num_particles vectors each of size vdim_ ordered ordering_.

Definition at line 30 of file particlevector.cpp.

◆ ParticleVector() [4/4]

mfem::ParticleVector::ParticleVector	(	int	vdim_,
		Ordering::Type	ordering_,
		const Vector &	vec )

Initialize a ParticleVector of vdim vdim_ with ordering ordering_ , initialized with copy of data in vec .

Definition at line 37 of file particlevector.cpp.

Member Function Documentation

◆ DeleteParticle()

void mfem::ParticleVector::DeleteParticle ( const int index )

inline

Remove particle data at index.

The ParticleVector is resized appropriately, with existing data maintained.

Definition at line 122 of file particlevector.hpp.

◆ DeleteParticles()

void mfem::ParticleVector::DeleteParticles ( const Array< int > & indices )

Remove particle data at indices.

The ParticleVector is resized appropriately, with existing data maintained.

Definition at line 176 of file particlevector.cpp.

◆ GetComponents()

void mfem::ParticleVector::GetComponents	(	int	vd,
		Vector &	comp )

Get a copy of component vd for all particle vector data.

Definition at line 74 of file particlevector.cpp.

◆ GetComponentsRef()

void mfem::ParticleVector::GetComponentsRef	(	int	vd,
		Vector &	nref )

For GetOrdering == Ordering::byNODES, set nref to refer to component vd 's data.

Warning: This method only works when ordering is Ordering::byNODES, where an individual component of all particle data is stored contiguously in memory.

Definition at line 93 of file particlevector.cpp.

◆ GetNumParticles()

int mfem::ParticleVector::GetNumParticles ( ) const

inline

Get the number of particle data in the ParticleVector.

Definition at line 75 of file particlevector.hpp.

◆ GetOrdering()

Ordering::Type mfem::ParticleVector::GetOrdering ( ) const

inline

Get the ordering of data in the ParticleVector.

Definition at line 72 of file particlevector.hpp.

◆ GetValues()

void mfem::ParticleVector::GetValues	(	int	i,
		Vector &	nvals ) const

Get a copy of particle i 's data.

Definition at line 45 of file particlevector.cpp.

◆ GetValuesRef()

void mfem::ParticleVector::GetValuesRef	(	int	i,
		Vector &	nref )

For GetOrdering == Ordering::byVDIM, set nref to refer to particle i 's data.

Warning: This method only works when ordering is Ordering::byVDIM, where an individual particle's data is stored contiguously in memory.

Definition at line 66 of file particlevector.cpp.

◆ GetVDim()

int mfem::ParticleVector::GetVDim ( ) const

inline

Get the Vector dimension of the ParticleVector.

Definition at line 69 of file particlevector.hpp.

◆ GrowSize()

void mfem::ParticleVector::GrowSize	(	int	min_num_vectors,
		bool	keep_data )

protected

Re-allocate + copy memory. See Array::GrowSize.

Definition at line 17 of file particlevector.cpp.

◆ operator()() [1/2]

real_t & mfem::ParticleVector::operator()	(	int	i,
		int	comp )

Reference to particle i component comp value.

Definition at line 138 of file particlevector.cpp.

◆ operator()() [2/2]

const real_t & mfem::ParticleVector::operator()	(	int	i,
		int	comp ) const

Const reference to particle i component comp value.

Definition at line 157 of file particlevector.cpp.

◆ operator=() [1/4]

Vector & mfem::Vector::operator= ( const real_t * v )

Copy Size() entries from v.

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

◆ operator=() [3/4]

Vector & mfem::Vector::operator= ( real_t value )

Redefine '=' for vector = constant.

Definition at line 333 of file vector.cpp.

◆ operator=() [4/4]

Vector & mfem::Vector::operator= ( Vector && v )

Move assignment.

Definition at line 330 of file vector.cpp.

◆ SetComponents()

void mfem::ParticleVector::SetComponents	(	int	vd,
		const Vector &	comp )

Set component vd values for all particle data to comp .

Definition at line 119 of file particlevector.cpp.

◆ SetNumParticles()

void mfem::ParticleVector::SetNumParticles	(	int	num_vectors,
		bool	keep_data = true )

Set the number of particle Vector data to be held by the ParticleVector, keeping existing data.

If keep_data is true, existing particle data in the ParticleVector is maintained with an ordering-mindful resize. If num_vectors * GetVDim > Vector::Capacity , memory is re-allocated.

Definition at line 250 of file particlevector.cpp.

◆ SetOrdering()

void mfem::ParticleVector::SetOrdering	(	Ordering::Type	ordering_,
		bool	keep_data = true )

Set the ordering of the particle Vector data in ParticleVector.

If keep_data is true, existing particle data in the ParticleVector is reordered to ordering_ .

Definition at line 241 of file particlevector.cpp.

◆ SetValues()

void mfem::ParticleVector::SetValues	(	int	i,
		const Vector &	nvals )

Set particle i 's data to nvals .

Definition at line 100 of file particlevector.cpp.

◆ SetVDim()

void mfem::ParticleVector::SetVDim	(	int	vdim_,
		bool	keep_data = true )

Set the vector dimension of the ParticleVector.

If keep_data is true, existing particle data in the ParticleVector is maintained with an updated vector dimension vdim_ .

Definition at line 215 of file particlevector.cpp.

Member Data Documentation

◆ ordering

Ordering::Type mfem::ParticleVector::ordering

protected

Ordering of Vector data in ParticleVector.

Definition at line 44 of file particlevector.hpp.

◆ vdim

int mfem::ParticleVector::vdim

protected

Vector dimension.

Definition at line 41 of file particlevector.hpp.

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

linalg/particlevector.hpp
linalg/particlevector.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParticleVector() [1/4]

◆ ParticleVector() [2/4]

◆ ParticleVector() [3/4]

◆ ParticleVector() [4/4]

Member Function Documentation

◆ DeleteParticle()

◆ DeleteParticles()

◆ GetComponents()

◆ GetComponentsRef()

◆ GetNumParticles()

◆ GetOrdering()

◆ GetValues()

◆ GetValuesRef()

◆ GetVDim()

◆ GrowSize()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ SetComponents()

◆ SetNumParticles()

◆ SetOrdering()

◆ SetValues()

◆ SetVDim()

Member Data Documentation

◆ ordering

◆ vdim