PETScWrappers::PreconditionSOR Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionSOR:

Classes
struct	AdditionalData

Public Member Functions
	PreconditionSOR ()=default
	PreconditionSOR (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
void	initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
Public Member Functions inherited from PETScWrappers::PreconditionerBase
	PreconditionerBase ()
virtual	~PreconditionerBase ()
void	clear ()
void	vmult (VectorBase &dst, const VectorBase &src) const
const PC &	get_pc () const

Protected Attributes
AdditionalData	additional_data
Protected Attributes inherited from PETScWrappers::PreconditionerBase
PC	pc
Mat	matrix

Additional Inherited Members
Protected Member Functions inherited from PETScWrappers::PreconditionerBase
void	create_pc ()
	operator Mat () const

Detailed Description

A class that implements the interface to use the PETSc SOR preconditioner.

Note

Only works in serial with a PETScWrappers::SparseMatrix.

Author

Wolfgang Bangerth, Timo Heister, 2004, 2011

Definition at line 276 of file petsc_precondition.h.

Constructor & Destructor Documentation

PreconditionSOR() [1/2]

PETScWrappers::PreconditionSOR::PreconditionSOR ( )

default

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

PreconditionSOR() [2/2]

PreconditionSOR< MatrixType >::PreconditionSOR	(	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.

Definition at line 221 of file petsc_precondition.cc.

Member Function Documentation

initialize()

void PreconditionSOR< MatrixType >::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.

Definition at line 229 of file petsc_precondition.cc.

Member Data Documentation

additional_data

AdditionalData PETScWrappers::PreconditionSOR::additional_data

protected

Store a copy of the flags for this particular preconditioner.

Definition at line 322 of file petsc_precondition.h.

---

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

• deal.II/lac/petsc_precondition.h
• source/lac/petsc_precondition.cc