PreconditionBlockJacobi< MatrixType, inverse_type > Class Template Reference

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

Inheritance diagram for PreconditionBlockJacobi< MatrixType, inverse_type >:

Classes
class	const_iterator

Public Types
using	size_type = types::global_dof_index

Public Member Functions
template<typename number2 >
void	vmult (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	Tvmult (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	vmult_add (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	Tvmult_add (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	step (Vector< number2 > &dst, const Vector< number2 > &rhs) const
template<typename number2 >
void	Tstep (Vector< number2 > &dst, const Vector< number2 > &rhs) const
const_iterator	begin () const
const_iterator	end () const
const_iterator	begin (const size_type r) const
const_iterator	end (const size_type r) 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)

Private Types
using	number = typename MatrixType::value_type
Private Types inherited from PreconditionBlock< MatrixType, inverse_type >
using	size_type = types::global_dof_index

Private Member Functions
template<typename number2 >
void	do_vmult (Vector< number2 > &, const Vector< number2 > &, bool adding) const
Private Member Functions inherited from PreconditionBlock< MatrixType, inverse_type >
	PreconditionBlock (bool store_diagonals=false)
	~PreconditionBlock () override=default
void	initialize (const MatrixType &A, const AdditionalData parameters)
void	clear ()
bool	empty () const
value_type	el (size_type i, size_type j) const
void	invert_diagblocks ()
template<typename number2 >
void	forward_step (Vector< number2 > &dst, const Vector< number2 > &prev, const Vector< number2 > &src, const bool transpose_diagonal) const
template<typename number2 >
void	backward_step (Vector< number2 > &dst, const Vector< number2 > &prev, const Vector< number2 > &src, const bool transpose_diagonal) const
size_type	block_size () const
std::size_t	memory_consumption () const
void	initialize (const MatrixType &A, const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation, const AdditionalData parameters)
void	set_permutation (const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation)
void	invert_permuted_diagblocks ()

Additional Inherited Members
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)
Static Private Member Functions inherited from PreconditionBlock< MatrixType, inverse_type >
static ::ExceptionBase &	ExcWrongBlockSize (int arg1, int arg2)
static ::ExceptionBase &	ExcInverseMatricesAlreadyExist ()
Private Attributes inherited from PreconditionBlock< MatrixType, inverse_type >
size_type	blocksize
SmartPointer< const MatrixType, PreconditionBlock< MatrixType, inverse_type > >	A
double	relaxation
std::vector< size_type >	permutation
std::vector< size_type >	inverse_permutation

Detailed Description

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>
class PreconditionBlockJacobi< MatrixType, inverse_type >

Block Jacobi preconditioning. See PreconditionBlock for requirements on the matrix. This class satisfies the relaxation concept.

Note

Instantiations for this template are provided for <float> and <double>; others can be generated in application programs (see the section on Template instantiations in the manual).

Author

Ralf Hartmann, Guido Kanschat, 1999, 2000, 2003

Definition at line 382 of file precondition_block.h.

Member Typedef Documentation

number

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

using PreconditionBlockJacobi< MatrixType, inverse_type >::number = typename MatrixType::value_type

private

Define number type of matrix.

Definition at line 390 of file precondition_block.h.

size_type

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

using PreconditionBlockJacobi< MatrixType, inverse_type >::size_type = types::global_dof_index

Declare type for container size.

Definition at line 396 of file precondition_block.h.

Member Function Documentation

vmult()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

template void PreconditionBlockJacobi< MatrixType, inverse_type >::vmult< double >	(	Vector< number2 > &	,
		const Vector< number2 > &
	)		const

Execute block Jacobi preconditioning.

This function will automatically use the inverse matrices if they exist, if not then BlockJacobi will need much time inverting the diagonal block matrices in each preconditioning step.

Tvmult()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

template void PreconditionBlockJacobi< MatrixType, inverse_type >::Tvmult< double >	(	Vector< number2 > &	,
		const Vector< number2 > &
	)		const

Same as vmult, since Jacobi is symmetric.

vmult_add()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

template void PreconditionBlockJacobi< MatrixType, inverse_type >::vmult_add< double >	(	Vector< number2 > &	,
		const Vector< number2 > &
	)		const

Execute block Jacobi preconditioning, adding to dst.

This function will automatically use the inverse matrices if they exist, if not then BlockJacobi will need much time inverting the diagonal block matrices in each preconditioning step.

Tvmult_add()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

template void PreconditionBlockJacobi< MatrixType, inverse_type >::Tvmult_add< double >	(	Vector< number2 > &	,
		const Vector< number2 > &
	)		const

Same as vmult_add, since Jacobi is symmetric.

step()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

void PreconditionBlockJacobi< MatrixType, inverse_type >::step	(	Vector< number2 > &	dst,
		const Vector< number2 > &	rhs
	)		const

Perform one step of the Jacobi iteration.

Tstep()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

void PreconditionBlockJacobi< MatrixType, inverse_type >::Tstep	(	Vector< number2 > &	dst,
		const Vector< number2 > &	rhs
	)		const

Perform one step of the Jacobi iteration.

begin() [1/2]

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

const_iterator PreconditionBlockJacobi< MatrixType, inverse_type >::begin

(

)

const

Iterator starting at the first entry.

end() [1/2]

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

const_iterator PreconditionBlockJacobi< MatrixType, inverse_type >::end

(

)

const

Final iterator.

begin() [2/2]

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

const_iterator PreconditionBlockJacobi< MatrixType, inverse_type >::begin

(

const size_type

r

)

const

Iterator starting at the first entry of row r.

end() [2/2]

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

const_iterator PreconditionBlockJacobi< MatrixType, inverse_type >::end

(

const size_type

r

)

const

Final iterator of row r.

do_vmult()

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

void PreconditionBlockJacobi< MatrixType, inverse_type >::do_vmult ( Vector< number2 > &  , const Vector< number2 > &  , bool  adding  ) const

private

Actual implementation of the preconditioner.

Depending on adding, the result of preconditioning is added to the destination vector.

---

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

• deal.II/lac/precondition_block.h
• source/lac/precondition_block_ez.cc