dolfin::TpetraVector Class Reference

#include <TpetraVector.h>

Inheritance diagram for dolfin::TpetraVector:

Collaboration diagram for dolfin::TpetraVector:

Public Types
typedef Tpetra::MultiVector ::node_type	node_type
	Node type.
typedef Tpetra::Map< int, dolfin::la_index, node_type >	map_type
	TpetraVector map type (local index, global index)
typedef Tpetra::MultiVector< double, int, dolfin::la_index, node_type >	vector_type
	TpetraVector vector type (scalar, local index, global index, node)

Public Member Functions
	TpetraVector (MPI_Comm comm=MPI_COMM_WORLD)
	Create empty vector.
	TpetraVector (MPI_Comm comm, std::size_t N)
	Create vector of size N.
	TpetraVector (const TpetraVector &x)
	Copy constructor.
virtual	~TpetraVector ()
	Create vector wrapper of Tpetra Vec pointer. More...
virtual void	zero ()
	Set all entries to zero and keep any sparse structure. More...
virtual void	apply (std::string mode)
	Finalize assembly of tensor. More...
virtual MPI_Comm	mpi_comm () const
	Return MPI communicator. More...
virtual std::string	str (bool verbose) const
	Return informal string representation (pretty-print) More...
virtual std::shared_ptr< GenericVector >	copy () const
	Return copy of vector. More...
virtual void	init (std::size_t N)
	Initialize vector to global size N. More...
virtual void	init (std::pair< std::size_t, std::size_t > range)
	Initialize vector with given ownership range. More...
virtual void	init (std::pair< std::size_t, std::size_t > range, const std::vector< std::size_t > &local_to_global_map, const std::vector< la_index > &ghost_indices)
virtual bool	empty () const
	Return true if vector is empty. More...
virtual std::size_t	size () const
	Return size of vector. More...
virtual std::size_t	local_size () const
	Return local size of vector. More...
virtual std::pair< std::int64_t, std::int64_t >	local_range () const
	Return ownership range of a vector. More...
virtual bool	owns_index (std::size_t i) const
	Determine whether global vector index is owned by this process. More...
virtual void	get (double *block, std::size_t m, const dolfin::la_index *rows) const
virtual void	get_local (double *block, std::size_t m, const dolfin::la_index *rows) const
	Get block of values using local indices. More...
virtual void	set (const double *block, std::size_t m, const dolfin::la_index *rows)
	Set block of values using global indices. More...
virtual void	set_local (const double *block, std::size_t m, const dolfin::la_index *rows)
	Set block of values using local indices. More...
virtual void	add (const double *block, std::size_t m, const dolfin::la_index *rows)
	Add block of values using global indices. More...
virtual void	add_local (const double *block, std::size_t m, const dolfin::la_index *rows)
	Add block of values using local indices. More...
virtual void	get_local (std::vector< double > &values) const
	Get all values on local process. More...
virtual void	set_local (const std::vector< double > &values)
	Set all values on local process. More...
virtual void	add_local (const Array< double > &values)
	Add values to each entry on local process. More...
virtual void	gather (GenericVector &y, const std::vector< dolfin::la_index > &indices) const
virtual void	gather (std::vector< double > &x, const std::vector< dolfin::la_index > &indices) const
virtual void	gather_on_zero (std::vector< double > &x) const
virtual void	axpy (double a, const GenericVector &x)
	Add multiple of given vector (AXPY operation) More...
virtual void	abs ()
	Replace all entries in the vector by their absolute values. More...
virtual double	inner (const GenericVector &v) const
	Return inner product with given vector. More...
virtual double	norm (std::string norm_type) const
	Return norm of vector. More...
virtual double	min () const
	Return minimum value of vector. More...
virtual double	max () const
	Return maximum value of vector. More...
virtual double	sum () const
	Return sum of values of vector. More...
virtual double	sum (const Array< std::size_t > &rows) const
	Return sum of selected rows in vector. More...
