PreconditionBlockSOR< MatrixType, inverse_type > Class Template Reference

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

Inheritance diagram for PreconditionBlockSOR< MatrixType, inverse_type >:

Public Types
using	size_type = types::global_dof_index
using	number = typename MatrixType::value_type

Public Member Functions
	PreconditionBlockSOR ()
template<typename number2 >
void	vmult (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	vmult_add (Vector< number2 > &, const Vector< number2 > &) const
template<typename number2 >
void	Tvmult (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
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
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 &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Types
enum	Inversion { gauss_jordan , householder , svd }

Protected Member Functions
	PreconditionBlockSOR (bool store)
template<typename number2 >
void	forward (Vector< number2 > &, const Vector< number2 > &, const bool transpose_diagonal, const bool adding) const
template<typename number2 >
void	backward (Vector< number2 > &, const Vector< number2 > &, const bool transpose_diagonal, const bool adding) const
void	initialize (const MatrixType &A, const AdditionalData parameters)
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 ()
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	reinit (unsigned int nblocks, size_type blocksize, bool compress, Inversion method=gauss_jordan)
void	inverses_computed (bool are_they)
bool	same_diagonal () const
bool	store_diagonals () const
bool	inverses_ready () const
unsigned int	size () const
template<typename number2 >
void	inverse_vmult (size_type i, Vector< number2 > &dst, const Vector< number2 > &src) const
template<typename number2 >
void	inverse_Tvmult (size_type i, Vector< number2 > &dst, const Vector< number2 > &src) const
FullMatrix< number > &	inverse (size_type i)
const FullMatrix< number > &	inverse (size_type i) const
Householder< number > &	inverse_householder (size_type i)
const Householder< number > &	inverse_householder (size_type i) const
LAPACKFullMatrix< number > &	inverse_svd (size_type i)
const LAPACKFullMatrix< number > &	inverse_svd (size_type i) const
FullMatrix< number > &	diagonal (size_type i)
const FullMatrix< number > &	diagonal (size_type i) const
void	log_statistics () const

Static Protected Member Functions
static ::ExceptionBase &	ExcWrongBlockSize (int arg1, int arg2)
static ::ExceptionBase &	ExcInverseMatricesAlreadyExist ()
static ::ExceptionBase &	ExcDiagonalsNotStored ()
static ::ExceptionBase &	ExcInverseNotAvailable ()

Protected Attributes
size_type	blocksize
ObserverPointer< const MatrixType, PreconditionBlock< MatrixType, inverse_type > >	A
double	relaxation
std::vector< size_type >	permutation
std::vector< size_type >	inverse_permutation
Inversion	inversion

Private Types
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator
using	value_type = inverse_type

Private Member Functions
void	check_no_subscribers () const noexcept

Private Attributes
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
unsigned int	n_diagonal_blocks
std::vector< FullMatrix< number > >	var_inverse_full
std::vector< Householder< number > >	var_inverse_householder
std::vector< LAPACKFullMatrix< number > >	var_inverse_svd
std::vector< FullMatrix< number > >	var_diagonal
bool	var_store_diagonals
bool	var_same_diagonal
bool	var_inverses_ready

Static Private Attributes
static std::mutex	mutex

Detailed Description

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

Block SOR preconditioning. This class satisfies the relaxation concept.

The functions vmult and Tvmult execute a (transposed) block-SOR step, based on the blocks in PreconditionBlock. The elements outside the diagonal blocks may be distributed arbitrarily.

See PreconditionBlock for requirements on the matrix. The blocks used in this class must be contiguous and non-overlapping. An overlapping Schwarz relaxation method can be found in RelaxationBlockSOR; that class does not offer preconditioning, though.

Permutations

Optionally, the entries of the source vector can be treated in the order of the indices in the permutation vector set by set_permutation (or the opposite order for Tvmult()). The inverse permutation is used for storing elements back into this vector. This functionality is automatically enabled after a call to set_permutation() with vectors of nonzero size.

Note

The diagonal blocks, like the matrix, are not permuted! Therefore, the permutation vector can only swap whole blocks. It may not change the order inside blocks or swap single indices between blocks.

Instantiations

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).

Definition at line 655 of file precondition_block.h.

Member Typedef Documentation

size_type

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

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

Declare type for container size.

Definition at line 663 of file precondition_block.h.

number

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

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

Define number type of matrix.

Definition at line 673 of file precondition_block.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.

value_type

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

using PreconditionBlock< MatrixType, inverse_type >::value_type = inverse_type

privateinherited

Value type for inverse matrices.

Definition at line 93 of file precondition_block.h.

Member Enumeration Documentation

Inversion

template<typename number >

enum PreconditionBlockBase::Inversion

inherited

Choose a method for inverting the blocks, and thus the data type for the inverses.

Enumerator
gauss_jordan	Use the standard Gauss-Jacobi method implemented in FullMatrix::inverse().
householder	Use QR decomposition of the Householder class.
svd	Use the singular value decomposition of LAPACKFullMatrix.

Definition at line 70 of file precondition_block_base.h.

Constructor & Destructor Documentation

PreconditionBlockSOR() [1/2]

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

PreconditionBlockSOR< MatrixType, inverse_type >::PreconditionBlockSOR

(

)

Default constructor.

PreconditionBlockSOR() [2/2]

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

PreconditionBlockSOR< MatrixType, inverse_type >::PreconditionBlockSOR ( bool  store )

protected

Constructor to be used by PreconditionBlockSSOR.

Member Function Documentation

vmult()

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

template<typename number2 >

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

Execute block SOR preconditioning.

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

For matrices which are empty above the diagonal blocks BlockSOR is a direct solver.

vmult_add()

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

template<typename number2 >

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

Execute block SOR preconditioning.

Warning: this function performs normal vmult without adding.

See also

vmult

Tvmult()

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

template<typename number2 >

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

Backward application of vmult().

In the current implementation, this is not the transpose of vmult(). It is a transposed Gauss-Seidel algorithm applied to the whole matrix, but the diagonal blocks being inverted are not transposed. Therefore, it is the transposed, if the diagonal blocks are symmetric.

Tvmult_add()

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

template<typename number2 >

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

Execute backward block SOR preconditioning.

Warning: this function performs normal vmult without adding.

See also

vmult

step()

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

template<typename number2 >

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

Perform one step of the SOR iteration.

Tstep()

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

template<typename number2 >

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

Perform one step of the transposed SOR iteration.

forward()

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

template<typename number2 >

void PreconditionBlockSOR< MatrixType, inverse_type >::forward ( Vector< number2 > &  , const Vector< number2 > &  , const bool  transpose_diagonal, const bool  adding  ) const

protected

Implementation of the forward substitution loop called by vmult() and vmult_add().

If a permutation is set by set_permutation(), it will automatically be honored by this function.

The parameter adding does not have any function, yet.

backward()

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

template<typename number2 >

void PreconditionBlockSOR< MatrixType, inverse_type >::backward ( Vector< number2 > &  , const Vector< number2 > &  , const bool  transpose_diagonal, const bool  adding  ) const

protected

Implementation of the backward substitution loop called by Tvmult() and Tvmult_add().

If a permutation is set by set_permutation(), it will automatically be honored by this function.

The parameter adding does not have any function, yet.

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.

initialize() [1/2]

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

void PreconditionBlock< MatrixType, inverse_type >::initialize ( const MatrixType &  A, const AdditionalData  parameters  )

inherited

Initialize matrix and block size. We store the matrix and the block size in the preconditioner object. In a second step, the inverses of the diagonal blocks may be computed.

Additionally, a relaxation parameter for derived classes may be provided.

initialize() [2/2]

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

void PreconditionBlock< MatrixType, inverse_type >::initialize ( const MatrixType &  A, const std::vector< size_type > &  permutation, const std::vector< size_type > &  inverse_permutation, const AdditionalData  parameters  )

protectedinherited

Initialize matrix and block size for permuted preconditioning. Additionally to the parameters of the other initialize() function, we hand over two index vectors with the permutation and its inverse. For the meaning of these vectors see PreconditionBlockSOR.

In a second step, the inverses of the diagonal blocks may be computed. Make sure you use invert_permuted_diagblocks() to yield consistent data.

Additionally, a relaxation parameter for derived classes may be provided.

set_permutation()

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

void PreconditionBlock< MatrixType, inverse_type >::set_permutation ( const std::vector< size_type > &  permutation, const std::vector< size_type > &  inverse_permutation  )

protectedinherited

Set either the permutation of rows or the permutation of blocks, depending on the size of the vector.

If the size of the permutation vectors is equal to the dimension of the linear system, it is assumed that rows are permuted individually. In this case, set_permutation() must be called before initialize(), since the diagonal blocks are built from the permuted entries of the matrix.

If the size of the permutation vector is not equal to the dimension of the system, the diagonal blocks are computed from the unpermuted entries. Instead, the relaxation methods step() and Tstep() are executed applying the blocks in the order given by the permutation vector. They will throw an exception if length of this vector is not equal to the number of blocks.

Note

Permutation of blocks can only be applied to the relaxation operators step() and Tstep(), not to the preconditioning operators vmult() and Tvmult().

It is safe to call set_permutation() before initialize(), while the other order is only admissible for block permutation.

invert_permuted_diagblocks()

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

void PreconditionBlock< MatrixType, inverse_type >::invert_permuted_diagblocks ( )

protectedinherited

Replacement of invert_diagblocks() for permuted preconditioning.

clear()

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

void PreconditionBlock< MatrixType, inverse_type >::clear ( )

inherited

Deletes the inverse diagonal block matrices if existent, sets the blocksize to 0, hence leaves the class in the state that it had directly after calling the constructor.

empty()

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

bool PreconditionBlock< MatrixType, inverse_type >::empty ( ) const

inherited

Check whether the object is empty.

el()

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

value_type PreconditionBlock< MatrixType, inverse_type >::el ( size_type  i, size_type  j  ) const

inherited

Read-only access to entries. This function is only possible if the inverse diagonal blocks are stored.

invert_diagblocks()

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

void PreconditionBlock< MatrixType, inverse_type >::invert_diagblocks ( )

inherited

Stores the inverse of the diagonal blocks in inverse. This costs some additional memory - for DG methods about 1/3 (for double inverses) or 1/6 (for float inverses) of that used for the matrix - but it makes the preconditioning much faster.

It is not allowed to call this function twice (will produce an error) before a call of clear(...) because at the second time there already exist the inverse matrices.

After this function is called, the lock on the matrix given through the use_matrix function is released, i.e. you may overwrite of delete it. You may want to do this in case you use this matrix to precondition another matrix.

forward_step()

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

template<typename number2 >

void PreconditionBlock< MatrixType, inverse_type >::forward_step ( Vector< number2 > &  dst, const Vector< number2 > &  prev, const Vector< number2 > &  src, const bool  transpose_diagonal  ) const

inherited

Perform one block relaxation step in forward numbering.

Depending on the arguments dst and pref, this performs an SOR step (both reference the same vector) of a Jacobi step (both different vectors). For the Jacobi step, the calling function must copy dst to pref after this.

Note

If a permutation is set, it is automatically honored by this function.

backward_step()

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

template<typename number2 >

void PreconditionBlock< MatrixType, inverse_type >::backward_step ( Vector< number2 > &  dst, const Vector< number2 > &  prev, const Vector< number2 > &  src, const bool  transpose_diagonal  ) const

inherited

Perform one block relaxation step in backward numbering.

Depending on the arguments dst and pref, this performs an SOR step (both reference the same vector) of a Jacobi step (both different vectors). For the Jacobi step, the calling function must copy dst to pref after this.

Note

If a permutation is set, it is automatically honored by this function.

block_size()

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

size_type PreconditionBlock< MatrixType, inverse_type >::block_size ( ) const

inherited

Return the size of the blocks.

memory_consumption()

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

std::size_t PreconditionBlock< MatrixType, inverse_type >::memory_consumption ( ) const

inherited

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

reinit()

template<typename number >

void PreconditionBlockBase< number >::reinit ( unsigned int  nblocks, size_type  blocksize, bool  compress, Inversion  method = gauss_jordan  )

inlineinherited

Resize to this number of diagonal blocks with the given block size. If compress is true, then only one block will be stored.

Definition at line 333 of file precondition_block_base.h.

inverses_computed()

template<typename number >

void PreconditionBlockBase< number >::inverses_computed ( bool  are_they )

inlineinherited

Tell the class that inverses are computed.

Definition at line 598 of file precondition_block_base.h.

same_diagonal()

template<typename number >

bool PreconditionBlockBase< number >::same_diagonal ( ) const

inlineinherited

Does the matrix use only one diagonal block?

Definition at line 582 of file precondition_block_base.h.

store_diagonals()

template<typename number >

bool PreconditionBlockBase< number >::store_diagonals ( ) const

inlineinherited

Check, whether diagonal blocks (not their inverses) should be stored.

Definition at line 590 of file precondition_block_base.h.

inverses_ready()

template<typename number >

bool PreconditionBlockBase< number >::inverses_ready ( ) const

inlineinherited

Return true, if inverses are ready for use.

Definition at line 606 of file precondition_block_base.h.

size()

template<typename number >

unsigned int PreconditionBlockBase< number >::size ( ) const

inlineinherited

The number of blocks.

Definition at line 411 of file precondition_block_base.h.

inverse_vmult()

template<typename number >

template<typename number2 >

void PreconditionBlockBase< number >::inverse_vmult ( size_type  i, Vector< number2 > &  dst, const Vector< number2 > &  src  ) const

inlineinherited

Multiply with the inverse block at position i.

Definition at line 419 of file precondition_block_base.h.

inverse_Tvmult()

template<typename number >

template<typename number2 >

void PreconditionBlockBase< number >::inverse_Tvmult ( size_type  i, Vector< number2 > &  dst, const Vector< number2 > &  src  ) const

inlineinherited

Multiply with the transposed inverse block at position i.

Definition at line 448 of file precondition_block_base.h.

inverse() [1/2]

template<typename number >

FullMatrix< number > & PreconditionBlockBase< number >::inverse ( size_type  i )

inlineinherited

Access to the inverse diagonal blocks if Inversion is gauss_jordan.

Definition at line 526 of file precondition_block_base.h.

inverse() [2/2]

template<typename number >

const FullMatrix< number > & PreconditionBlockBase< number >::inverse ( size_type  i ) const

inlineinherited

Access to the inverse diagonal blocks.

Definition at line 476 of file precondition_block_base.h.

inverse_householder() [1/2]

template<typename number >

Householder< number > & PreconditionBlockBase< number >::inverse_householder ( size_type  i )

inlineinherited

Access to the inverse diagonal blocks if Inversion is householder.

Definition at line 540 of file precondition_block_base.h.

inverse_householder() [2/2]

template<typename number >

const Householder< number > & PreconditionBlockBase< number >::inverse_householder ( size_type  i ) const

inlineinherited

Access to the inverse diagonal blocks if Inversion is householder.

Definition at line 488 of file precondition_block_base.h.

inverse_svd() [1/2]

template<typename number >

LAPACKFullMatrix< number > & PreconditionBlockBase< number >::inverse_svd ( size_type  i )

inlineinherited

Access to the inverse diagonal blocks if Inversion is householder.

Definition at line 554 of file precondition_block_base.h.

inverse_svd() [2/2]

template<typename number >

const LAPACKFullMatrix< number > & PreconditionBlockBase< number >::inverse_svd ( size_type  i ) const

inlineinherited

Access to the inverse diagonal blocks if Inversion is householder.

Definition at line 500 of file precondition_block_base.h.

diagonal() [1/2]

template<typename number >

FullMatrix< number > & PreconditionBlockBase< number >::diagonal ( size_type  i )

inlineinherited

Access to the diagonal blocks.

Definition at line 568 of file precondition_block_base.h.

diagonal() [2/2]

template<typename number >

const FullMatrix< number > & PreconditionBlockBase< number >::diagonal ( size_type  i ) const

inlineinherited

Access to the diagonal blocks.

Definition at line 512 of file precondition_block_base.h.

log_statistics()

template<typename number >

void PreconditionBlockBase< number >::log_statistics ( ) const

inlineinherited

Print some statistics about the inverses to deallog. Output depends on Inversion. It is richest for svd, where we obtain statistics on extremal singular values and condition numbers.

Definition at line 614 of file precondition_block_base.h.

Member Data Documentation

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.

mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.h.

blocksize

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

size_type PreconditionBlock< MatrixType, inverse_type >::blocksize

protectedinherited

Size of the blocks. Each diagonal block is assumed to be of the same size.

Definition at line 337 of file precondition_block.h.

A

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

ObserverPointer<const MatrixType, PreconditionBlock<MatrixType, inverse_type> > PreconditionBlock< MatrixType, inverse_type >::A

protectedinherited

Pointer to the matrix. Make sure that the matrix exists as long as this class needs it, i.e. until calling invert_diagblocks, or (if the inverse matrices should not be stored) until the last call of the preconditoining vmult function of the derived classes.

Definition at line 346 of file precondition_block.h.

relaxation

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

double PreconditionBlock< MatrixType, inverse_type >::relaxation

protectedinherited

Relaxation parameter to be used by derived classes.

Definition at line 350 of file precondition_block.h.

permutation

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

std::vector<size_type> PreconditionBlock< MatrixType, inverse_type >::permutation

protectedinherited

The permutation vector

Definition at line 355 of file precondition_block.h.

inverse_permutation

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

std::vector<size_type> PreconditionBlock< MatrixType, inverse_type >::inverse_permutation

protectedinherited

The inverse permutation vector

Definition at line 360 of file precondition_block.h.

inversion

template<typename number >

Inversion PreconditionBlockBase< number >::inversion

protectedinherited

The method used for inverting blocks.

Definition at line 243 of file precondition_block_base.h.

n_diagonal_blocks

template<typename number >

unsigned int PreconditionBlockBase< number >::n_diagonal_blocks

privateinherited

The number of (inverse) diagonal blocks, if only one is stored.

Definition at line 249 of file precondition_block_base.h.

var_inverse_full

template<typename number >

std::vector<FullMatrix<number> > PreconditionBlockBase< number >::var_inverse_full

privateinherited

Storage of the inverse matrices of the diagonal blocks matrices as FullMatrix<number> matrices, if Inversion gauss_jordan is used. Using number=float saves memory in comparison with number=double, but may introduce numerical instability.

Definition at line 257 of file precondition_block_base.h.

var_inverse_householder

template<typename number >

std::vector<Householder<number> > PreconditionBlockBase< number >::var_inverse_householder

privateinherited

Storage of the inverse matrices of the diagonal blocks matrices as Householder matrices if Inversion householder is used. Using number=float saves memory in comparison with number=double, but may introduce numerical instability.

Definition at line 265 of file precondition_block_base.h.

var_inverse_svd

template<typename number >

std::vector<LAPACKFullMatrix<number> > PreconditionBlockBase< number >::var_inverse_svd

privateinherited

Storage of the inverse matrices of the diagonal blocks matrices as LAPACKFullMatrix matrices if Inversion svd is used. Using number=float saves memory in comparison with number=double, but may introduce numerical instability.

Definition at line 273 of file precondition_block_base.h.

var_diagonal

template<typename number >

std::vector<FullMatrix<number> > PreconditionBlockBase< number >::var_diagonal

privateinherited

Storage of the original diagonal blocks.

Used by the blocked SSOR method.

Definition at line 280 of file precondition_block_base.h.

var_store_diagonals

template<typename number >

bool PreconditionBlockBase< number >::var_store_diagonals

privateinherited

This is true, if the field var_diagonal is to be used.

Definition at line 286 of file precondition_block_base.h.

var_same_diagonal

template<typename number >

bool PreconditionBlockBase< number >::var_same_diagonal

privateinherited

This is true, if only one inverse is stored.

Definition at line 291 of file precondition_block_base.h.

var_inverses_ready

template<typename number >

bool PreconditionBlockBase< number >::var_inverses_ready

privateinherited

The inverse matrices are usable. Set by the parent class via inverses_computed().

Definition at line 297 of file precondition_block_base.h.

---

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

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