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

Inheritance diagram for TrilinosWrappers::MPI::BlockVector:

Public Types
using	BaseClass = ::BlockVectorBase< MPI::Vector >

using	BlockType = BaseClass::BlockType

using	value_type = BaseClass::value_type

Public Types inherited from BlockVectorBase< MPI::Vector >
using	BlockType = MPI::Vector

using	real_type = typename BlockType::real_type

Public Member Functions
	BlockVector ()=default

	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_values, const MPI_Comm &communicator, const bool vector_writable=false)

	BlockVector (const BlockVector &v)

	BlockVector (BlockVector &&v) noexcept

	BlockVector (const size_type num_blocks)

	~BlockVector () override=default

BlockVector &	operator= (const value_type s)

BlockVector &	operator= (const BlockVector &v)

BlockVector &	operator= (BlockVector &&v) noexcept

template<typename Number >
BlockVector &	operator= (const ::BlockVector< Number > &v)

void	reinit (const std::vector< IndexSet > &parallel_partitioning, const MPI_Comm &communicator=MPI_COMM_WORLD, const bool omit_zeroing_entries=false)

void	reinit (const std::vector< IndexSet > &partitioning, const std::vector< IndexSet > &ghost_values, const MPI_Comm &communicator=MPI_COMM_WORLD, const bool vector_writable=false)

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

void	reinit (const size_type num_blocks)

void	import_nonlocal_data_for_fe (const TrilinosWrappers::BlockSparseMatrix &m, const BlockVector &v)

bool	has_ghost_elements () const

void	swap (BlockVector &v)

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

Public Member Functions inherited from BlockVectorBase< MPI::Vector >
	BlockVectorBase ()=default

	BlockVectorBase (const BlockVectorBase &)=default

	BlockVectorBase (BlockVectorBase &&) noexcept=default

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

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

BlockVectorBase &	operator= (const value_type s)

BlockVectorBase &	operator= (const BlockVectorBase &V)

BlockVectorBase &	operator= (BlockVectorBase &&)=default

BlockVectorBase &	operator= (const BlockVectorBase< VectorType2 > &V)

BlockVectorBase &	operator= (const MPI::Vector &v)

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	equ (const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W)

void	update_ghost_values () const

std::size_t	memory_consumption () const

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

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 Public Member Functions
static ::ExceptionBase &	ExcIteratorRangeDoesNotMatchVectorSize ()

static ::ExceptionBase &	ExcNonMatchingBlockVectors ()

Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

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

Additional Inherited Members
Protected Attributes inherited from BlockVectorBase< MPI::Vector >
std::vector< MPI::Vector >	components

BlockIndices	block_indices

Detailed Description

An implementation of block vectors based on the vector class implemented in TrilinosWrappers. 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)

Author: Martin Kronbichler, Wolfgang Bangerth, 2008, 2009

Definition at line 71 of file trilinos_parallel_block_vector.h.

Member Typedef Documentation

◆ BaseClass

using TrilinosWrappers::MPI::BlockVector::BaseClass = ::BlockVectorBase<MPI::Vector>

Typedef the base class for simpler access to its own alias.

Definition at line 77 of file trilinos_parallel_block_vector.h.

◆ BlockType

using TrilinosWrappers::MPI::BlockVector::BlockType = BaseClass::BlockType

Typedef the type of the underlying vector.

Definition at line 82 of file trilinos_parallel_block_vector.h.

◆ value_type

using TrilinosWrappers::MPI::BlockVector::value_type = BaseClass::value_type

Import the alias from the base class.

Definition at line 87 of file trilinos_parallel_block_vector.h.

Constructor & Destructor Documentation

◆ BlockVector() [1/6]

TrilinosWrappers::MPI::BlockVector::BlockVector ( )

default

Default constructor. Generate an empty vector without any blocks.

◆ BlockVector() [2/6]

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

inlineexplicit

Constructor. Generate a block vector with as many blocks as there are entries in partitioning. Each IndexSet together with the MPI communicator contains the layout of the distribution of data among the MPI processes.

