Reference documentation for deal.II version 9.3.3
\(\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\}}\)
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PETScWrappers::PreconditionNone Class Reference
Linear algebra classes » PETScWrappers

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

Inheritance diagram for PETScWrappers::PreconditionNone:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 PreconditionNone ()=default
 
 PreconditionNone (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
 
void initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
 
void clear ()
 
void vmult (VectorBase &dst, const VectorBase &src) const
 
void Tvmult (VectorBase &dst, const VectorBase &src) const
 
const PC & get_pc () const
 

Protected Member Functions

void create_pc ()
 
 operator Mat () const
 

Protected Attributes

PC pc
 
Mat matrix
 

Private Attributes

AdditionalData additional_data
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 
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)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

A class that implements a non-preconditioned method.

Definition at line 984 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionNone() [1/2]

PETScWrappers::PreconditionNone::PreconditionNone ( )
default

Empty Constructor. You need to call initialize() before using this object.

◆ PreconditionNone() [2/2]

PETScWrappers::PreconditionNone::PreconditionNone ( const MatrixBase &  matrix,
const AdditionalData &  additional_data = AdditionalData() 
)

Constructor. Take the matrix which is used to form the preconditioner, and additional flags if there are any. The matrix is completely ignored in computations.

Definition at line 816 of file petsc_precondition.cc.

Member Function Documentation

◆ initialize()

void PETScWrappers::PreconditionNone::initialize ( const MatrixBase &  matrix,
const AdditionalData &  additional_data = AdditionalData() 
)

Initialize the preconditioner object and calculate all data that is necessary for applying it in a solver. This function is automatically called when calling the constructor with the same arguments and is only used if you create the preconditioner without arguments. The matrix is completely ignored in computations.

Definition at line 824 of file petsc_precondition.cc.

◆ clear()

void PETScWrappers::PreconditionBase::clear ( )
inherited

Destroys the preconditioner, leaving an object like just after having called the constructor.

Definition at line 52 of file petsc_precondition.cc.

◆ vmult()

void PETScWrappers::PreconditionBase::vmult ( VectorBase &  dst,
const VectorBase &  src 
) const
inherited

Apply the preconditioner once to the given src vector.

Definition at line 66 of file petsc_precondition.cc.

◆ Tvmult()

void PETScWrappers::PreconditionBase::Tvmult ( VectorBase &  dst,
const VectorBase &  src 
) const
inherited

Apply the transpose preconditioner once to the given src vector.

Definition at line 76 of file petsc_precondition.cc.

◆ get_pc()

const PC & PETScWrappers::PreconditionBase::get_pc ( ) const
inherited

Give access to the underlying PETSc object.

Definition at line 113 of file petsc_precondition.cc.

◆ create_pc()

void PETScWrappers::PreconditionBase::create_pc ( )
protectedinherited

Internal function to create the PETSc preconditioner object. Fails if called twice.

Definition at line 86 of file petsc_precondition.cc.

◆ operator Mat()

PETScWrappers::PreconditionBase::operator Mat ( ) const
protectedinherited

Conversion operator to get a representation of the matrix that represents this preconditioner. We use this inside the actual solver, where we need to pass this matrix to the PETSc solvers.

Definition at line 119 of file petsc_precondition.cc.

Member Data Documentation

◆ additional_data

AdditionalData PETScWrappers::PreconditionNone::additional_data
private

Store a copy of the flags for this particular preconditioner.

Definition at line 1023 of file petsc_precondition.h.

◆ pc

PC PETScWrappers::PreconditionBase::pc
protectedinherited

the PETSc preconditioner object

Definition at line 101 of file petsc_precondition.h.

◆ matrix

Mat PETScWrappers::PreconditionBase::matrix
protectedinherited

A pointer to the matrix that acts as a preconditioner.

Definition at line 106 of file petsc_precondition.h.

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