virtual const TpetraVector &	operator*= (double a)
	Multiply vector by given number. More...
virtual const TpetraVector &	operator*= (const GenericVector &x)
	Multiply vector by another vector pointwise. More...
virtual const TpetraVector &	operator/= (double a)
	Divide vector by given number. More...
virtual const TpetraVector &	operator+= (const GenericVector &x)
	Add given vector. More...
virtual const TpetraVector &	operator+= (double a)
	Add number to all components of a vector. More...
virtual const TpetraVector &	operator-= (const GenericVector &x)
	Subtract given vector. More...
virtual const TpetraVector &	operator-= (double a)
	Subtract number from all components of a vector. More...
virtual const GenericVector &	operator= (const GenericVector &x)
	Assignment operator. More...
virtual const TpetraVector &	operator= (double a)
	Assignment operator. More...
virtual void	update_ghost_values ()
	Update ghost values in vector.
virtual GenericLinearAlgebraFactory &	factory () const
	Return linear algebra backend factory. More...
Teuchos::RCP< vector_type >	vec () const
	Return pointer to Tpetra vector object.
const TpetraVector &	operator= (const TpetraVector &x)
	Assignment operator.
void	mapdump (const std::string desc)
	Dump x.map and ghost_map for debugging.
virtual void	init (const TensorLayout &tensor_layout)
virtual void	init (std::size_t N)=0
	Initialize vector to global size N. More...
virtual void	init (std::pair< std::size_t, std::size_t > range)=0
	Initialize vector with given local ownership range. More...
virtual void	init (std::pair< std::size_t, std::size_t > range, const std::vector< std::size_t > &local_to_global_map, const std::vector< la_index > &ghost_indices)=0
Public Member Functions inherited from dolfin::GenericVector
virtual	~GenericVector ()
	Destructor.
virtual void	init (const TensorLayout &tensor_layout)
virtual std::size_t	rank () const
	Return tensor rank (number of dimensions) More...
virtual std::size_t	size (std::size_t dim) const
	Return size of given dimension. More...
virtual std::pair< std::int64_t, std::int64_t >	local_range (std::size_t dim) const
	Return local ownership range. More...
virtual void	get (double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows) const
	Get block of values using global indices. More...
virtual void	get_local (double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows) const
	Get block of values using local indices.