Definition at line 314 of file trilinos_parallel_block_vector.h.

◆ BlockVector() [3/6]

BlockVector< Number >::BlockVector	(	const std::vector< IndexSet > &	parallel_partitioning,
		const std::vector< IndexSet > &	ghost_values,
		const MPI_Comm &	communicator,
		const bool	vector_writable = `false`
	)

inline

Creates a BlockVector with ghost elements. See the respective reinit() method for more details. ghost_values may contain any elements in parallel_partitioning, they will be ignored.

Definition at line 323 of file trilinos_parallel_block_vector.h.

◆ BlockVector() [4/6]

BlockVector< Number >::BlockVector ( const BlockVector & v )

inline

Copy-Constructor. Set all the properties of the parallel vector to those of the given argument and copy the elements.

Definition at line 344 of file trilinos_parallel_block_vector.h.

◆ BlockVector() [5/6]

BlockVector< Number >::BlockVector ( BlockVector && v )

inlinenoexcept

Move constructor. Creates a new vector by stealing the internal data of the vector v.

Definition at line 356 of file trilinos_parallel_block_vector.h.

◆ BlockVector() [6/6]

BlockVector< Number >::BlockVector ( const size_type num_blocks )

inlineexplicit

Creates a block vector consisting of num_blocks components, but there is no content in the individual components and the user has to fill appropriate data using a reinit of the blocks.

Definition at line 337 of file trilinos_parallel_block_vector.h.

◆ ~BlockVector()

TrilinosWrappers::MPI::BlockVector::~BlockVector ( )

overridedefault

Destructor. Clears memory

Member Function Documentation

◆ operator=() [1/4]

BlockVector & BlockVector< Number >::operator= ( const value_type s )

Copy operator: fill all components of the vector that are locally stored with the given scalar value.

Definition at line 31 of file trilinos_block_vector.cc.

◆ operator=() [2/4]

BlockVector & BlockVector< Number >::operator= ( const BlockVector & v )

Copy operator for arguments of the same type.

Definition at line 40 of file trilinos_block_vector.cc.

◆ operator=() [3/4]

BlockVector & BlockVector< Number >::operator= ( BlockVector && v )

noexcept

Move the given vector. This operator replaces the present vector with v by efficiently swapping the internal data structures.

Definition at line 61 of file trilinos_block_vector.cc.

◆ operator=() [4/4]

template<typename Number >

BlockVector & BlockVector< Number >::operator= ( const ::BlockVector< Number > & v )

Another copy function. This one takes a deal.II block vector and copies it into a TrilinosWrappers block vector. Note that the number of blocks has to be the same in the vector as in the input vector. Use the reinit() command for resizing the BlockVector or for changing the internal structure of the block components.

Since Trilinos only works on doubles, this function is limited to accept only one possible number type in the deal.II vector.

Definition at line 367 of file trilinos_parallel_block_vector.h.

◆ reinit() [1/4]

void BlockVector< Number >::reinit	(	const std::vector< IndexSet > &	parallel_partitioning,
		const MPI_Comm &	communicator = `MPI_COMM_WORLD`,
		const bool	omit_zeroing_entries = `false`
	)

Reinitialize the BlockVector to contain as many blocks as there are index sets given in the input argument, according to the parallel distribution of the individual components described in the maps.

If omit_zeroing_entries==false, the vector is filled with zeros.

Definition at line 70 of file trilinos_block_vector.cc.

◆ reinit() [2/4]

void BlockVector< Number >::reinit	(	const std::vector< IndexSet > &	partitioning,
		const std::vector< IndexSet > &	ghost_values,
		const MPI_Comm &	communicator = `MPI_COMM_WORLD`,
		const bool	vector_writable = `false`
	)

Reinit functionality. This function destroys the old vector content and generates a new one based on the input partitioning. In addition to just specifying one index set as in all the other methods above, this method allows to supply an additional set of ghost entries. There are two different versions of a vector that can be created. If the flag vector_writable is set to false, the vector only allows read access to the joint set of parallel_partitioning and ghost_entries. The effect of the reinit method is then equivalent to calling the other reinit method with an index set containing both the locally owned entries and the ghost entries.

