Vector< T, Allocator > Class Template Reference

Distributed vector. More...

#include <Vector.h>

Public Types
using	value_type = T
	The value type.
using	allocator_type = Allocator
	The allocator type.

Public Member Functions
	Vector (const std::shared_ptr< const common::IndexMap > &map, int bs, const Allocator &alloc=Allocator())
	Create a distributed vector.
	Vector (const Vector &x)
	Copy constructor.
	Vector (Vector &&x)
	Move constructor.
	~Vector ()
	Destructor.
Vector &	operator= (const Vector &x)=delete
Vector &	operator= (Vector &&x)=default
	Move Assignment operator.
void	set (T v)
	Set all entries (including ghosts) More...
void	scatter_fwd_begin ()
	Begin scatter of local data from owner to ghosts on other ranks. More...
void	scatter_fwd_end ()
	End scatter of local data from owner to ghosts on other ranks. More...
void	scatter_fwd ()
	Scatter local data to ghost positions on other ranks. More...
void	scatter_rev_begin ()
	Start scatter of ghost data to owner. More...
void	scatter_rev_end (common::IndexMap::Mode op)
	End scatter of ghost data to owner. This process may receive data from more than one process, and the received data can be summed or inserted into the local portion of the vector. More...
void	scatter_rev (dolfinx::common::IndexMap::Mode op)
	Scatter ghost data to owner. This process may receive data from more than one process, and the received data can be summed or inserted into the local portion of the vector. More...
double	norm (Norm type=Norm::l2) const
	Compute the norm of the vector. More...
double	squared_norm () const
	Compute the squared L2 norm of vector. More...
std::shared_ptr< const common::IndexMap >	map () const
	Get IndexMap.
constexpr int	bs () const
	Get block size.
xtl::span< const T >	array () const
	Get local part of the vector (const version)
xtl::span< T >	mutable_array ()
	Get local part of the vector.
constexpr allocator_type	allocator () const
	Get the allocator associated with the container.

Detailed Description

template<typename T, class Allocator = std::allocator<T>>
class dolfinx::la::Vector< T, Allocator >

Distributed vector.

Member Function Documentation

norm()

double norm ( Norm  type = Norm::l2 ) const

inline

Compute the norm of the vector.

Note

Collective MPI operation

Parameters

type	Norm type (supported types are \(L^2\) and \(L^\infty\))

scatter_fwd()

void scatter_fwd ( )

inline

Scatter local data to ghost positions on other ranks.

Note

Collective MPI operation

scatter_fwd_begin()

void scatter_fwd_begin ( )

inline

Begin scatter of local data from owner to ghosts on other ranks.

Note

Collective MPI operation

scatter_fwd_end()

void scatter_fwd_end ( )

inline

End scatter of local data from owner to ghosts on other ranks.

Note

Collective MPI operation

scatter_rev()

void scatter_rev ( dolfinx::common::IndexMap::Mode  op )

inline

Scatter ghost data to owner. This process may receive data from more than one process, and the received data can be summed or inserted into the local portion of the vector.

Parameters

op	IndexMap operation (add or insert)

Note

Collective MPI operation

scatter_rev_begin()

void scatter_rev_begin ( )

inline

Start scatter of ghost data to owner.

Note

Collective MPI operation

scatter_rev_end()

void scatter_rev_end ( common::IndexMap::Mode  op )

inline

End scatter of ghost data to owner. This process may receive data from more than one process, and the received data can be summed or inserted into the local portion of the vector.

Parameters

op	The operation to perform when adding/setting received values (add or insert)

Note

Collective MPI operation

set()

void set ( T  v )

inline

Set all entries (including ghosts)

Parameters

[in]

v

The value to set all entries to (on calling rank)

squared_norm()

double squared_norm ( ) const

inline

Compute the squared L2 norm of vector.

Note

Collective MPI operation

---

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

• /__w/dolfinx/dolfinx/cpp/dolfinx/la/Vector.h