virtual void	set (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
	Set block of values using global indices. More...
virtual void	set_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
	Set block of values using local indices. More...
virtual void	add (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
	Add block of values using global indices. More...
virtual void	add_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
	Add block of values using local indices. More...
virtual void	add (const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)
	Add block of values using global indices. More...
virtual void	add_local (const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)
	Add block of values using local indices. More...
virtual void	zero ()=0
	Set all entries to zero and keep any sparse structure. More...
virtual void	apply (std::string mode)=0
	Finalize assembly of tensor. More...
virtual std::string	str (bool verbose) const =0
	Return informal string representation (pretty-print) More...
virtual std::shared_ptr< GenericVector >	copy () const =0
	Return copy of vector. More...
virtual void	init (std::size_t N)=0
	Initialize vector to global size N. More...
virtual void	init (std::pair< std::size_t, std::size_t > range)=0
	Initialize vector with given local ownership range. More...
virtual void	init (std::pair< std::size_t, std::size_t > range, const std::vector< std::size_t > &local_to_global_map, const std::vector< la_index > &ghost_indices)=0
virtual std::size_t	size () const =0
	Return global size of vector. More...
virtual std::size_t	local_size () const =0
	Return local size of vector. More...
virtual std::pair< std::int64_t, std::int64_t >	local_range () const =0
	Return local ownership range of a vector. More...
virtual bool	owns_index (std::size_t i) const =0
	Determine whether global vector index is owned by this process. More...
virtual void	get (double *block, std::size_t m, const dolfin::la_index *rows) const =0
virtual void	get_local (double *block, std::size_t m, const dolfin::la_index *rows) const =0
virtual void	set (const double *block, std::size_t m, const dolfin::la_index *rows)=0
	Set block of values using global indices. More...
virtual void	set_local (const double *block, std::size_t m, const dolfin::la_index *rows)=0
	Set block of values using local indices. More...
virtual void	add (const double *block, std::size_t m, const dolfin::la_index *rows)=0
	Add block of values using global indices. More...
virtual void	add_local (const double *block, std::size_t m, const dolfin::la_index *rows)=0
	Add block of values using local indices. More...
virtual void	get_local (std::vector< double > &values) const =0
	Get all values on local process. More...
virtual void	set_local (const std::vector< double > &values)=0
	Set all values on local process. More...
virtual void	add_local (const Array< double > &values)=0
	Add values to each entry on local process. More...
virtual void	gather (GenericVector &x, const std::vector< dolfin::la_index > &indices) const =0
virtual void	gather (std::vector< double > &x, const std::vector< dolfin::la_index > &indices) const =0
	Gather entries (given by global indices) into x. More...
virtual void	gather_on_zero (std::vector< double > &x) const =0
	Gather all entries into x on process 0. More...
virtual void	axpy (double a, const GenericVector &x)=0
	Add multiple of given vector (AXPY operation) More...
virtual void	abs ()=0
	Replace all entries in the vector by their absolute values. More...
virtual double	inner (const GenericVector &x) const =0
	Return inner product with given vector. More...
virtual double	norm (std::string norm_type) const =0
	Return norm of vector. More...
virtual double	min () const =0
	Return minimum value of vector. More...
virtual double	max () const =0
	Return maximum value of vector. More...
virtual double	sum () const =0
	Return sum of vector. More...
virtual double	sum (const Array< std::size_t > &rows) const =0
std::shared_ptr< GenericVector >	operator+ (const GenericVector &x)
	Sum two vectors (returns a new vector)
std::shared_ptr< GenericVector >	operator+ (double a)
	Add scalar to a vector (returns a new vector)
std::shared_ptr< GenericVector >	operator* (double a)
	Multiply vector by a scalar (returns a new vector)
virtual const GenericVector &	operator*= (double a)=0
	Multiply vector by given number. More...
virtual const GenericVector &	operator*= (const GenericVector &x)=0
	Multiply vector by another vector pointwise. More...
virtual const GenericVector &	operator/= (double a)=0
	Divide vector by given number. More...
virtual const GenericVector &	operator+= (const GenericVector &x)=0
	Add given vector. More...
virtual const GenericVector &	operator+= (double a)=0
	Add number to all components of a vector. More...
virtual const GenericVector &	operator-= (const GenericVector &x)=0
	Subtract given vector. More...
virtual const GenericVector &	operator-= (double a)=0
	Subtract number from all components of a vector. More...
virtual const GenericVector &	operator= (const GenericVector &x)=0
	Assignment operator. More...
virtual const GenericVector &	operator= (double a)=0
	Assignment operator. More...
virtual double	operator[] (dolfin::la_index i) const
	Get value of given entry. More...
virtual double	getitem (dolfin::la_index i) const
	Get value of given entry.
virtual void	setitem (dolfin::la_index i, double value)
Public Member Functions inherited from dolfin::GenericTensor
virtual	~GenericTensor ()
	Destructor.
virtual void	init (const TensorLayout &tensor_layout)=0
	Initialize zero tensor using tensor layout. More...
virtual bool	empty () const =0
	Return true if empty. More...
virtual std::size_t	rank () const =0
	Return tensor rank (number of dimensions) More...
virtual std::size_t	size (std::size_t dim) const =0
	Return size of given dimension. More...
virtual std::pair< std::int64_t, std::int64_t >	local_range (std::size_t dim) const =0
	Return local ownership range. More...
virtual void	get (double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows) const =0
	Get block of values. More...
virtual void	set (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)=0
	Set block of values using global indices. More...
virtual void	set_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)=0
	Set block of values using local indices. More...
virtual void	add (const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)=0
	Add block of values using global indices. More...
virtual void	add_local (const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)=0
	Add block of values using local indices. More...
virtual void	add (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)=0
	Add block of values using global indices. More...
virtual void	add_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)=0
	Add block of values using local indices. More...
