Reference documentation for deal.II version 9.6.0
\(\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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
PreconditionLU< number > Class Template Reference
Linear algebra classes | Linear algebra classes » Matrix classes » Preconditioners and Relaxation Operators

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

Inheritance diagram for PreconditionLU< number >:
Inheritance graph
[legend]

Public Member Functions

void initialize (const LAPACKFullMatrix< number > &)
 
void initialize (const LAPACKFullMatrix< number > &, VectorMemory< Vector< number > > &)
 
void vmult (Vector< number > &, const Vector< number > &) const
 
void Tvmult (Vector< number > &, const Vector< number > &) const
 
void vmult (BlockVector< number > &, const BlockVector< number > &) const
 
void Tvmult (BlockVector< number > &, const BlockVector< number > &) 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 ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 

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

SmartPointer< const LAPACKFullMatrix< number >, PreconditionLU< number > > matrix
 
SmartPointer< VectorMemory< Vector< number > >, PreconditionLU< number > > mem
 
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 number>
class PreconditionLU< number >

A preconditioner based on the LU-factorization of LAPACKFullMatrix.

Definition at line 1010 of file lapack_full_matrix.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 229 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 234 of file subscriptor.h.

Member Function Documentation

◆ initialize() [1/2]

template<typename number >
void PreconditionLU< number >::initialize ( const LAPACKFullMatrix< number > & M)

Definition at line 2581 of file lapack_full_matrix.cc.

◆ initialize() [2/2]

template<typename number >
void PreconditionLU< number >::initialize ( const LAPACKFullMatrix< number > & M,
VectorMemory< Vector< number > > & V )

Definition at line 2590 of file lapack_full_matrix.cc.

◆ vmult() [1/2]

template<typename number >
void PreconditionLU< number >::vmult ( Vector< number > & dst,
const Vector< number > & src ) const

Definition at line 2600 of file lapack_full_matrix.cc.

◆ Tvmult() [1/2]

template<typename number >
void PreconditionLU< number >::Tvmult ( Vector< number > & dst,
const Vector< number > & src ) const

Definition at line 2610 of file lapack_full_matrix.cc.

◆ vmult() [2/2]

template<typename number >
void PreconditionLU< number >::vmult ( BlockVector< number > & dst,
const BlockVector< number > & src ) const

Definition at line 2620 of file lapack_full_matrix.cc.

◆ Tvmult() [2/2]

template<typename number >
void PreconditionLU< number >::Tvmult ( BlockVector< number > & dst,
const BlockVector< number > & src ) const

Definition at line 2633 of file lapack_full_matrix.cc.

◆ 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 135 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 155 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 203 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 52 of file subscriptor.cc.

Member Data Documentation

◆ matrix

template<typename number >
SmartPointer<const LAPACKFullMatrix<number>, PreconditionLU<number> > PreconditionLU< number >::matrix
private

Definition at line 1027 of file lapack_full_matrix.h.

◆ mem

template<typename number >
SmartPointer<VectorMemory<Vector<number> >, PreconditionLU<number> > PreconditionLU< number >::mem
private

Definition at line 1028 of file lapack_full_matrix.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 218 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 224 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 240 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 248 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::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 271 of file subscriptor.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.11.0