Reference documentation for deal.II version Git d4ec8156ca 2019-11-18 14:03:00 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | List of all members
PointerMatrixBase< VectorType > Class Template Referenceabstract

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

Inheritance diagram for PointerMatrixBase< VectorType >:
[legend]

Public Types

using value_type = typename VectorType::value_type
 

Public Member Functions

virtual ~PointerMatrixBase () override=default
 
virtual void clear ()=0
 
virtual void vmult (VectorType &dst, const VectorType &src) const =0
 
virtual void Tvmult (VectorType &dst, const VectorType &src) const =0
 
virtual void vmult_add (VectorType &dst, const VectorType &src) const =0
 
virtual void Tvmult_add (VectorType &dst, const VectorType &src) const =0
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (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)
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Detailed Description

template<typename VectorType>
class PointerMatrixBase< VectorType >

Abstract class for use in iterations. This class provides the interface required by LAC solver classes. It allows to use different concrete matrix classes in the same context, as long as they apply to the same vector class.

Deprecated:
Use LinearOperator instead
Author
Guido Kanschat, 2000, 2001, 2002

Definition at line 66 of file pointer_matrix.h.

Member Typedef Documentation

◆ value_type

template<typename VectorType>
using PointerMatrixBase< VectorType >::value_type = typename VectorType::value_type

Value type of this matrix. since the matrix itself is unknown, we take the value type of the vector. Therefore, matrix entries must be convertible to vector entries.

This was defined to make this matrix a possible template argument to BlockMatrixArray.

Definition at line 77 of file pointer_matrix.h.

Constructor & Destructor Documentation

◆ ~PointerMatrixBase()

template<typename VectorType>
virtual PointerMatrixBase< VectorType >::~PointerMatrixBase ( )
overridevirtualdefault

Virtual destructor. Does nothing except making sure that the destructor of any derived class is called whenever a pointer-to-base-class object is destroyed.

Member Function Documentation

◆ clear()

template<typename VectorType>
virtual void PointerMatrixBase< VectorType >::clear ( )
pure virtual

◆ vmult()

template<typename VectorType>
virtual void PointerMatrixBase< VectorType >::vmult ( VectorType &  dst,
const VectorType &  src 
) const
pure virtual

◆ Tvmult()

template<typename VectorType>
virtual void PointerMatrixBase< VectorType >::Tvmult ( VectorType &  dst,
const VectorType &  src 
) const
pure virtual

◆ vmult_add()

template<typename VectorType>
virtual void PointerMatrixBase< VectorType >::vmult_add ( VectorType &  dst,
const VectorType &  src 
) const
pure virtual

◆ Tvmult_add()

template<typename VectorType>
virtual void PointerMatrixBase< VectorType >::Tvmult_add ( VectorType &  dst,
const VectorType &  src 
) const
pure virtual

Transposed matrix-vector product, adding to dst.

Implemented in PointerMatrixVector< number >, PointerMatrixAux< MatrixType, VectorType >, and PointerMatrix< MatrixType, VectorType >.


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