virtual void	zero ()=0
	Set all entries to zero and keep any sparse structure. More...
virtual void	apply (std::string mode)=0
	Finalize assembly of tensor. More...
virtual std::string	str (bool verbose) const =0
	Return MPI communicator. More...
virtual GenericLinearAlgebraFactory &	factory () const =0
	Return linear algebra backend factory. More...
Public Member Functions inherited from dolfin::LinearAlgebraObject
virtual const LinearAlgebraObject *	instance () const
	Return concrete instance / unwrap (const version) More...
virtual LinearAlgebraObject *	instance ()
	Return concrete instance / unwrap (non-const version) More...
virtual std::shared_ptr< const LinearAlgebraObject >	shared_instance () const
	Return concrete shared ptr instance / unwrap (const version) More...
virtual std::shared_ptr< LinearAlgebraObject >	shared_instance ()
	Return concrete shared ptr instance / unwrap (non-const version) More...
virtual MPI_Comm	mpi_comm () const =0
	Return MPI communicator. More...
Public Member Functions inherited from dolfin::Variable
	Variable ()
	Create unnamed variable.
	Variable (const std::string name, const std::string label)
	Create variable with given name and label.
	Variable (const Variable &variable)
	Copy constructor.
virtual	~Variable ()
	Destructor.
const Variable &	operator= (const Variable &variable)
	Assignment operator.
void	rename (const std::string name, const std::string label)
	Rename variable.
std::string	name () const
	Return name.
std::string	label () const
	Return label (description)
std::size_t	id () const
virtual std::string	str (bool verbose) const
	Return informal string representation (pretty-print) More...

Static Public Member Functions
static void	mapdump (Teuchos::RCP< const map_type > xmap, const std::string desc)
	output map for debugging

Friends
class	TpetraMatrix

Additional Inherited Members
Public Attributes inherited from dolfin::Variable
Parameters	parameters
	Parameters.

Detailed Description

This class provides a simple vector class based on Tpetra. It is a wrapper for Teuchos::RCP<Tpetra::MultiVector> implementing the GenericVector interface.

The interface is intentionally simple. For advanced usage, access the Teuchos::RCP<Tpetra::MultiVector> using the function vec() and use the standard Tpetra interface.

Constructor & Destructor Documentation

~TpetraVector()

TpetraVector::~TpetraVector ( )

virtual

Create vector wrapper of Tpetra Vec pointer.

Destructor

Member Function Documentation

abs()

void TpetraVector::abs ( )

virtual

Replace all entries in the vector by their absolute values.

Implements dolfin::GenericVector.

add()

void TpetraVector::add ( const double *  block, std::size_t  m, const dolfin::la_index *  rows  )

virtual

Add block of values using global indices.

Implements dolfin::GenericVector.

add_local() [1/2]

void TpetraVector::add_local ( const Array< double > &  values )

virtual

Add values to each entry on local process.

Implements dolfin::GenericVector.

add_local() [2/2]

void TpetraVector::add_local ( const double *  block, std::size_t  m, const dolfin::la_index *  rows  )

virtual

Add block of values using local indices.

Implements dolfin::GenericVector.

apply()

void TpetraVector::apply ( std::string  mode )

virtual

Finalize assembly of tensor.

Implements dolfin::GenericVector.

axpy()

void TpetraVector::axpy ( double  a, const GenericVector &  x  )

virtual

Add multiple of given vector (AXPY operation)

Implements dolfin::GenericVector.

copy()

