#include <deal.II/lac/la_parallel_vector.h>

Inheritance diagram for LinearAlgebra::distributed::Vector< Number, MemorySpace >:

[legend]

Public Types
using	memory_space = MemorySpace

using	value_type = Number

using	pointer = value_type *

using	const_pointer = const value_type *

using	iterator = value_type *

using	const_iterator = const value_type *

using	reference = value_type &

using	const_reference = const value_type &

using	size_type = types::global_dof_index

using	real_type = typename numbers::NumberTraits< Number >::real_type

Public Member Functions
template<typename number >
Vector &	operator= (const ::Vector< number > &v)

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

1: Basic Object-handling
	Vector ()

	Vector (const Vector< Number, MemorySpace > &in_vector)

	Vector (Vector< Number, MemorySpace > &&in_vector)

	Vector (const size_type size)

	Vector (const IndexSet &local_range, const IndexSet &ghost_indices, const MPI_Comm communicator)

	Vector (const IndexSet &local_range, const MPI_Comm communicator)

	Vector (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner)

	~Vector ()

void	reinit (const size_type size, const bool omit_zeroing_entries=false)

template<typename Number2 >
void	reinit (const Vector< Number2, MemorySpace > &in_vector, const bool omit_zeroing_entries=false)

void	reinit (const IndexSet &local_range, const IndexSet &ghost_indices, const MPI_Comm communicator)

void	reinit (const IndexSet &local_range, const MPI_Comm communicator)

void	reinit (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner, const MPI_Comm comm_sm=MPI_COMM_SELF)

void	reinit (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner, const bool make_ghosted, const MPI_Comm &comm_sm=MPI_COMM_SELF)

void	reinit (const types::global_dof_index local_size, const types::global_dof_index ghost_size, const MPI_Comm comm, const MPI_Comm comm_sm=MPI_COMM_SELF)

void	swap (Vector< Number, MemorySpace > &v) noexcept

Vector< Number, MemorySpace > &	operator= (Vector< Number, MemorySpace > &&in_vector)

Vector< Number, MemorySpace > &	operator= (const Vector< Number, MemorySpace > &in_vector)

template<typename Number2 >
Vector< Number, MemorySpace > &	operator= (const Vector< Number2, MemorySpace > &in_vector)

2: Parallel data exchange
void	compress (VectorOperation::values operation)

void	update_ghost_values () const

void	compress_start (const unsigned int communication_channel=0, VectorOperation::values operation=VectorOperation::add)

void	compress_finish (VectorOperation::values operation)

void	update_ghost_values_start (const unsigned int communication_channel=0) const

void	update_ghost_values_finish () const

void	zero_out_ghost_values () const

bool	has_ghost_elements () const

template<typename Number2 >
void	copy_locally_owned_data_from (const Vector< Number2, MemorySpace > &src)

template<typename MemorySpace2 >
void	import_elements (const Vector< Number, MemorySpace2 > &src, VectorOperation::values operation)

template<typename MemorySpace2 >
void	import (const Vector< Number, MemorySpace2 > &src, VectorOperation::values operation)

3: Implementation of vector space operations
Vector< Number, MemorySpace > &	operator*= (const Number factor)

Vector< Number, MemorySpace > &	operator/= (const Number factor)

Vector< Number, MemorySpace > &	operator+= (const Vector< Number, MemorySpace > &V)

Vector< Number, MemorySpace > &	operator-= (const Vector< Number, MemorySpace > &V)

void	import_elements (const LinearAlgebra::ReadWriteVector< Number > &V, const VectorOperation::values operation, const std::shared_ptr< const Utilities::MPI::CommunicationPatternBase > &communication_pattern={})

void	import (const LinearAlgebra::ReadWriteVector< Number > &V, VectorOperation::values operation, std::shared_ptr< const Utilities::MPI::CommunicationPatternBase > communication_pattern={})

Number	operator* (const Vector< Number, MemorySpace > &V) const

void	add (const Number a)

void	add (const Number a, const Vector< Number, MemorySpace > &V)

void	add (const Number a, const Vector< Number, MemorySpace > &V, const Number b, const Vector< Number, MemorySpace > &W)

void	add (const std::vector< size_type > &indices, const std::vector< Number > &values)

void	sadd (const Number s, const Number a, const Vector< Number, MemorySpace > &V)

void	scale (const Vector< Number, MemorySpace > &scaling_factors)

void	equ (const Number a, const Vector< Number, MemorySpace > &V)

real_type	l1_norm () const

real_type	l2_norm () const

real_type	norm_sqr () const

real_type	linfty_norm () const

Number	add_and_dot (const Number a, const Vector< Number, MemorySpace > &V, const Vector< Number, MemorySpace > &W)

virtual size_type	size () const override

::IndexSet	locally_owned_elements () const

void	print (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const

std::size_t	memory_consumption () const

4: Other vector operations
Vector< Number, MemorySpace > &	operator= (const Number s)

template<typename OtherNumber >
void	add (const std::vector< size_type > &indices, const ::Vector< OtherNumber > &values)

template<typename OtherNumber >
void	add (const size_type n_elements, const size_type indices, const OtherNumber values)

void	sadd (const Number s, const Vector< Number, MemorySpace > &V)

5: Entry access and local data representation
size_type	locally_owned_size () const

bool	in_local_range (const size_type global_index) const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

Number	operator() (const size_type global_index) const

Number &	operator() (const size_type global_index)

Number	operator[] (const size_type global_index) const

Number &	operator[] (const size_type global_index)

Number	local_element (const size_type local_index) const

Number &	local_element (const size_type local_index)

Number *	get_values () const

template<typename OtherNumber >
void	extract_subvector_to (const std::vector< size_type > &indices, std::vector< OtherNumber > &values) const

virtual void	extract_subvector_to (const ArrayView< const types::global_dof_index > &indices, const ArrayView< Number > &elements) const override

template<typename ForwardIterator , typename OutputIterator >
void	extract_subvector_to (ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const

bool	all_zero () const

Number	mean_value () const

real_type	lp_norm (const real_type p) const

6: Mixed stuff
MPI_Comm	get_mpi_communicator () const

const std::shared_ptr< const Utilities::MPI::Partitioner > &	get_partitioner () const

bool	partitioners_are_compatible (const Utilities::MPI::Partitioner &part) const

bool	partitioners_are_globally_compatible (const Utilities::MPI::Partitioner &part) const

void	set_ghost_state (const bool ghosted) const

const std::vector< ArrayView< const Number > > &	shared_vector_data () const

EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer class.
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcVectorTypeNotCompatible ()

static ::ExceptionBase &	ExcNonMatchingElements (Number arg1, Number arg2, unsigned int arg3)

static ::ExceptionBase &	ExcAccessToNonLocalElement (size_type arg1, size_type arg2, size_type arg3, size_type arg4)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	add_local (const Number a, const Vector< Number, MemorySpace > &V)

void	sadd_local (const Number s, const Number a, const Vector< Number, MemorySpace > &V)

template<typename Number2 >
Number	inner_product_local (const Vector< Number2, MemorySpace > &V) const

real_type	norm_sqr_local () const

Number	mean_value_local () const

real_type	l1_norm_local () const

real_type	lp_norm_local (const real_type p) const

real_type	linfty_norm_local () const

Number	add_and_dot_local (const Number a, const Vector< Number, MemorySpace > &V, const Vector< Number, MemorySpace > &W)

void	clear_mpi_requests ()

void	resize_val (const size_type new_allocated_size, const MPI_Comm comm_sm=MPI_COMM_SELF)

void	check_no_subscribers () const noexcept

Private Attributes
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner

size_type	allocated_size

mutable ::MemorySpace::MemorySpaceData< Number, MemorySpace >	data

std::shared_ptr<::parallel::internal::TBBPartitioner >	thread_loop_partitioner

mutable ::MemorySpace::MemorySpaceData< Number, MemorySpace >	import_data

bool	vector_is_ghosted

std::vector< MPI_Request >	compress_requests

std::vector< MPI_Request >	update_ghost_values_requests

std::mutex	mutex

MPI_Comm	comm_sm

std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

std::vector< std::atomic< bool > * >	validity_pointers

const std::type_info *	object_info

Friends
template<typename Number2 , typename MemorySpace2 >
class	Vector

template<typename Number2 >
class	BlockVector

Detailed Description

template<typename Number, typename MemorySpace = MemorySpace::Host>
class LinearAlgebra::distributed::Vector< Number, MemorySpace >

Implementation of a parallel vector class. The design of this class is similar to the standard Vector class in deal.II, with the exception that storage is distributed with MPI.

The vector is designed for the following scheme of parallel partitioning:

The indices held by individual processes (locally owned part) in the MPI parallelization form a contiguous range [my_first_index,my_last_index).
Ghost indices residing on arbitrary positions of other processors are allowed. It is in general more efficient if ghost indices are clustered, since they are stored as a set of intervals. The communication pattern of the ghost indices is determined when calling the function reinit (locally_owned, ghost_indices, communicator), and retained until the partitioning is changed. This allows for efficient parallel communication of indices. In particular, it stores the communication pattern, rather than having to compute it again for every communication. For more information on ghost vectors, see also the glossary entry on vectors with ghost elements.
Besides the usual global access operator() it is also possible to access vector entries in the local index space with the function local_element(). Locally owned indices are placed first, [0, locally_owned_size()), and then all ghost indices follow after them contiguously, [locally_owned_size(), locally_owned_size()+get_partitioner()->n_ghost_indices()).

Functions related to parallel functionality:

The function compress() goes through the data associated with ghost indices and communicates it to the owner process, which can then add it to the correct position. This can be used e.g. after having run an assembly routine involving ghosts that fill this vector. Note that the insert mode of compress() does not set the elements included in ghost entries but simply discards them, assuming that the owning processor has set them to the desired value already (See also the glossary entry on compress).
The update_ghost_values() function imports the data from the owning processor to the ghost indices in order to provide read access to the data associated with ghosts.
It is possible to split the above functions into two phases, where the first initiates the communication and the second one finishes it. These functions can be used to overlap communication with computations in other parts of the code.
Of course, reduction operations (like norms) make use of collective all-to-all MPI communications.

This vector can take two different states with respect to ghost elements:

After creation and whenever zero_out_ghost_values() is called (or operator= (0.)), the vector does only allow writing into ghost elements but not reading from ghost elements.
After a call to update_ghost_values(), the vector does not allow writing into ghost elements but only reading from them. This is to avoid undesired ghost data artifacts when calling compress() after modifying some vector entries. The current status of the ghost entries (read mode or write mode) can be queried by the method has_ghost_elements(), which returns true exactly when ghost elements have been updated and false otherwise, irrespective of the actual number of ghost entries in the vector layout (for that information, use get_partitioner()->n_ghost_indices() instead).

This vector uses the facilities of the class Vector<Number> for implementing the operations on the local range of the vector. In particular, it also inherits thread parallelism that splits most vector-vector operations into smaller chunks if the program uses multiple threads. This may or may not be desired when working also with MPI.

Limitations regarding the vector size

This vector class is based on two different number types for indexing. The so-called global index type encodes the overall size of the vector. Its type is types::global_dof_index. The largest possible value is 2^32-1 or approximately 4 billion in case 64 bit integers are disabled at configuration of deal.II (default case) or 2^64-1 or approximately 10^19 if 64 bit integers are enabled (see the glossary entry on When to use types::global_dof_index instead of unsigned int for further information).

The second relevant index type is the local index used within one MPI rank. As opposed to the global index, the implementation assumes 32-bit unsigned integers unconditionally. In other words, to actually use a vector with more than four billion entries, you need to use MPI with more than one rank (which in general is a safe assumption since four billion entries consume at least 16 GB of memory for floats or 32 GB of memory for doubles) and enable 64-bit indices. If more than 4 billion local elements are present, the implementation tries to detect that, which triggers an exception and aborts the code. Note, however, that the detection of overflow is tricky and the detection mechanism might fail in some circumstances. Therefore, it is strongly recommended to not rely on this class to automatically detect the unsupported case.

GPU support

This vector class supports two different memory spaces: Host and Default. If the MemorySpace template argument is not specified, the memory space is Host and all the data is allocated on the CPU. When the memory space is Default, all the data is allocated on Kokkos' default memory space. That means that if Kokkos was configured with a GPU backend, the data is allocated on a GPU. The operations on the vector are performed on the chosen memory space. From the host, there are two methods to access the elements of the Vector when using the Default memory space:

use get_values():
Vector<double, MemorySpace::Default> vector(local_range, comm);

double* vector_dev = vector.get_values();

const int n_local_elements = local_range.n_elements();

std::vector<double> vector_host(n_local_elements, 1.);

Kokkos::deep_copy(Kokkos::View<double, Kokkos::HostSpace>(

vector_host.data(), n_local_elements),

Kokkos::View<double,

MemorySpace::Default::kokkos_space>( vector_dev, n_local_elements));

LinearAlgebra::distributed::Vector
Definition la_parallel_vector.h:250

local_range
std::pair< types::global_dof_index, types::global_dof_index > local_range
Definition mpi.cc:815

comm
const MPI_Comm comm
Definition mpi.cc:913

MemorySpace::Default::kokkos_space
::Kokkos::DefaultExecutionSpace::memory_space kokkos_space
Definition memory_space.h:45
use import_elements():
Vector<double, MemorySpace::Default> vector(local_range, comm);

ReadWriteVector<double> rw_vector(local_range);

for (auto & val : rw_vector)

val = 1.;

vector.import_elements(rw_vector, VectorOperations::insert);

LinearAlgebra::ReadWriteVector
Definition read_write_vector.h:126

The import method is a lot safer and will perform an MPI communication if necessary. Since an MPI communication may be performed, import needs to be called on all the processors.

Note: By default, the GPU device id is chosen in a round-robin fashion according to the local MPI rank id. To choose a different device, Kokkos has to be initialized explicitly providing the respective device id explicitly.

MPI-3 shared-memory support

In Host mode, this class allows to use MPI-3 shared-memory features by providing a separate MPI communicator that consists of processes on the same shared-memory domain. By calling vector.shared_vector_data();, users have read-only access to both locally-owned and ghost values of processes combined in the shared-memory communicator (comm_sm in reinit()).

For this to work, you have to call the constructor or one of the reinit() functions of this class with a non-default value for the comm_sm argument, where the argument corresponds to a communicator consisting of all processes on the same shared-memory domain. This kind of communicator can be created using the following code snippet:

MPI_Comm comm_sm;
MPI_Comm_split_type(comm, MPI_COMM_TYPE_SHARED, rank, MPI_INFO_NULL,
                    &comm_sm);

Definition at line 249 of file la_parallel_vector.h.

Member Typedef Documentation

◆ memory_space

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::memory_space = MemorySpace

Definition at line 252 of file la_parallel_vector.h.

◆ value_type

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::value_type = Number

Definition at line 253 of file la_parallel_vector.h.

◆ pointer

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::pointer = value_type *

Definition at line 254 of file la_parallel_vector.h.

◆ const_pointer

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::const_pointer = const value_type *

Definition at line 255 of file la_parallel_vector.h.

◆ iterator

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::iterator = value_type *

Definition at line 256 of file la_parallel_vector.h.

◆ const_iterator

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::const_iterator = const value_type *

Definition at line 257 of file la_parallel_vector.h.

◆ reference

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::reference = value_type &

Definition at line 258 of file la_parallel_vector.h.

◆ const_reference

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::const_reference = const value_type &

Definition at line 259 of file la_parallel_vector.h.

◆ size_type

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::size_type = types::global_dof_index

Definition at line 260 of file la_parallel_vector.h.

◆ real_type

template<typename Number , typename MemorySpace = MemorySpace::Host>

using LinearAlgebra::distributed::Vector< Number, MemorySpace >::real_type = typename numbers::NumberTraits<Number>::real_type

Definition at line 261 of file la_parallel_vector.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ Vector() [1/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector ( )

Empty constructor.

◆ Vector() [2/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector ( const Vector< Number, MemorySpace > & in_vector )

Copy constructor. Uses the parallel partitioning of in_vector. It should be noted that this constructor automatically sets ghost values to zero. Call update_ghost_values() directly following construction if a ghosted vector is required.

◆ Vector() [3/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector ( Vector< Number, MemorySpace > && in_vector )

Move constructor. Uses the swap method.

Note: In order for this constructor to leave the moved-from object in a valid state it must allocate memory (in this case, an empty partitioner) - hence it cannot be marked as noexcept.

◆ Vector() [4/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector ( const size_type size )

Construct a parallel vector of the given global size without any actual parallel distribution.

◆ Vector() [5/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector	(	const IndexSet &	local_range,
		const IndexSet &	ghost_indices,
		const MPI_Comm	communicator
	)

Construct a parallel vector. The local range is specified by locally_owned_set (note that this must be a contiguous interval, multiple intervals are not possible). The IndexSet ghost_indices specifies ghost indices, i.e., indices which one might need to read data from or accumulate data from. It is allowed that the set of ghost indices also contains the local range, but it does not need to.

This function involves global communication, so it should only be called once for a given layout. Use the constructor with Vector<Number> argument to create additional vectors with the same parallel layout.

See also: vectors with ghost elements

◆ Vector() [6/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector	(	const IndexSet &	local_range,
		const MPI_Comm	communicator
	)

Same constructor as above but without any ghost indices.

◆ Vector() [7/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::Vector ( const std::shared_ptr< const Utilities::MPI::Partitioner > & partitioner )

Create the vector based on the parallel partitioning described in partitioner. The input argument is a shared pointer, which stores the partitioner data only once and share it between several vectors with the same layout.

◆ ~Vector()

template<typename Number , typename MemorySpace = MemorySpace::Host>

LinearAlgebra::distributed::Vector< Number, MemorySpace >::~Vector ( )

Destructor.

Member Function Documentation

◆ reinit() [1/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const size_type	size,
		const bool	omit_zeroing_entries = `false`
	)

Set the global size of the vector to size without any actual parallel distribution.

◆ reinit() [2/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const Vector< Number2, MemorySpace > &	in_vector,
		const bool	omit_zeroing_entries = `false`
	)

Uses the parallel layout of the input vector in_vector and allocates memory for this vector. Recommended initialization function when several vectors with the same layout should be created.

If the flag omit_zeroing_entries is set to false, the memory will be initialized with zero, otherwise the memory will be untouched (and the user must make sure to fill it with reasonable data before using it).

◆ reinit() [3/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const IndexSet &	local_range,
		const IndexSet &	ghost_indices,
		const MPI_Comm	communicator
	)

Initialize the vector. The local range is specified by local_range (note that this must be a contiguous interval, multiple intervals are not possible). The IndexSet ghost_indices specifies ghost indices, i.e., indices which one might need to read data from or accumulate data from. It is allowed that the set of ghost indices also contains the local range, but it does not need to.

This function involves global communication, so it should only be called once for a given layout. Use the reinit function with Vector<Number> argument to create additional vectors with the same parallel layout.

See also: vectors with ghost elements

◆ reinit() [4/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const IndexSet &	local_range,
		const MPI_Comm	communicator
	)

Same as above, but without ghost entries.

◆ reinit() [5/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner,
		const MPI_Comm	comm_sm = `MPI_COMM_SELF`
	)

Initialize the vector given to the parallel partitioning described in partitioner. The input argument is a shared pointer, which stores the partitioner data only once and can be shared between several vectors with the same layout.

The optional argument comm_sm, which consists of processes on the same shared-memory domain, allows users have read-only access to both locally-owned and ghost values of processes combined in the shared-memory communicator. See the general documentation of this class for more information about this argument.

◆ reinit() [6/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner,
		const bool	make_ghosted,
		const MPI_Comm &	comm_sm = `MPI_COMM_SELF`
	)

This function exists purely for reasons of compatibility with the PETScWrappers::MPI::Vector and TrilinosWrappers::MPI::Vector classes.

It calls the function above, and ignores the parameter make_ghosted.

◆ reinit() [7/7]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::reinit	(	const types::global_dof_index	local_size,
		const types::global_dof_index	ghost_size,
		const MPI_Comm	comm,
		const MPI_Comm	comm_sm = `MPI_COMM_SELF`
	)

Initialize vector with local_size locally-owned and ghost_size ghost degrees of freedoms.

The optional argument comm_sm, which consists of processes on the same shared-memory domain, allows users have read-only access to both locally-owned and ghost values of processes combined in the shared-memory communicator. See the general documentation of this class for more information about this argument.

Note: In the created underlying partitioner, the local index range is translated to global indices in an ascending and one-to-one fashion, i.e., the indices of process \(p\) sit exactly between the indices of the processes \(p-1\) and \(p+1\), respectively. Setting the ghost_size variable to an appropriate value provides memory space for the ghost data in a vector's memory allocation as and allows access to it via local_element(). However, the associated global indices must be handled externally in this case.

◆ swap()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::swap ( Vector< Number, MemorySpace > & v )

noexcept

Swap the contents of this vector and the other vector v. One could do this operation with a temporary variable and copying over the data elements, but this function is significantly more efficient since it only swaps the pointers to the data of the two vectors and therefore does not need to allocate temporary storage and move data around.

This function is analogous to the swap function of all C++ standard containers. Also, there is a global function swap(u,v) that simply calls u.swap(v), again in analogy to standard functions.

◆ operator=() [1/5]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator= ( Vector< Number, MemorySpace > && in_vector )

Move assignment operator.

Note: This method may throw an exception (should an MPI check fail) and is consequently not noexcept.

◆ operator=() [2/5]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator= ( const Vector< Number, MemorySpace > & in_vector )

Assigns the vector to the parallel partitioning of the input vector in_vector, and copies all the data.

The semantics of this operator are complex. If the two vectors have the same size, and if either the left or right hand side vector of the assignment (i.e., either the input vector on the right hand side, or the calling vector to the left of the assignment operator) currently has ghost elements, then the left hand side vector will also have ghost values and will consequently be a read-only vector (see also the glossary entry on the issue). Otherwise, the left hand vector will be a writable vector after this operation. These semantics facilitate having a vector with ghost elements on the left hand side of the assignment, and a vector without ghost elements on the right hand side, with the resulting left hand side vector having the correct values in both its locally owned and its ghost elements.

On the other hand, if the left hand side vector does not have the correct size yet, or is perhaps an entirely uninitialized vector, then the assignment is simply a copy operation in the usual sense: In that case, if the right hand side has no ghost elements (i.e., is a completely distributed vector), then the left hand side will have no ghost elements either. And if the right hand side has ghost elements (and is consequently read-only), then the left hand side will have these same properties after the operation.

◆ operator=() [3/5]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 >

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator= ( const Vector< Number2, MemorySpace > & in_vector )

Assigns the vector to the parallel partitioning of the input vector in_vector, and copies all the data.

If one of the input vector or the calling vector (to the left of the assignment operator) had ghost elements set before this operation, the calling vector will have ghost values set. Otherwise, it will be in write mode. If the input vector does not have any ghost elements at all, the vector will also update its ghost values in analogy to the respective setting the Trilinos and PETSc vectors.

◆ compress()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::compress ( VectorOperation::values operation )

This function copies the data that has accumulated in the data buffer for ghost indices to the owning processor. For the meaning of the argument operation, see the entry on Compressing distributed vectors and matrices in the glossary.

There are four variants for this function. If called with argument VectorOperation::add adds all the data accumulated in ghost elements to the respective elements on the owning processor and clears the ghost array afterwards. If called with argument VectorOperation::insert, a set operation is performed. Since setting elements in a vector with ghost elements is ambiguous (as one can set both the element on the ghost site as well as the owning site), this operation makes the assumption that all data is set correctly on the owning processor. Upon call of compress(VectorOperation::insert), all ghost entries are thus simply zeroed out (using zero_ghost_values()). In debug mode, a check is performed for whether the data set is actually consistent between processors, i.e., whenever a non-zero ghost element is found, it is compared to the value on the owning processor and an exception is thrown if these elements do not agree. If called with VectorOperation::min or VectorOperation::max, the minimum or maximum on all elements across the processors is set.

Note: This vector class has a fixed set of ghost entries attached to the local representation. As a consequence, all ghost entries are assumed to be valid and will be exchanged unconditionally according to the given VectorOperation. Make sure to initialize all ghost entries with the neutral element of the given VectorOperation or touch all ghost entries. The neutral element is zero for VectorOperation::add and VectorOperation::insert, +inf for VectorOperation::min, and -inf for VectorOperation::max. If all values are initialized with values below zero and compress is called with VectorOperation::max two times subsequently, the maximal value after the second calculation will be zero.

◆ update_ghost_values()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::update_ghost_values ( ) const

Fills the data field for ghost indices with the values stored in the respective positions of the owning processor. This function is needed before reading from ghosts. The function is const even though ghost data is changed. This is needed to allow functions with a const vector to perform the data exchange without creating temporaries.

After calling this method, write access to ghost elements of the vector is forbidden and an exception is thrown. Only read access to ghost elements is allowed in this state. Note that all subsequent operations on this vector, like global vector addition, etc., will also update the ghost values by a call to this method after the operation. However, global reduction operations like norms or the inner product will always ignore ghost elements in order to avoid counting the ghost data more than once. To allow writing to ghost elements again, call zero_out_ghost_values().

See also: vectors with ghost elements

◆ compress_start()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::compress_start	(	const unsigned int	communication_channel = `0`,
		VectorOperation::values	operation = `VectorOperation::add`
	)

Initiates communication for the compress() function with non-blocking communication. This function does not wait for the transfer to finish, in order to allow for other computations during the time it takes until all data arrives.

Before the data is actually exchanged, the function must be followed by a call to compress_finish().

In case this function is called for more than one vector before compress_finish() is invoked, it is mandatory to specify a unique communication channel to each such call, in order to avoid several messages with the same ID that will corrupt this operation. Any communication channel less than 100 is a valid value (in particular, the range \([100, 200)\) is reserved for LinearAlgebra::distributed::BlockVector).

◆ compress_finish()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::compress_finish ( VectorOperation::values operation )

For all requests that have been initiated in compress_start, wait for the communication to finish. Once it is finished, add or set the data (depending on the flag operation) to the respective positions in the owning processor, and clear the contents in the ghost data fields. The meaning of this argument is the same as in compress().

This function should be called exactly once per vector after calling compress_start, otherwise the result is undefined. In particular, it is not well-defined to call compress_start on the same vector again before compress_finished has been called. However, there is no warning to prevent this situation.

Must follow a call to the compress_start function.

When the MemorySpace is Default and MPI is not GPU-aware, data changed on the device after the call to compress_start will be lost.

◆ update_ghost_values_start()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::update_ghost_values_start ( const unsigned int communication_channel = 0 ) const

Initiates communication for the update_ghost_values() function with non-blocking communication. This function does not wait for the transfer to finish, in order to allow for other computations during the time it takes until all data arrives.

Before the data is actually exchanged, the function must be followed by a call to update_ghost_values_finish().

In case this function is called for more than one vector before update_ghost_values_finish() is invoked, it is mandatory to specify a unique communication channel to each such call, in order to avoid several messages with the same ID that will corrupt this operation. Any communication channel less than 100 is a valid value (in particular, the range \([100, 200)\) is reserved for LinearAlgebra::distributed::BlockVector).

◆ update_ghost_values_finish()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::update_ghost_values_finish ( ) const

For all requests that have been started in update_ghost_values_start, wait for the communication to finish.

Must follow a call to the update_ghost_values_start function before reading data from ghost indices.

◆ zero_out_ghost_values()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::zero_out_ghost_values ( ) const

This method zeros the entries on ghost dofs, but does not touch locally owned DoFs.

After calling this method, read access to ghost elements of the vector is forbidden and an exception is thrown. Only write access to ghost elements is allowed in this state.

◆ has_ghost_elements()

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::has_ghost_elements ( ) const

Return whether the vector currently is in a state where ghost values can be read or not. This is the same functionality as other parallel vectors have. If this method returns false, this only means that read-access to ghost elements is prohibited whereas write access is still possible (to those entries specified as ghosts during initialization), not that there are no ghost elements at all.

See also: vectors with ghost elements

◆ copy_locally_owned_data_from()

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::copy_locally_owned_data_from ( const Vector< Number2, MemorySpace > & src )

This method copies the data in the locally owned range from another distributed vector src into the calling vector. As opposed to operator= that also includes ghost entries, this operation ignores the ghost range. The only prerequisite is that the local range on the calling vector and the given vector src are the same on all processors. It is explicitly allowed that the two vectors have different ghost elements that might or might not be related to each other.

Since no data exchange is performed, make sure that neither src nor the calling vector have pending communications in order to obtain correct results.

◆ import_elements() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename MemorySpace2 >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::import_elements	(	const Vector< Number, MemorySpace2 > &	src,
		VectorOperation::values	operation
	)

Import all the elements present in the distributed vector src. VectorOperation::values operation is used to decide if the elements in V should be added to the current vector or replace the current elements. The main purpose of this function is to get data from one memory space, e.g. Default, to the other, e.g. the Host.

Note: The partitioners of the two distributed vectors need to be the same as no MPI communication is performed.

◆ import() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename MemorySpace2 >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::import	(	const Vector< Number, MemorySpace2 > &	src,
		VectorOperation::values	operation
	)

inline

Deprecated:: Use import_elements() instead.

Definition at line 717 of file la_parallel_vector.h.

◆ operator*=()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator*= ( const Number factor )

Multiply the entire vector by a fixed factor.

◆ operator/=()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator/= ( const Number factor )

Divide the entire vector by a fixed factor.

◆ operator+=()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator+= ( const Vector< Number, MemorySpace > & V )

Add the vector V to the present one.

◆ operator-=()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator-= ( const Vector< Number, MemorySpace > & V )

Subtract the vector V from the present one.

◆ import_elements() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::import_elements	(	const LinearAlgebra::ReadWriteVector< Number > &	V,
		const VectorOperation::values	operation,
		const std::shared_ptr< const Utilities::MPI::CommunicationPatternBase > &	communication_pattern = `{}`
	)

Import all the elements present in the vector's IndexSet from the input vector V. VectorOperation::values operation is used to decide if the elements in V should be added to the current vector or replace the current elements. The last parameter can be used if the same communication pattern is used multiple times. This can be used to improve performance.

Note: If the MemorySpace is Default, the data in the ReadWriteVector will be moved to the device.

◆ import() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::import	(	const LinearAlgebra::ReadWriteVector< Number > &	V,
		VectorOperation::values	operation,
		std::shared_ptr< const Utilities::MPI::CommunicationPatternBase >	communication_pattern = `{}`
	)

inline

Deprecated:: Use import_elements() instead.

Definition at line 776 of file la_parallel_vector.h.

◆ operator*()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator* ( const Vector< Number, MemorySpace > & V ) const

Return the scalar product of two vectors.

◆ add() [1/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add ( const Number a )

Add a to all components. Note that a is a scalar not a vector.

◆ add() [2/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add	(	const Number	a,
		const Vector< Number, MemorySpace > &	V
	)

Simple addition of a multiple of a vector, i.e. *this += a*V.

◆ add() [3/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add	(	const Number	a,
		const Vector< Number, MemorySpace > &	V,
		const Number	b,
		const Vector< Number, MemorySpace > &	W
	)

Multiple addition of scaled vectors, i.e. *this += a*V+b*W.

◆ add() [4/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add	(	const std::vector< size_type > &	indices,
		const std::vector< Number > &	values
	)

A collective add operation: This function adds a whole set of values stored in values to the vector components specified by indices.

◆ sadd() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::sadd	(	const Number	s,
		const Number	a,
		const Vector< Number, MemorySpace > &	V
	)

Scaling and simple addition of a multiple of a vector, i.e. this = s(*this)+a*V.

◆ scale()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::scale ( const Vector< Number, MemorySpace > & scaling_factors )

Scale each element of this vector by the corresponding element in the argument. This function is mostly meant to simulate multiplication (and immediate re-assignment) by a diagonal scaling matrix.

◆ equ()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::equ	(	const Number	a,
		const Vector< Number, MemorySpace > &	V
	)

Assignment *this = a*V.

◆ l1_norm()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::l1_norm ( ) const

Return the l₁ norm of the vector (i.e., the sum of the absolute values of all entries among all processors).

◆ l2_norm()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::l2_norm ( ) const

Return the \(l_2\) norm of the vector (i.e., the square root of the sum of the square of all entries among all processors).

◆ norm_sqr()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::norm_sqr ( ) const

Return the square of the \(l_2\) norm of the vector.

◆ linfty_norm()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::linfty_norm ( ) const

Return the maximum norm of the vector (i.e., the maximum absolute value among all entries and among all processors).

◆ add_and_dot()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::add_and_dot	(	const Number	a,
		const Vector< Number, MemorySpace > &	V,
		const Vector< Number, MemorySpace > &	W
	)

Perform a combined operation of a vector addition and a subsequent inner product, returning the value of the inner product. In other words, the result of this function is the same as if the user called

this->add(a, V);

return_value = *this * W;

LinearAlgebra::distributed::Vector::add

void add(const Number a)

The reason this function exists is that this operation involves less memory transfer than calling the two functions separately. This method only needs to load three vectors, this, V, W, whereas calling separate methods means to load the calling vector this twice. Since most vector operations are memory transfer limited, this reduces the time by 25% (or 50% if W equals this).

For complex-valued vectors, the scalar product in the second step is implemented as \(\left<v,w\right>=\sum_i v_i \bar{w_i}\).

◆ size()

template<typename Number , typename MemorySpace = MemorySpace::Host>

virtual size_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::size ( ) const

overridevirtual

Return the global size of the vector, equal to the sum of the number of locally owned indices among all processors.

Implements ReadVector< Number >.

◆ locally_owned_elements()

template<typename Number , typename MemorySpace = MemorySpace::Host>

::IndexSet LinearAlgebra::distributed::Vector< Number, MemorySpace >::locally_owned_elements ( ) const

Return an index set that describes which elements of this vector are owned by the current processor. As a consequence, the index sets returned on different processors if this is a distributed vector will form disjoint sets that add up to the complete index set. Obviously, if a vector is created on only one processor, then the result would satisfy

vec.locally_owned_elements() == complete_index_set(vec.size())

complete_index_set

IndexSet complete_index_set(const IndexSet::size_type N)

Definition index_set.h:1204

◆ print()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::print	(	std::ostream &	out,
		const unsigned int	precision = `3`,
		const bool	scientific = `true`,
		const bool	across = `true`
	)		const

Print the vector to the output stream out.

◆ memory_consumption()

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::size_t LinearAlgebra::distributed::Vector< Number, MemorySpace >::memory_consumption ( ) const

Return the memory consumption of this class in bytes.

◆ operator=() [4/5]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Vector< Number, MemorySpace > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator= ( const Number s )

Sets all elements of the vector to the scalar s. If the scalar is zero, also ghost elements are set to zero, otherwise they remain unchanged.

◆ add() [5/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename OtherNumber >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add	(	const std::vector< size_type > &	indices,
		const ::Vector< OtherNumber > &	values
	)

This is a collective add operation that adds a whole set of values stored in values to the vector components specified by indices.

◆ add() [6/6]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename OtherNumber >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add	(	const size_type	n_elements,
		const size_type *	indices,
		const OtherNumber *	values
	)

Take an address where n_elements are stored contiguously and add them into the vector.

◆ sadd() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::sadd	(	const Number	s,
		const Vector< Number, MemorySpace > &	V
	)

Scaling and simple vector addition, i.e. this = s(*this)+V.

◆ locally_owned_size()

template<typename Number , typename MemorySpace = MemorySpace::Host>

size_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::locally_owned_size ( ) const

Return the local size of the vector, i.e., the number of indices owned locally.

◆ in_local_range()

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::in_local_range ( const size_type global_index ) const

Return true if the given global index is in the local range of this processor.

◆ begin() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

iterator LinearAlgebra::distributed::Vector< Number, MemorySpace >::begin ( )

Make the Vector class a bit like the vector<> class of the C++ standard library by returning iterators to the start and end of the locally owned elements of this vector.

It holds that end() - begin() == locally_owned_size().

Note: For the Default memory space, the iterator might point to memory on the device.

◆ begin() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

const_iterator LinearAlgebra::distributed::Vector< Number, MemorySpace >::begin ( ) const

Return constant iterator to the start of the locally owned elements of the vector.

Note: For the Default memory space, the iterator might point to memory on the device.

◆ end() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

iterator LinearAlgebra::distributed::Vector< Number, MemorySpace >::end ( )

Return an iterator pointing to the element past the end of the array of locally owned entries.

Note: For the Default memory space, the iterator might point to memory on the device.

◆ end() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

const_iterator LinearAlgebra::distributed::Vector< Number, MemorySpace >::end ( ) const

Return a constant iterator pointing to the element past the end of the array of the locally owned entries.

Note: For the Default memory space, the iterator might point to memory on the device.

◆ operator()() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator() ( const size_type global_index ) const

Read access to the data in the position corresponding to global_index. The index must be either in the local range of the vector or be specified as a ghost index at construction.

Performance: O(1) for locally owned elements that represent a contiguous range and O(log(n_ranges)) for ghost elements (quite fast, but slower than local_element()).

◆ operator()() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator() ( const size_type global_index )

Read and write access to the data in the position corresponding to global_index. The index must be either in the local range of the vector or be specified as a ghost index at construction.

Performance: O(1) for locally owned elements that represent a contiguous range and O(log(n_ranges)) for ghost elements (quite fast, but slower than local_element()).

◆ operator[]() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator[] ( const size_type global_index ) const

Read access to the data in the position corresponding to global_index. The index must be either in the local range of the vector or be specified as a ghost index at construction.

This function does the same thing as operator().

◆ operator[]() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator[] ( const size_type global_index )

Read and write access to the data in the position corresponding to global_index. The index must be either in the local range of the vector or be specified as a ghost index at construction.

This function does the same thing as operator().

◆ local_element() [1/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::local_element ( const size_type local_index ) const

Read access to the data field specified by local_index. Locally owned indices can be accessed with indices [0,locally_owned_size), and ghost indices with indices [locally_owned_size,locally_owned_size+get_partitioner()->n_ghost_indices()].

Performance: Direct array access (fast).

◆ local_element() [2/2]

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number & LinearAlgebra::distributed::Vector< Number, MemorySpace >::local_element ( const size_type local_index )

Read and write access to the data field specified by local_index. Locally owned indices can be accessed with indices [0,locally_owned_size()), and ghost indices with indices [locally_owned_size(), locally_owned_size()+n_ghosts].

Performance: Direct array access (fast).

◆ get_values()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number * LinearAlgebra::distributed::Vector< Number, MemorySpace >::get_values ( ) const

Return the pointer to the underlying raw array.

Note: For the Default memory space, the pointer might point to memory on the device.

◆ extract_subvector_to() [1/3]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename OtherNumber >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::extract_subvector_to	(	const std::vector< size_type > &	indices,
		std::vector< OtherNumber > &	values
	)		const

Instead of getting individual elements of a vector via operator(), this function allows getting a whole set of elements at once. The indices of the elements to be read are stated in the first argument, the corresponding values are returned in the second.

If the current vector is called v, then this function is the equivalent to the code

for (unsigned int i=0; i<indices.size(); ++i)

values[i] = v[indices[i]];

Precondition: The sizes of the indices and values arrays must be identical.

Note: This function is not implemented for Default memory space.

◆ extract_subvector_to() [2/3]

template<typename Number , typename MemorySpace = MemorySpace::Host>

virtual void LinearAlgebra::distributed::Vector< Number, MemorySpace >::extract_subvector_to	(	const ArrayView< const types::global_dof_index > &	indices,
		const ArrayView< Number > &	elements
	)		const

overridevirtual

Extract a range of elements all at once.

Implements ReadVector< Number >.

◆ extract_subvector_to() [3/3]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename ForwardIterator , typename OutputIterator >

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::extract_subvector_to	(	ForwardIterator	indices_begin,
		const ForwardIterator	indices_end,
		OutputIterator	values_begin
	)		const

Instead of getting individual elements of a vector via operator(), this function allows getting a whole set of elements at once. In contrast to the previous function, this function obtains the indices of the elements by dereferencing all elements of the iterator range provided by the first two arguments, and puts the vector values into memory locations obtained by dereferencing a range of iterators starting at the location pointed to by the third argument.

If the current vector is called v, then this function is the equivalent to the code

ForwardIterator indices_p = indices_begin;
OutputIterator  values_p  = values_begin;
while (indices_p != indices_end)
{
  *values_p = v[*indices_p];
  ++indices_p;
  ++values_p;
}

Precondition: It must be possible to write into as many memory locations starting at values_begin as there are iterators between indices_begin and indices_end.

◆ all_zero()

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::all_zero ( ) const

Return whether the vector contains only elements with value zero. This is a collective operation. This function is expensive, because potentially all elements have to be checked.

◆ mean_value()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::mean_value ( ) const

Compute the mean value of all the entries in the vector.

◆ lp_norm()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::lp_norm ( const real_type p ) const

\(l_p\)-norm of the vector. The pth root of the sum of the pth powers of the absolute values of the elements.

◆ get_mpi_communicator()

template<typename Number , typename MemorySpace = MemorySpace::Host>

MPI_Comm LinearAlgebra::distributed::Vector< Number, MemorySpace >::get_mpi_communicator ( ) const

Return the underlying MPI communicator.

◆ get_partitioner()

template<typename Number , typename MemorySpace = MemorySpace::Host>

const std::shared_ptr< const Utilities::MPI::Partitioner > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::get_partitioner ( ) const

Return the MPI partitioner that describes the parallel layout of the vector. This object can be used to initialize another vector with the respective reinit() call, for additional queries regarding the parallel communication, or the compatibility of partitioners.

◆ partitioners_are_compatible()

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::partitioners_are_compatible ( const Utilities::MPI::Partitioner & part ) const

Check whether the given partitioner is compatible with the partitioner used for this vector. Two partitioners are compatible if they have the same local size and the same ghost indices. They do not necessarily need to be the same data field of the shared pointer. This is a local operation only, i.e., if only some processors decide that the partitioning is not compatible, only these processors will return false, whereas the other processors will return true.

◆ partitioners_are_globally_compatible()

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::partitioners_are_globally_compatible ( const Utilities::MPI::Partitioner & part ) const

Check whether the given partitioner is compatible with the partitioner used for this vector. Two partitioners are compatible if they have the same local size and the same ghost indices. They do not necessarily need to be the same data field. As opposed to partitioners_are_compatible(), this method checks for compatibility among all processors and the method only returns true if the partitioner is the same on all processors.

This method performs global communication, so make sure to use it only in a context where all processors call it the same number of times.

◆ set_ghost_state()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::set_ghost_state ( const bool ghosted ) const

Change the ghost state of this vector to ghosted.

◆ shared_vector_data()

template<typename Number , typename MemorySpace = MemorySpace::Host>

const std::vector< ArrayView< const Number > > & LinearAlgebra::distributed::Vector< Number, MemorySpace >::shared_vector_data ( ) const

Get pointers to the beginning of the values of the other processes of the same shared-memory domain.

◆ add_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::add_local	(	const Number	a,
		const Vector< Number, MemorySpace > &	V
	)

private

Simple addition of a multiple of a vector, i.e. *this += a*V without MPI communication.

◆ sadd_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::sadd_local	(	const Number	s,
		const Number	a,
		const Vector< Number, MemorySpace > &	V
	)

private

Scaling and simple addition of a multiple of a vector, i.e. this = s(*this)+a*V without MPI communication.

◆ inner_product_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 >

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::inner_product_local ( const Vector< Number2, MemorySpace > & V ) const

private

Local part of the inner product of two vectors.

◆ norm_sqr_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::norm_sqr_local ( ) const

private

Local part of norm_sqr().

◆ mean_value_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::mean_value_local ( ) const

private

Local part of mean_value().

◆ l1_norm_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::l1_norm_local ( ) const

private

Local part of l1_norm().

◆ lp_norm_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::lp_norm_local ( const real_type p ) const

private

Local part of lp_norm().

◆ linfty_norm_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

real_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::linfty_norm_local ( ) const

private

Local part of linfty_norm().

◆ add_and_dot_local()

template<typename Number , typename MemorySpace = MemorySpace::Host>

Number LinearAlgebra::distributed::Vector< Number, MemorySpace >::add_and_dot_local	(	const Number	a,
		const Vector< Number, MemorySpace > &	V,
		const Vector< Number, MemorySpace > &	W
	)

private

Local part of the addition followed by an inner product of two vectors. The same applies for complex-valued vectors as for the add_and_dot() function.

◆ clear_mpi_requests()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::clear_mpi_requests ( )

private

A helper function that clears the compress_requests and update_ghost_values_requests field. Used in reinit() functions.

◆ resize_val()

template<typename Number , typename MemorySpace = MemorySpace::Host>

void LinearAlgebra::distributed::Vector< Number, MemorySpace >::resize_val	(	const size_type	new_allocated_size,
		const MPI_Comm	comm_sm = `MPI_COMM_SELF`
	)

private

A helper function that is used to resize the val array.

◆ operator=() [5/5]

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename number >

Vector & LinearAlgebra::distributed::Vector< Number, MemorySpace >::operator= ( const ::Vector< number > & v )

Definition at line 535 of file trilinos_vector.cc.

◆ subscribe()

void EnableObserverPointer::subscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::unsubscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Unsubscribes a user from the object.

Note: The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

Friends And Related Symbol Documentation

◆ Vector

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 , typename MemorySpace2 >

friend class Vector

friend

Typedef for the vector type used

Typedef for the vector type used.

Definition at line 1455 of file la_parallel_vector.h.

◆ BlockVector

template<typename Number , typename MemorySpace = MemorySpace::Host>

template<typename Number2 >

friend class BlockVector

friend

Typedef for the block-vector type used

Typedef for the type used to describe vectors that consist of multiple blocks.

Definition at line 1459 of file la_parallel_vector.h.

Member Data Documentation

◆ partitioner

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::shared_ptr<const Utilities::MPI::Partitioner> LinearAlgebra::distributed::Vector< Number, MemorySpace >::partitioner

private

Shared pointer to store the parallel partitioning information. This information can be shared between several vectors that have the same partitioning.

Definition at line 1372 of file la_parallel_vector.h.

◆ allocated_size

template<typename Number , typename MemorySpace = MemorySpace::Host>

size_type LinearAlgebra::distributed::Vector< Number, MemorySpace >::allocated_size

private

The size that is currently allocated in the val array.

Definition at line 1377 of file la_parallel_vector.h.

◆ data

template<typename Number , typename MemorySpace = MemorySpace::Host>

mutable ::MemorySpace::MemorySpaceData<Number, MemorySpace> LinearAlgebra::distributed::Vector< Number, MemorySpace >::data

private

Underlying data structure storing the local elements of this vector.

Definition at line 1382 of file la_parallel_vector.h.

◆ thread_loop_partitioner

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::shared_ptr<::parallel::internal::TBBPartitioner> LinearAlgebra::distributed::Vector< Number, MemorySpace >::thread_loop_partitioner

mutableprivate

For parallel loops with TBB, this member variable stores the affinity information of loops.

Definition at line 1389 of file la_parallel_vector.h.

◆ import_data

template<typename Number , typename MemorySpace = MemorySpace::Host>

mutable ::MemorySpace::MemorySpaceData<Number, MemorySpace> LinearAlgebra::distributed::Vector< Number, MemorySpace >::import_data

private

Temporary storage that holds the data that is sent to this processor in compress() or sent from this processor in update_ghost_values().

Definition at line 1396 of file la_parallel_vector.h.

◆ vector_is_ghosted

template<typename Number , typename MemorySpace = MemorySpace::Host>

bool LinearAlgebra::distributed::Vector< Number, MemorySpace >::vector_is_ghosted

mutableprivate

Stores whether the vector currently allows for reading ghost elements or not. Note that this is to ensure consistent ghost data and does not indicate whether the vector actually can store ghost elements. In particular, when assembling a vector we do not allow reading elements, only writing them.

Definition at line 1405 of file la_parallel_vector.h.

◆ compress_requests

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::vector<MPI_Request> LinearAlgebra::distributed::Vector< Number, MemorySpace >::compress_requests

private

A vector that collects all requests from compress() operations. This class uses persistent MPI communicators, i.e., the communication channels are stored during successive calls to a given function. This reduces the overhead involved with setting up the MPI machinery, but it does not remove the need for a receive operation to be posted before the data can actually be sent.

Definition at line 1416 of file la_parallel_vector.h.

◆ update_ghost_values_requests

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::vector<MPI_Request> LinearAlgebra::distributed::Vector< Number, MemorySpace >::update_ghost_values_requests

mutableprivate

A vector that collects all requests from update_ghost_values() operations. This class uses persistent MPI communicators.

Definition at line 1422 of file la_parallel_vector.h.

◆ mutex

template<typename Number , typename MemorySpace = MemorySpace::Host>

std::mutex LinearAlgebra::distributed::Vector< Number, MemorySpace >::mutex

mutableprivate

A lock that makes sure that the compress() and update_ghost_values() functions give reasonable results also when used with several threads.

Definition at line 1430 of file la_parallel_vector.h.

◆ comm_sm

template<typename Number , typename MemorySpace = MemorySpace::Host>

MPI_Comm LinearAlgebra::distributed::Vector< Number, MemorySpace >::comm_sm

private

Communicator to be used for the shared-memory domain. See the general documentation of this class for more information about the purpose of comm_sm.

Definition at line 1437 of file la_parallel_vector.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 227 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 257 of file enable_observer_pointer.h.

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

include/deal.II/base/template_constraints.h
include/deal.II/lac/la_parallel_vector.h
source/lac/trilinos_vector.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Limitations regarding the vector size

GPU support

MPI-3 shared-memory support

Member Typedef Documentation

◆ memory_space

◆ value_type

◆ pointer

◆ const_pointer

◆ iterator

◆ const_iterator

◆ reference

◆ const_reference

◆ size_type

◆ real_type

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ Vector() [1/7]

◆ Vector() [2/7]

◆ Vector() [3/7]

◆ Vector() [4/7]

◆ Vector() [5/7]

◆ Vector() [6/7]

◆ Vector() [7/7]

◆ ~Vector()

Member Function Documentation

◆ reinit() [1/7]

◆ reinit() [2/7]

◆ reinit() [3/7]

◆ reinit() [4/7]

◆ reinit() [5/7]

◆ reinit() [6/7]

◆ reinit() [7/7]

◆ swap()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ compress()

◆ update_ghost_values()

◆ compress_start()

◆ compress_finish()

◆ update_ghost_values_start()

◆ update_ghost_values_finish()

◆ zero_out_ghost_values()

◆ has_ghost_elements()

◆ copy_locally_owned_data_from()

◆ import_elements() [1/2]

◆ import() [1/2]

◆ operator*=()

◆ operator/=()

◆ operator+=()

◆ operator-=()

◆ import_elements() [2/2]

◆ import() [2/2]

◆ operator*()

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ sadd() [1/2]

◆ scale()

◆ equ()

◆ l1_norm()

◆ l2_norm()

◆ norm_sqr()

◆ linfty_norm()

◆ add_and_dot()

◆ size()

◆ locally_owned_elements()

◆ print()

◆ memory_consumption()

◆ operator=() [4/5]