If the flag vector_writable is set to true, this creates an alternative storage scheme for ghost elements that allows multiple threads to write into the vector (for the other reinit methods, only one thread is allowed to write into the ghost entries at a time).

Definition at line 95 of file trilinos_block_vector.cc.

◆ reinit() [3/4]

void BlockVector< Number >::reinit	(	const BlockVector &	V,
		const bool	omit_zeroing_entries = `false`
	)

Change the dimension to that of the vector V. The same applies as for the other reinit() function.

The elements of V are not copied, i.e. this function is the same as calling reinit (V.size(), omit_zeroing_entries).

Note that you must call this (or the other reinit() functions) function, rather than calling the reinit() functions of an individual block, to allow the block vector to update its caches of vector sizes. If you call reinit() on one of the blocks, then subsequent actions on this object may yield unpredictable results since they may be routed to the wrong block.

Definition at line 123 of file trilinos_block_vector.cc.

◆ reinit() [4/4]

void BlockVector< Number >::reinit ( const size_type num_blocks )

Change the number of blocks to num_blocks. The individual blocks will get initialized with zero size, so it is assumed that the user resizes the individual blocks by herself in an appropriate way, and calls collect_sizes afterwards.

Definition at line 138 of file trilinos_block_vector.cc.

◆ import_nonlocal_data_for_fe()

void BlockVector< Number >::import_nonlocal_data_for_fe	(	const TrilinosWrappers::BlockSparseMatrix &	m,
		const BlockVector &	v
	)

This reinit function is meant to be used for parallel calculations where some non-local data has to be used. The typical situation where one needs this function is the call of the FEValues<dim>::get_function_values function (or of some derivatives) in parallel. Since it is usually faster to retrieve the data in advance, this function can be called before the assembly forks out to the different processors. What this function does is the following: It takes the information in the columns of the given matrix and looks which data couples between the different processors. That data is then queried from the input vector. Note that you should not write to the resulting vector any more, since the some data can be stored several times on different processors, leading to unpredictable results. In particular, such a vector cannot be used for matrix- vector products as for example done during the solution of linear systems.

Definition at line 154 of file trilinos_block_vector.cc.

◆ has_ghost_elements()

bool BlockVector< Number >::has_ghost_elements ( ) const

inline

Return if this Vector contains ghost elements.

See also: vectors with ghost elements

Definition at line 388 of file trilinos_parallel_block_vector.h.

◆ swap()

void BlockVector< Number >::swap ( BlockVector & v )

inline

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.

Limitation: right now this function only works if both vectors have the same number of blocks. If needed, the numbers of blocks should be exchanged, too.

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.

Definition at line 401 of file trilinos_parallel_block_vector.h.

◆ print()

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

Print to a stream.

Definition at line 178 of file trilinos_block_vector.cc.

Friends And Related Function Documentation

◆ swap()

void swap	(	BlockVector &	u,
		BlockVector &	v
	)

Author: Martin Kronbichler, Wolfgang Bangerth, 2008

Definition at line 419 of file trilinos_parallel_block_vector.h.

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

deal.II/lac/trilinos_parallel_block_vector.h
source/lac/trilinos_block_vector.cc

Public Types

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ BlockType

◆ value_type

Constructor & Destructor Documentation

◆ BlockVector() [1/6]

◆ BlockVector() [2/6]

◆ BlockVector() [3/6]

◆ BlockVector() [4/6]

◆ BlockVector() [5/6]

◆ BlockVector() [6/6]

◆ ~BlockVector()

Member Function Documentation

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ reinit() [1/4]

◆ reinit() [2/4]

◆ reinit() [3/4]

◆ reinit() [4/4]

◆ import_nonlocal_data_for_fe()

◆ has_ghost_elements()

◆ swap()

◆ print()

Friends And Related Function Documentation

◆ swap()