std::shared_ptr< GenericVector > TpetraVector::copy ( ) const

virtual

Return copy of vector.

Implements dolfin::GenericVector.

empty()

bool TpetraVector::empty ( ) const

virtual

Return true if vector is empty.

Implements dolfin::GenericTensor.

factory()

GenericLinearAlgebraFactory & TpetraVector::factory ( ) const

virtual

Return linear algebra backend factory.

Implements dolfin::GenericTensor.

gather() [1/2]

void TpetraVector::gather ( GenericVector &  y, const std::vector< dolfin::la_index > &  indices  ) const

virtual

Gather entries (given by global indices) into local (MPI_COMM_SELF) vector x. Provided x must be empty or of correct dimension (same as provided indices). This operation is collective

Implements dolfin::GenericVector.

gather() [2/2]

void TpetraVector::gather ( std::vector< double > &  x, const std::vector< dolfin::la_index > &  indices  ) const

virtual

Gather entries (given by global indices) into x. This operation is collective

Implements dolfin::GenericVector.

gather_on_zero()

void TpetraVector::gather_on_zero ( std::vector< double > &  x ) const

virtual

Gather all entries into x on process 0. This operation is collective

Implements dolfin::GenericVector.

get()

void TpetraVector::get ( double *  block, std::size_t  m, const dolfin::la_index *  rows  ) const

virtual

Get block of values using global indices (all values must be owned by local process, ghosts cannot be accessed)

Implements dolfin::GenericVector.

get_local() [1/2]

void TpetraVector::get_local ( double *  block, std::size_t  m, const dolfin::la_index *  rows  ) const

virtual

Get block of values using local indices.

Implements dolfin::GenericVector.

get_local() [2/2]

void TpetraVector::get_local ( std::vector< double > &  values ) const

virtual

Get all values on local process.

Implements dolfin::GenericVector.

init() [1/7]

virtual void dolfin::GenericVector::init ( const TensorLayout &  tensor_layout )

inlinevirtual

Initialize zero tensor using sparsity pattern FIXME: This needs to be implemented on backend side! Remove it!

Reimplemented from dolfin::GenericVector.

init() [2/7]

void TpetraVector::init ( std::pair< std::size_t, std::size_t >  range )

virtual

Initialize vector with given ownership range.

Implements dolfin::GenericVector.

init() [3/7]

virtual void dolfin::GenericVector::init ( std::pair< std::size_t, std::size_t >  range )

virtual

Initialize vector with given local ownership range.

Implements dolfin::GenericVector.

init() [4/7]

void TpetraVector::init ( std::pair< std::size_t, std::size_t >  range, const std::vector< std::size_t > &  local_to_global_map, const std::vector< la_index > &  ghost_indices  )

virtual

Initialize vector with given ownership range and with ghost values

Implements dolfin::GenericVector.

init() [5/7]

virtual void dolfin::GenericVector::init ( std::pair< std::size_t, std::size_t >  range, const std::vector< std::size_t > &  local_to_global_map, const std::vector< la_index > &  ghost_indices  )

virtual

Initialise vector with given ownership range and with ghost values FIXME: Reimplement using init(const TensorLayout&) and deprecate

Implements dolfin::GenericVector.

init() [6/7]

void TpetraVector::init ( std::size_t  N )

virtual

Initialize vector to global size N.

Implements dolfin::GenericVector.

init() [7/7]

virtual void dolfin::GenericVector::init ( std::size_t  N )

virtual

Initialize vector to global size N.

Implements dolfin::GenericVector.

inner()

double TpetraVector::inner ( const GenericVector &  v ) const

virtual

Return inner product with given vector.

Implements dolfin::GenericVector.

local_range()

std::pair< std::int64_t, std::int64_t > TpetraVector::local_range ( ) const

virtual

Return ownership range of a vector.

Implements dolfin::GenericVector.

local_size()

std::size_t TpetraVector::local_size ( ) const

virtual

Return local size of vector.

