A class which defines a vector distributed across 1D MPI grid. More...

#include <parVector.hpp>

Public Member Functions
	parVector (MPI_Comm ncomm, S lbound, S ubound)
	A constructor of `parVector`. More...

	parVector (parVectorMap< S > map)
	A constructor of `parVectorMap`. More...

	~parVector ()
	A destructor.

parVectorMap< S >	GetVecMap ()
	Return parVector::index_map.

S	GetLowerBound ()
	Return the lower_bound on each MPI proc.

S	GetUpperBound ()
	Return the upper_bound on each MPI proc.

S	GetGlobalSize ()
	Return parVector<S>::global_size.

S	GetLocalSize ()
	Return parVector<S>::local_size.

S	GetRank ()
	Return parVector<S>::MyPID.

T	GetUpperNeighbor (S offset)
	For each MPI of rank `i`, get a value from the local vector stored on rank `i-1`. More...

T	GetLowerNeighbor (S offset)
	For each MPI of rank `i`, get a value from the local vector stored on rank `i+1`. More...

T	GetValue (S index)
	Get a value of vector with a given global index. More...

T	GetValueLocal (S lindex)
	Get a value of vector with a given local index on each MPI proc. More...

T *	GetArray ()
	Get the pointer `*array` which stores the local piece of vector on each MPI proc.

MPI_Comm	GetComm ()
	Get working MPI communicator.

S	Loc2Glob (S local_index)
	Convert a index of local vector on each MPI proc into its index in the global distributed vector. More...

S	Glob2Loc (S global_index)
	Convert a index of global vector into its index in the local vector on each MPI proc. More...

void	SetToValue (T value)
	Set all the entries of a vector to a same value. More...

void	SetToZero ()
	Set all the entries of a vector to zero.

void	SetValueLocal (S row, T value)
	Set a value on a local index of piece of distributed vector on each MPI proc. More...

void	SetValuesLocal (S nindex, S rows, T values)
	Set multiple values with multiple local indices of piece of distributed vector on each MPI proc. More...

void	SetValueGlobal (S index, T value)
	Set a value with a global index distributed vector. More...

void	SetValuesGlobal (S nindex, S rows, T values)
	Set multiple values with multiple global indices of distributed vector. More...

void	AddValueLocal (S row, T value)
	add a value onto the value with a given global index of distributed vector More...

void	AddValuesLocal (S nindex, S rows, T values)
	Add multiple values with multiple global indices onto the related values of distributed vector. More...

void	VecAdd (parVector v)
	Add with another vector. More...

void	VecScale (T scale)
	Scale all the elements of a vector with `scale`. More...

T	VecDot (parVector v)
	Compute the dot product with another vector `v`. More...

void	ReadExtVec (std::string spectrum)
	Read a vector from local text file. More...

void	writeToTxt (std::string file_name)
	Write a parVector in real scalar to a local file. More...

void	writeToTxtCmplx (std::string file_name)
	Write a parVector in complex scalar to a local file. More...

void	VecView ()
	Display the vector in a distributed manner.

Private Attributes
T *	array
	An array store the local piece of a global vector on each MPI proc.

S	local_size
	The number of elements of vector stored on each MPI proc.

S	global_size
	Global size of this distributed vector.

MPI_Comm	comm
	The working MPI Communicator.

parVectorMap< S >	index_map
	A parVectorMap object which shows the distribution scheme of a vector.

int	MyPID
	rank of each MPI procs within the working MPI communicator parVectorMap::comm

int	nProcs
	number of MPI procs within the working MPI communicator parVectorMap::comm

Detailed Description

template<typename T, typename S>
class parVector< T, S >

A class which defines a vector distributed across 1D MPI grid.

This class can be constructed with user-provided of index ranges `[lower_bound, upper_bound)` of vector on each MPI proc.
This class can be constructed with a distribution scheme by a given parVectorMap object.

Template Parameters

T	describes the scalar types of the entries of vector.
S	type of integer to describes the dimension of vector to be generated.

Constructor & Destructor Documentation

◆ parVector() [1/2]

template<typename T , typename S >

parVector< T, S >::parVector	(	MPI_Comm	ncomm,
		S	lbound,
		S	ubound
	)

A constructor of `parVector`.

Parameters

[in]	ncomm	the working MPI Communicator
[in]	lbound	the smallest index of a distributed vector on each MPI proc
[in]	ubound	`ubound-1 = ` the largest index of a distributed vector on each MPI proc

parVector::array is also allocated.

◆ parVector() [2/2]

template<typename T , typename S >

parVector< T, S >::parVector ( parVectorMap< S > map )

A constructor of `parVectorMap`.

Parameters

[in] map the distribution scheme determined by this object of type parVectorMap

parVector::array is also allocated.

Member Function Documentation

◆ AddValueLocal()

template<typename T , typename S >

void parVector< T, S >::AddValueLocal	(	S	row,
		T	value
	)

add a value onto the value with a given global index of distributed vector

Parameters

[in]	row	the global index
[in]	value	the scalar to be added

◆ AddValuesLocal()

template<typename T , typename S >

void parVector< T, S >::AddValuesLocal	(	S	nindex,
		S *	rows,
		T *	values
	)

Add multiple values with multiple global indices onto the related values of distributed vector.

Parameters

[in]	nindex	number of values to be set
[in]	rows	an pointer stores all the values to be set
[in]	values	an pointer stores all the indices to be set

◆ GetLowerNeighbor()

template<typename T , typename S >

T parVector< T, S >::GetLowerNeighbor ( S offset )

For each MPI of rank `i`, get a value from the local vector stored on rank `i+1`.

