#include <Vector.h>

Inheritance diagram for dolfin::Vector:

[legend]

Collaboration diagram for dolfin::Vector:

[legend]

Public Member Functions
	Vector ()
	Create empty vector.

	Vector (MPI_Comm comm)
	Create empty vector.

	Vector (MPI_Comm comm, std::size_t N)
	Create vector of size N.

	Vector (const Vector &x)
	Copy constructor.

	Vector (const GenericVector &x)
	Create a Vector from a GenericVector.

virtual std::shared_ptr< GenericVector >	copy () const
	Return copy of vector.

virtual void	zero ()
	Set all entries to zero and keep any sparse structure.

virtual void	apply (std::string mode)
	Finalize assembly of tensor.

virtual MPI_Comm	mpi_comm () const
	Return MPI communicator.

virtual std::string	str (bool verbose) const
	Return informal string representation (pretty-print)

virtual void	init (std::size_t N)
	Initialize vector to size N.

virtual void	init (std::pair< std::size_t, std::size_t > range)
	Initialize vector with given ownership range.

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.

virtual std::size_t	size () const
	Return size of vector.

virtual std::size_t	local_size () const
	Return local size of vector.

virtual std::pair< std::int64_t, std::int64_t >	local_range () const
	Return local ownership range of a vector.

virtual bool	owns_index (std::size_t i) const
	Determine whether global vector index is owned by this process.

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

virtual void	set (const double block, std::size_t m, const dolfin::la_index rows)
	Set block of values using global indices.

virtual void	set_local (const double block, std::size_t m, const dolfin::la_index rows)
	Set block of values using local indices.

virtual void	add (const double block, std::size_t m, const dolfin::la_index rows)
	Add block of values using global indices.

virtual void	add_local (const double block, std::size_t m, const dolfin::la_index rows)
	Add block of values using local indices.

virtual void	get_local (std::vector< double > &values) const
	Get all values on local process.

virtual void	set_local (const std::vector< double > &values)
	Set all values on local process.

virtual void	add_local (const Array< double > &values)
	Add values to each entry on local process.

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

virtual void	gather (std::vector< double > &x, const std::vector< dolfin::la_index > &indices) const
	Gather entries (given by global indices) into x.

virtual void	gather_on_zero (std::vector< double > &x) const
	Gather all entries into x on process 0.

virtual void	axpy (double a, const GenericVector &x)
	Add multiple of given vector (AXPY operation)

virtual void	abs ()
	Replace all entries in the vector by their absolute values.

virtual double	inner (const GenericVector &x) const
	Return inner product with given vector.

virtual double	norm (std::string norm_type) const
	Return norm of vector.

virtual double	min () const
	Return minimum value of vector.

virtual double	max () const
	Return maximum value of vector.

virtual double	sum () const
	Return sum of values of vector.

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

virtual const Vector &	operator*= (double a)
	Multiply vector by given number.

virtual const Vector &	operator*= (const GenericVector &x)
	Multiply vector by another vector pointwise.

virtual const Vector &	operator/= (double a)
	Divide vector by given number.

virtual const Vector &	operator+= (const GenericVector &x)
	Add given vector.

virtual const GenericVector &	operator+= (double a)
	Add number to all components of a vector.

virtual const Vector &	operator-= (const GenericVector &x)
	Subtract given vector.

virtual const GenericVector &	operator-= (double a)
	Subtract number from all components of a vector.

virtual const GenericVector &	operator= (const GenericVector &x)
	Assignment operator.

const Vector &	operator= (double a)
	Assignment operator.

virtual GenericLinearAlgebraFactory &	factory () const
	Return linear algebra backend factory.

virtual const GenericVector *	instance () const
	Return concrete instance / unwrap (const version)

virtual GenericVector *	instance ()
	Return concrete instance / unwrap (non-const version)

virtual std::shared_ptr< const LinearAlgebraObject >	shared_instance () const
	Return concrete shared ptr instance / unwrap (const version)

virtual std::shared_ptr< LinearAlgebraObject >	shared_instance ()
	Return concrete shared ptr instance / unwrap (non-const version)

const Vector &	operator= (const Vector &x)
	Assignment operator.

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)

virtual std::size_t	size (std::size_t dim) const
	Return size of given dimension.

virtual std::pair< std::int64_t, std::int64_t >	local_range (std::size_t dim) const
	Return local ownership range.

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.

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.

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.

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.

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.

virtual void	add (const double *block, const std::vector< ArrayView< const dolfin::la_index >> &rows)
	Add block of values using global indices.

virtual void	add_local (const double *block, const std::vector< ArrayView< const dolfin::la_index >> &rows)
	Add block of values using local indices.

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 double	operator[] (dolfin::la_index i) const
	Get value of given entry.

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.

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

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

Detailed Description

This class provides the default DOLFIN vector class, based on the default DOLFIN linear algebra backend.

Member Function Documentation

virtual void dolfin::Vector::gather	(	GenericVector &	x,
		const std::vector< dolfin::la_index > &	indices
	)		const

inlinevirtual

Gather entries (given by global indices) into local vector x

Implements dolfin::GenericVector.

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

inlinevirtual

Get block of values using global indices (values must all live on the local process, ghosts are no accessible)

Implements dolfin::GenericVector.

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

inlinevirtual

Get block of values using local indices (values must all live on the local process)

Implements dolfin::GenericVector.

virtual void dolfin::Vector::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
	)

inlinevirtual

Initialize vector with given ownership range and with ghost values

Implements dolfin::GenericVector.

virtual double dolfin::Vector::sum ( const Array< std::size_t > & rows ) const

inlinevirtual

Return sum of selected rows in vector. Repeated entries are only summed once.

Implements dolfin::GenericVector.

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

/home/fenics/shared/dolfin/la/Vector.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation