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

Inheritance diagram for PETScWrappers::MPI::BlockVector:

Public Types
using	BaseClass = BlockVectorBase< Vector >

using	BlockType = BaseClass::BlockType

using	value_type = BaseClass::value_type

using	pointer = BaseClass::pointer

using	const_pointer = BaseClass::const_pointer

using	reference = BaseClass::reference

using	const_reference = BaseClass::const_reference

using	size_type = BaseClass::size_type

using	iterator = BaseClass::iterator

using	const_iterator = BaseClass::const_iterator

using	real_type = typename BlockType::real_type

Public Member Functions
	BlockVector ()=default

	BlockVector (const unsigned int n_blocks, const MPI_Comm &communicator, const size_type block_size, const size_type locally_owned_size)

	BlockVector (const BlockVector &V)

	BlockVector (const std::vector< size_type > &block_sizes, const MPI_Comm &communicator, const std::vector< size_type > &local_elements)

	BlockVector (const std::vector< IndexSet > &parallel_partitioning, const MPI_Comm &communicator=MPI_COMM_WORLD)

	BlockVector (const std::vector< IndexSet > &parallel_partitioning, const std::vector< IndexSet > &ghost_indices, const MPI_Comm &communicator)

	~BlockVector () override=default

BlockVector &	operator= (const value_type s)

BlockVector &	operator= (const BlockVector &V)

void	reinit (const unsigned int n_blocks, const MPI_Comm &communicator, const size_type block_size, const size_type locally_owned_size, const bool omit_zeroing_entries=false)

void	reinit (const std::vector< size_type > &block_sizes, const MPI_Comm &communicator, const std::vector< size_type > &locally_owned_sizes, const bool omit_zeroing_entries=false)

void	reinit (const BlockVector &V, const bool omit_zeroing_entries=false)

void	reinit (const std::vector< IndexSet > &parallel_partitioning, const MPI_Comm &communicator)

void	reinit (const std::vector< IndexSet > &parallel_partitioning, const std::vector< IndexSet > &ghost_entries, const MPI_Comm &communicator)

void	reinit (const unsigned int num_blocks)

bool	has_ghost_elements () const

const MPI_Comm &	get_mpi_communicator () const

void	swap (BlockVector &v)

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

void	collect_sizes ()

void	compress (::VectorOperation::values operation)

BlockType &	block (const unsigned int i)

const BlockType &	block (const unsigned int i) const

const BlockIndices &	get_block_indices () const

unsigned int	n_blocks () const

std::size_t	size () const

std::size_t	locally_owned_size () const

IndexSet	locally_owned_elements () const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

value_type	operator() (const size_type i) const

reference	operator() (const size_type i)

value_type	operator[] (const size_type i) const

reference	operator[] (const size_type i)

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

void	extract_subvector_to (ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const

bool	operator== (const BlockVectorBase< VectorType2 > &v) const

value_type	operator* (const BlockVectorBase &V) const

real_type	norm_sqr () const

value_type	mean_value () const

real_type	l1_norm () const

real_type	l2_norm () const

real_type	linfty_norm () const

value_type	add_and_dot (const value_type a, const BlockVectorBase &V, const BlockVectorBase &W)

bool	in_local_range (const size_type global_index) const

bool	all_zero () const

bool	is_non_negative () const

BlockVectorBase &	operator+= (const BlockVectorBase &V)

BlockVectorBase &	operator-= (const BlockVectorBase &V)

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

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

void	add (const size_type n_elements, const size_type indices, const Number values)

void	add (const value_type s)

void	add (const value_type a, const BlockVectorBase &V)

void	add (const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W)

void	sadd (const value_type s, const BlockVectorBase &V)

void	sadd (const value_type s, const value_type a, const BlockVectorBase &V)

void	sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W)

void	sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W, const value_type c, const BlockVectorBase &X)

BlockVectorBase &	operator*= (const value_type factor)

BlockVectorBase &	operator/= (const value_type factor)

void	scale (const BlockVector2 &v)

void	equ (const value_type a, const BlockVector2 &V)

void	update_ghost_values () const

std::size_t	memory_consumption () const

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

static ::ExceptionBase &	ExcNonMatchingBlockVectors ()

Protected Attributes
std::vector< Vector >	components

BlockIndices	block_indices

Related Functions
(Note that these are not member functions.)
void	swap (BlockVector &u, BlockVector &v)

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer 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

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

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

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

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

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

static std::mutex	mutex

void	check_no_subscribers () const noexcept

Detailed Description

An implementation of block vectors based on the parallel vector class implemented in PETScWrappers. While the base class provides for most of the interface, this class handles the actual allocation of vectors and provides functions that are specific to the underlying vector type.

The model of distribution of data is such that each of the blocks is distributed across all MPI processes named in the MPI communicator. I.e. we don't just distribute the whole vector, but each component. In the constructors and reinit() functions, one therefore not only has to specify the sizes of the individual blocks, but also the number of elements of each of these blocks to be stored on the local process.

@ Block (linear algebra)

Definition at line 60 of file petsc_block_vector.h.

Member Typedef Documentation

◆ real_type

using BlockVectorBase< Vector >::real_type = typename BlockType::real_type

inherited

Declare a type that has holds real-valued numbers with the same precision as the template argument to this class. If the template argument of this class is a real data type, then real_type equals the template argument. If the template argument is a std::complex type then real_type equals the type underlying the complex numbers.

This alias is used to represent the return type of norms.

Definition at line 471 of file block_vector_base.h.

Member Function Documentation

◆ collect_sizes()

void BlockVectorBase< Vector >::collect_sizes ( )

inherited

Update internal structures after resizing vectors. Whenever you reinited a block of a block vector, the internal data structures are corrupted. Therefore, you should call this function after all blocks got their new size.

◆ compress()

void BlockVectorBase< Vector >::compress ( ::VectorOperation::values operation )

inherited

Call the compress() function on all the subblocks of the matrix.

This functionality only needs to be called if using MPI based vectors and exists in other objects for compatibility.

See Compressing distributed objects for more information.

◆ block() [1/2]

BlockType & BlockVectorBase< Vector >::block ( const unsigned int i )

inherited

Access to a single block.

◆ block() [2/2]

const BlockType & BlockVectorBase< Vector >::block ( const unsigned int i ) const

inherited

Read-only access to a single block.

◆ get_block_indices()

const BlockIndices & BlockVectorBase< Vector >::get_block_indices ( ) const

inherited

Return a reference on the object that describes the mapping between block and global indices. The use of this function is highly deprecated and it should vanish in one of the next versions

◆ n_blocks()

unsigned int BlockVectorBase< Vector >::n_blocks ( ) const

inherited

Number of blocks.

◆ size()

std::size_t BlockVectorBase< Vector >::size ( ) const

inherited

Return dimension of the vector. This is the sum of the dimensions of all components.

◆ locally_owned_size()

std::size_t BlockVectorBase< Vector >::locally_owned_size ( ) const

inherited

Return local dimension of the vector. This is the sum of the local dimensions (i.e., values stored on the current processor) of all components.

◆ locally_owned_elements()

IndexSet BlockVectorBase< Vector >::locally_owned_elements ( ) const

inherited

Return an index set that describes which elements of this vector are owned by the current processor. Note that this index set does not include elements this vector may store locally as ghost elements but that are in fact owned by another 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:1014

For block vectors, this function returns the union of the locally owned elements of the individual blocks, shifted by their respective index offsets.

◆ begin() [1/2]

iterator BlockVectorBase< Vector >::begin ( )

inherited

Return an iterator pointing to the first element.

◆ begin() [2/2]

const_iterator BlockVectorBase< Vector >::begin ( ) const

inherited

Return an iterator pointing to the first element of a constant block vector.

◆ end() [1/2]

iterator BlockVectorBase< Vector >::end ( )

inherited

Return an iterator pointing to the element past the end.

◆ end() [2/2]

const_iterator BlockVectorBase< Vector >::end ( ) const

inherited

Return an iterator pointing to the element past the end of a constant block vector.

◆ operator()() [1/2]

value_type BlockVectorBase< Vector >::operator() ( const size_type i ) const

inherited

Access components, returns U(i).

◆ operator()() [2/2]

reference BlockVectorBase< Vector >::operator() ( const size_type i )

inherited

Access components, returns U(i) as a writeable reference.

◆ operator[]() [1/2]

value_type BlockVectorBase< Vector >::operator[] ( const size_type i ) const

inherited

Access components, returns U(i).

Exactly the same as operator().

◆ operator[]() [2/2]

reference BlockVectorBase< Vector >::operator[] ( const size_type i )

inherited

Access components, returns U(i) as a writeable reference.

Exactly the same as operator().

◆ extract_subvector_to() [1/2]

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

inherited

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.

◆ extract_subvector_to() [2/2]

void BlockVectorBase< Vector >::extract_subvector_to	(	ForwardIterator	indices_begin,
		const ForwardIterator	indices_end,
		OutputIterator	values_begin
	)		const

inherited

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.

◆ operator==()

bool BlockVectorBase< Vector >::operator== ( const BlockVectorBase< VectorType2 > & v ) const

inherited

Check for equality of two block vector types. This operation is only allowed if the two vectors already have the same block structure.

◆ operator*()

value_type BlockVectorBase< Vector >::operator* ( const BlockVectorBase< Vector > & V ) const

inherited

\(U = U * V\): scalar product.

◆ norm_sqr()

real_type BlockVectorBase< Vector >::norm_sqr ( ) const

inherited

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

◆ mean_value()

value_type BlockVectorBase< Vector >::mean_value ( ) const

inherited

Return the mean value of the elements of this vector.

◆ l1_norm()

real_type BlockVectorBase< Vector >::l1_norm ( ) const

inherited

Return the \(l_1\)-norm of the vector, i.e. the sum of the absolute values.

◆ l2_norm()

real_type BlockVectorBase< Vector >::l2_norm ( ) const

inherited

Return the \(l_2\)-norm of the vector, i.e. the square root of the sum of the squares of the elements.

◆ linfty_norm()

real_type BlockVectorBase< Vector >::linfty_norm ( ) const

inherited

Return the maximum absolute value of the elements of this vector, which is the \(l_\infty\)-norm of a vector.

◆ add_and_dot()

value_type BlockVectorBase< Vector >::add_and_dot	(	const value_type	a,
		const BlockVectorBase< Vector > &	V,
		const BlockVectorBase< Vector > &	W
	)

inherited

Performs 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;

BlockVectorBase< Vector >::add

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

The reason this function exists is that this operation involves less memory transfer than calling the two functions separately on deal.II's vector classes (Vector<Number> and LinearAlgebra::distributed::Vector<double>). 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}\).

◆ in_local_range()

bool BlockVectorBase< Vector >::in_local_range ( const size_type global_index ) const

inherited

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

◆ all_zero()

bool BlockVectorBase< Vector >::all_zero ( ) const

inherited

Return whether the vector contains only elements with value zero. This function is mainly for internal consistency check and should seldom be used when not in debug mode since it uses quite some time.

◆ is_non_negative()

bool BlockVectorBase< Vector >::is_non_negative ( ) const

inherited

Return true if the vector has no negative entries, i.e. all entries are zero or positive. This function is used, for example, to check whether refinement indicators are really all positive (or zero).

◆ operator+=()

BlockVectorBase & BlockVectorBase< Vector >::operator+= ( const BlockVectorBase< Vector > & V )

inherited

Addition operator. Fast equivalent to U.add(1, V).

◆ operator-=()

BlockVectorBase & BlockVectorBase< Vector >::operator-= ( const BlockVectorBase< Vector > & V )

inherited

Subtraction operator. Fast equivalent to U.add(-1, V).

◆ add() [1/6]

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

inherited

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

◆ add() [2/6]

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

inherited

This is a second collective add operation. As a difference, this function takes a deal.II vector of values.

◆ add() [3/6]

void BlockVectorBase< Vector >::add	(	const size_type	n_elements,
		const size_type *	indices,
		const Number *	values
	)

inherited

Take an address where n_elements are stored contiguously and add them into the vector. Handles all cases which are not covered by the other two add() functions above.

◆ add() [4/6]

void BlockVectorBase< Vector >::add ( const value_type s )

inherited

\(U(0-DIM)+=s\). Addition of s to all components. Note that s is a scalar and not a vector.

◆ add() [5/6]

void BlockVectorBase< Vector >::add	(	const value_type	a,
		const BlockVectorBase< Vector > &	V
	)

inherited

U+=a*V. Simple addition of a scaled vector.

◆ add() [6/6]

void BlockVectorBase< Vector >::add	(	const value_type	a,
		const BlockVectorBase< Vector > &	V,
		const value_type	b,
		const BlockVectorBase< Vector > &	W
	)

inherited

U+=a*V+b*W. Multiple addition of scaled vectors.

◆ sadd() [1/4]

void BlockVectorBase< Vector >::sadd	(	const value_type	s,
		const BlockVectorBase< Vector > &	V
	)

inherited

U=s*U+V. Scaling and simple vector addition.

◆ sadd() [2/4]

void BlockVectorBase< Vector >::sadd	(	const value_type	s,
		const value_type	a,
		const BlockVectorBase< Vector > &	V
	)

inherited

U=s*U+a*V. Scaling and simple addition.

◆ sadd() [3/4]

void BlockVectorBase< Vector >::sadd	(	const value_type	s,
		const value_type	a,
		const BlockVectorBase< Vector > &	V,
		const value_type	b,
		const BlockVectorBase< Vector > &	W
	)

inherited

U=s*U+a*V+b*W. Scaling and multiple addition.

◆ sadd() [4/4]

void BlockVectorBase< Vector >::sadd	(	const value_type	s,
		const value_type	a,
		const BlockVectorBase< Vector > &	V,
		const value_type	b,
		const BlockVectorBase< Vector > &	W,
		const value_type	c,
		const BlockVectorBase< Vector > &	X
	)

inherited

U=s*U+a*V+b*W+c*X. Scaling and multiple addition.

◆ operator*=()

BlockVectorBase & BlockVectorBase< Vector >::operator*= ( const value_type factor )

inherited

Scale each element of the vector by a constant value.

◆ operator/=()

BlockVectorBase & BlockVectorBase< Vector >::operator/= ( const value_type factor )

inherited

Scale each element of the vector by the inverse of the given value.

◆ scale()

void BlockVectorBase< Vector >::scale ( const BlockVector2 & v )

inherited

Multiply each element of this vector by the corresponding element of v.

◆ equ()

void BlockVectorBase< Vector >::equ	(	const value_type	a,
		const BlockVector2 &	V
	)

inherited

U=a*V. Assignment.

◆ update_ghost_values()

void BlockVectorBase< Vector >::update_ghost_values ( ) const

inherited

Update the ghost values by calling update_ghost_values for each block.

◆ memory_consumption()

std::size_t BlockVectorBase< Vector >::memory_consumption ( ) const

inherited

Determine an estimate for the memory consumption (in bytes) of this object.

Member Data Documentation

◆ components

std::vector<Vector > BlockVectorBase< Vector >::components

protectedinherited

Pointer to the array of components.

Definition at line 950 of file block_vector_base.h.

◆ block_indices

BlockIndices BlockVectorBase< Vector >::block_indices

protectedinherited

Object managing the transformation between global indices and indices within the different blocks.

Definition at line 956 of file block_vector_base.h.

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

include/deal.II/lac/petsc_block_vector.h
source/lac/petsc_parallel_block_vector.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Related Functions

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ real_type

Member Function Documentation

◆ collect_sizes()

◆ compress()

◆ block() [1/2]

◆ block() [2/2]

◆ get_block_indices()

◆ n_blocks()

◆ size()

◆ locally_owned_size()

◆ locally_owned_elements()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ extract_subvector_to() [1/2]

◆ extract_subvector_to() [2/2]

◆ operator==()

◆ operator*()

◆ norm_sqr()

◆ mean_value()

◆ l1_norm()

◆ l2_norm()

◆ linfty_norm()

◆ add_and_dot()

◆ in_local_range()

◆ all_zero()

◆ is_non_negative()

◆ operator+=()

◆ operator-=()

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ sadd() [1/4]

◆ sadd() [2/4]

◆ sadd() [3/4]

◆ sadd() [4/4]

◆ operator*=()

◆ operator/=()

◆ scale()

◆ equ()

◆ update_ghost_values()

◆ memory_consumption()

Member Data Documentation

◆ components

◆ block_indices