Parameters

[in] offset get the value from local vector on rank `i+1` with index `offset`.

Attention, for the MPI rank `nProcs-1`, the value is obtained from the MPI proc of rank `0`.

◆ GetUpperNeighbor()

template<typename T , typename S >

T parVector< T, S >::GetUpperNeighbor ( S offset )

For each MPI of rank `i`, get a value from the local vector stored on rank `i-1`.

Parameters

[in] offset get the value from local vector on rank `i-1` with index `upper_bound-1-offset`.

Attention, for the MPI rank `0`, the value is obtained from the MPI proc of rank `nProcs-1`.

◆ GetValue()

template<typename T , typename S >

T parVector< T, S >::GetValue ( S index )

inline

Get a value of vector with a given global index.

Parameters

[in] index the querying global index

Attention, this function is naturally distributed, so each MPI proc can only query the value within its range `[lower_bound, upper_bound)`.

◆ GetValueLocal()

template<typename T , typename S >

T parVector< T, S >::GetValueLocal ( S lindex )

inline

Get a value of vector with a given local index on each MPI proc.

Parameters

[in] lindex the querying local index

◆ Glob2Loc()

template<typename T , typename S >

S parVector< T, S >::Glob2Loc ( S global_index )

inline

Convert a index of global vector into its index in the local vector on each MPI proc.

Parameters

[in] global_index the index global vector to be converted

Attention, this function is in distributed manner, each MPI proc can only convert the global index of vector in the range `[lower_bound, upper_bound)`.

◆ Loc2Glob()

template<typename T , typename S >

S parVector< T, S >::Loc2Glob ( S local_index )

inline

Convert a index of local vector on each MPI proc into its index in the global distributed vector.

Parameters

[in] local_index the index local vector to be converted

Attention, this function is in distributed manner, each MPI proc can only convert the local index of vector stored on itself.

◆ ReadExtVec()

template<typename T , typename S >

void parVector< T, S >::ReadExtVec ( std::string spectrum )

Read a vector from local text file.

Parameters

[in] spectrum a `std::string` indicates the path+filename of local text file

◆ SetToValue()

template<typename T , typename S >

void parVector< T, S >::SetToValue ( T value )

Set all the entries of a vector to a same value.

Parameters

[in] value the value to be set

◆ SetValueGlobal()

template<typename T , typename S >

void parVector< T, S >::SetValueGlobal	(	S	index,
		T	value
	)

Set a value with a global index distributed vector.

Parameters

[in]	index	the global index
[in]	value	the scalar to be set

◆ SetValueLocal()

template<typename T , typename S >

void parVector< T, S >::SetValueLocal	(	S	row,
		T	value
	)

Set a value on a local index of piece of distributed vector on each MPI proc.

Parameters

[in]	row	the local index
[in]	value	the scalar to be set

◆ SetValuesGlobal()

template<typename T , typename S >

void parVector< T, S >::SetValuesGlobal	(	S	nindex,
		S *	rows,
		T *	values
	)

Set multiple values with multiple global indices of distributed vector.

Parameters

[in]	nindex	number of values to be set
[in]	rows	an pointer stores all the values to be set
[in]	values	an pointer stores all the indices to be set

◆ SetValuesLocal()

template<typename T , typename S >

void parVector< T, S >::SetValuesLocal	(	S	nindex,
		S *	rows,
		T *	values
	)

Set multiple values with multiple local indices of piece of distributed vector on each MPI proc.

Parameters

[in]	nindex	number of values to be set
[in]	rows	an pointer stores all the values to be set
[in]	values	an pointer stores all the indices to be set

◆ VecAdd()

template<typename T , typename S >

void parVector< T, S >::VecAdd ( parVector< T, S > v )

Add with another vector.

Parameters

[in] v the parVector object used to be added

◆ VecDot()

template<typename T , typename S >

T parVector< T, S >::VecDot ( parVector< T, S > v )

Compute the dot product with another vector `v`.

Parameters

[in] v the parVector object used to perform a dot product

Attention, the results of dot product is stored rebundantly across all MPI procs

◆ VecScale()

template<typename T , typename S >

void parVector< T, S >::VecScale ( T scale )

Scale all the elements of a vector with `scale`.

Parameters

[in] scale the value used for scaling on the vector

◆ writeToTxt()

template<typename T , typename S >

void parVector< T, S >::writeToTxt ( std::string file_name )

Write a parVector in real scalar to a local file.

Parameters

[in] file_name a `std::string` indicates the path+filename to write into

◆ writeToTxtCmplx()

template<typename T , typename S >

void parVector< T, S >::writeToTxtCmplx ( std::string file_name )

Write a parVector in complex scalar to a local file.

Parameters

[in] file_name a `std::string` indicates the path+filename to write into

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

include/parVector/parVector.hpp

Public Member Functions

Private Attributes

Detailed Description

template<typename T, typename S> class parVector< T, S >

Constructor & Destructor Documentation

◆ parVector() [1/2]

◆ parVector() [2/2]

Member Function Documentation

◆ AddValueLocal()

◆ AddValuesLocal()

◆ GetLowerNeighbor()

◆ GetUpperNeighbor()

◆ GetValue()

◆ GetValueLocal()

◆ Glob2Loc()

◆ Loc2Glob()

◆ ReadExtVec()

◆ SetToValue()

◆ SetValueGlobal()

◆ SetValueLocal()

◆ SetValuesGlobal()

◆ SetValuesLocal()

◆ VecAdd()

◆ VecDot()

◆ VecScale()

◆ writeToTxt()

◆ writeToTxtCmplx()

template<typename T, typename S>
class parVector< T, S >