Reference documentation for deal.II version GIT relicensing-1291-gf3a46e514e 2024-07-24 11:20:02+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\}}\)
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
SLEPcWrappers::TransformationBase Class Reference

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

Inheritance diagram for SLEPcWrappers::TransformationBase:
Inheritance graph

Public Member Functions

virtual ~TransformationBase ()
void set_matrix_mode (const STMatMode mode)
void set_solver (const PETScWrappers::SolverBase &solver)

Protected Member Functions

 TransformationBase (const MPI_Comm mpi_communicator)

Protected Attributes

ST st


class SolverBase

Detailed Description

Base class for spectral transformation classes using the SLEPc solvers which are selected based on flags passed to the spectral transformation.

SLEPcWrappers::TransformationXXX, where XXX is your favourite transformation type, can then be implemented in application codes in the following way for XXX=INVERT with the solver object eigensolver:

// Set a transformation, this one shifts the eigenspectrum by 3.142..
SLEPcWrappers::TransformationShift shift(mpi_communicator,additional_data);

and later calling the solve() function as usual:

SolverControl solver_control (1000, 1e-9);
SolverArnoldi system (solver_control, mpi_communicator);
eigensolver.solve (A, B, lambda, x, size_of_spectrum);
These options can also be set at the command line.

Definition at line 75 of file slepc_spectral_transformation.h.

Constructor & Destructor Documentation

◆ TransformationBase()

SLEPcWrappers::TransformationBase::TransformationBase ( const MPI_Comm  mpi_communicator)


Definition at line 31 of file

◆ ~TransformationBase()

SLEPcWrappers::TransformationBase::~TransformationBase ( )


Definition at line 37 of file

Member Function Documentation

◆ set_matrix_mode()

void SLEPcWrappers::TransformationBase::set_matrix_mode ( const STMatMode  mode)

Set a flag to indicate how the transformed matrices are being stored in the spectral transformations.

The possible values are given by the enumerator STMatMode in the SLEPc library

Definition at line 48 of file

◆ set_solver()

void SLEPcWrappers::TransformationBase::set_solver ( const PETScWrappers::SolverBase solver)

Set solver to be used when solving a system of linear algebraic equations inside the eigensolver.

Definition at line 55 of file

Friends And Related Symbol Documentation

◆ SolverBase

friend class SolverBase

Definition at line 115 of file slepc_spectral_transformation.h.

Member Data Documentation

◆ st

ST SLEPcWrappers::TransformationBase::st

SLEPc spectral transformation object.

Definition at line 111 of file slepc_spectral_transformation.h.

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