Implements dolfin::GenericVector.

max()

double TpetraVector::max ( ) const

virtual

Return maximum value of vector.

Implements dolfin::GenericVector.

min()

double TpetraVector::min ( ) const

virtual

Return minimum value of vector.

Implements dolfin::GenericVector.

mpi_comm()

MPI_Comm TpetraVector::mpi_comm ( ) const

virtual

Return MPI communicator.

Implements dolfin::LinearAlgebraObject.

norm()

double TpetraVector::norm ( std::string  norm_type ) const

virtual

Return norm of vector.

Implements dolfin::GenericVector.

operator*=() [1/2]

const TpetraVector & TpetraVector::operator*= ( const GenericVector &  x )

virtual

Multiply vector by another vector pointwise.

Implements dolfin::GenericVector.

operator*=() [2/2]

const TpetraVector & TpetraVector::operator*= ( double  a )

virtual

Multiply vector by given number.

Implements dolfin::GenericVector.

operator+=() [1/2]

const TpetraVector & TpetraVector::operator+= ( const GenericVector &  x )

virtual

Add given vector.

Implements dolfin::GenericVector.

operator+=() [2/2]

const TpetraVector & TpetraVector::operator+= ( double  a )

virtual

Add number to all components of a vector.

Implements dolfin::GenericVector.

operator-=() [1/2]

const TpetraVector & TpetraVector::operator-= ( const GenericVector &  x )

virtual

Subtract given vector.

Implements dolfin::GenericVector.

operator-=() [2/2]

const TpetraVector & TpetraVector::operator-= ( double  a )

virtual

Subtract number from all components of a vector.

Implements dolfin::GenericVector.

operator/=()

const TpetraVector & TpetraVector::operator/= ( double  a )

virtual

Divide vector by given number.

Implements dolfin::GenericVector.

operator=() [1/2]

const GenericVector & TpetraVector::operator= ( const GenericVector &  x )

virtual

Assignment operator.

Implements dolfin::GenericVector.

operator=() [2/2]

const TpetraVector & TpetraVector::operator= ( double  a )

virtual

Assignment operator.

Implements dolfin::GenericVector.

owns_index()

bool TpetraVector::owns_index ( std::size_t  i ) const

virtual

Determine whether global vector index is owned by this process.

Implements dolfin::GenericVector.

set()

void TpetraVector::set ( const double *  block, std::size_t  m, const dolfin::la_index *  rows  )

virtual

Set block of values using global indices.

Implements dolfin::GenericVector.

set_local() [1/2]

void TpetraVector::set_local ( const double *  block, std::size_t  m, const dolfin::la_index *  rows  )

virtual

Set block of values using local indices.

Implements dolfin::GenericVector.

set_local() [2/2]

void TpetraVector::set_local ( const std::vector< double > &  values )

virtual

Set all values on local process.

Implements dolfin::GenericVector.

size()

std::size_t TpetraVector::size ( ) const

virtual

Return size of vector.

Implements dolfin::GenericVector.

str()

std::string TpetraVector::str ( bool  verbose ) const

virtual

Return informal string representation (pretty-print)

Implements dolfin::GenericVector.

sum() [1/2]

double TpetraVector::sum ( ) const

virtual

Return sum of values of vector.

Implements dolfin::GenericVector.

sum() [2/2]

double TpetraVector::sum ( const Array< std::size_t > &  rows ) const

virtual

Return sum of selected rows in vector.

Implements dolfin::GenericVector.

zero()

void TpetraVector::zero ( )

virtual

Set all entries to zero and keep any sparse structure.

Implements dolfin::GenericVector.

---

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

• /build/dolfin-3KW1Y9/dolfin-2019.2.0~git20230116.bd54183/dolfin/la/TpetraVector.h
• /build/dolfin-3KW1Y9/dolfin-2019.2.0~git20230116.bd54183/dolfin/la/TpetraVector.cpp