Reference documentation for deal.II version GIT c1ef6fab04 2022-12-05 23:05:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData Class Reference

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

Inheritance diagram for RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData:
[legend]

Public Member Functions

 AdditionalData (const double relaxation=1., const bool invert_diagonal=true, const bool same_diagonal=false, const typename PreconditionBlockBase< InverseNumberType >::Inversion inversion=PreconditionBlockBase< InverseNumberType >::gauss_jordan, const double threshold=0., VectorType *temp_ghost_vector=nullptr)
 
std::size_t memory_consumption () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
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
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Public Attributes

SparsityPattern block_list
 
double relaxation
 
bool invert_diagonal
 
bool same_diagonal
 
PreconditionBlockBase< InverseNumberType >::Inversion inversion
 
double threshold = 0.
 
unsigned int kernel_size = 0
 
std::vector< std::vector< unsigned int > > order
 
VectorType * temp_ghost_vector
 

Private Types

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

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
 

Static Private Attributes

static std::mutex mutex
 

Detailed Description

template<typename MatrixType, typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
class RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData

Parameters for block relaxation methods. In addition to typical control parameters like relaxation, this object also contains the block structure in block_list and an optional ordering of the blocks in order.

Definition at line 81 of file relaxation_block.h.

Member Typedef Documentation

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::AdditionalData ( const double  relaxation = 1.,
const bool  invert_diagonal = true,
const bool  same_diagonal = false,
const typename PreconditionBlockBase< InverseNumberType >::Inversion  inversion = PreconditionBlockBase< InverseNumberType >::gauss_jordan,
const double  threshold = 0.,
VectorType *  temp_ghost_vector = nullptr 
)

Constructor.

Member Function Documentation

◆ memory_consumption()

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
std::size_t RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::memory_consumption ( ) const

Return the memory allocated in this object.

◆ subscribe()

void Subscriptor::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 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::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 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::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 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

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

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::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 309 of file subscriptor.h.

◆ check_no_subscribers()

void Subscriptor::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 subscriptor.cc.

Member Data Documentation

◆ block_list

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
SparsityPattern RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::block_list

The mapping from indices to blocks. Each row of this pattern enumerates the indices constituting a diagonal block to be inverted.

Definition at line 100 of file relaxation_block.h.

◆ relaxation

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
double RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::relaxation

Relaxation parameter.

Definition at line 105 of file relaxation_block.h.

◆ invert_diagonal

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
bool RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::invert_diagonal

Invert diagonal during initialization. Alternatively, diagonal blocks are inverted on the fly, whenever they are used. While inverting blocks in advance requires more memory, it usually saves a lot of computation. See same_diagonal on how you can avoid memory overhead.

Definition at line 113 of file relaxation_block.h.

◆ same_diagonal

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
bool RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::same_diagonal

Assume all diagonal blocks are equal to save memory. If this flag is true, then only the first diagonal block of the matrix is inverted and stored. It is then used for all other blocks.

Note
Avoid setting this true if your blocks are not equal, in particular if their sizes differ.

Definition at line 123 of file relaxation_block.h.

◆ inversion

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
PreconditionBlockBase<InverseNumberType>::Inversion RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::inversion

Choose the inversion method for the blocks.

Definition at line 128 of file relaxation_block.h.

◆ threshold

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
double RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::threshold = 0.

If inversion is SVD, we can compute the Penrose-Moore inverse of the blocks. In order to do so, we can specify here the threshold below which a singular value will be considered zero and thus not inverted. Setting this parameter to a value greater than zero takes precedence over threshold, i.e. kernel_size must be zero if you want to use threshold. This parameter is used in the call to LAPACKFullMatrix::compute_inverse_svd().

Definition at line 139 of file relaxation_block.h.

◆ kernel_size

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
unsigned int RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::kernel_size = 0

If inversion is SVD, we can compute the Penrose-Moore inverse of the blocks. In order to do so, we can specify here the size of the kernel that will not be inverted but considered zero. Setting this parameter to a value greater than zero takes precedence over threshold, i.e. kernel_size must be zero if you want to use threshold. This parameter is used in the call to LAPACKFullMatrix::compute_inverse_svd().

Definition at line 150 of file relaxation_block.h.

◆ order

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
std::vector<std::vector<unsigned int> > RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::order

The order in which blocks should be traversed. This vector can initiate several modes of execution:

  1. If the length of the vector is zero, then the relaxation method will be executed from first to last block.

  2. If the length is one, then the inner vector must have the same size as the number of blocks. The relaxation method is applied in the order given in this vector.

  3. If the outer vector has length greater one, then the relaxation method is applied several times, each time in the order given by the inner vector of the corresponding index. This mode can for instance be used for ADI methods and similar direction sweeps.

Definition at line 172 of file relaxation_block.h.

◆ temp_ghost_vector

template<typename MatrixType , typename InverseNumberType = typename MatrixType::value_type, typename VectorType = Vector<double>>
VectorType* RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData::temp_ghost_vector
mutable

Temporary ghost vector that is used in the relaxation method when performing parallel MPI computations. The user is required to have this point to an initialized vector that contains all indices that appear in the block_list sa ghost values. Typically, this the set of locally active level DoFs. Unused when VectorType is a serial vector type like Vector<double>.

Definition at line 182 of file relaxation_block.h.

◆ counter

std::atomic<unsigned int> Subscriptor::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 219 of file subscriptor.h.

◆ counter_map

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

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

Definition at line 225 of file subscriptor.h.

◆ validity_pointers

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

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

Definition at line 241 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::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 249 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.


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