SUNDIALS::SundialsPreconditioner< VectorType > Struct Template Reference

#include <deal.II/sundials/sunlinsol_wrapper.h>

Detailed Description

template<typename VectorType>
struct SUNDIALS::SundialsPreconditioner< VectorType >

A linear operator that wraps preconditioner functionality as specified by SUNDIALS. The vmult() function solves the preconditioner equation \(Px=b\), i.e., it computes \(x=P^{-1}b\).

Definition at line 110 of file sunlinsol_wrapper.h.

Public Member Functions
void	vmult (VectorType &dst, const VectorType &src) const
	SundialsPreconditioner (void *P_data, SUNPSolveFn p_solve_fn, SUNContext linsol_ctx, double tol)

Private Attributes
void *	P_data
SUNPSolveFn	p_solve_fn
SUNContext	linsol_ctx
double	tol

Constructor & Destructor Documentation

SundialsPreconditioner()

template<typename VectorType >

SUNDIALS::SundialsPreconditioner< VectorType >::SundialsPreconditioner	(	void *	P_data,
		SUNPSolveFn	p_solve_fn,
		SUNContext	linsol_ctx,
		double	tol
	)

Constructor.

Parameters

P_data	Data required by p_solve_fn
p_solve_fn	A function pointer to the function that computes A*v
linsol_ctx	The context object used to set up the linear solver and all vectors
tol	Tolerance, that an iterative solver should use to judge convergence

Note

This function is only available with SUNDIALS 6.0.0 and later. 6.0.0. If you are using an earlier version of SUNDIALS then you need to use the other constructor.

Member Function Documentation

vmult()

template<typename VectorType >

void SUNDIALS::SundialsPreconditioner< VectorType >::vmult	(	VectorType &	dst,
		const VectorType &	src
	)		const

Apply the wrapped preconditioner, i.e., solve \(Px=b\) where \(x\) is the dst vector and \(b\) the src vector.

Parameters

dst	Result vector of the preconditioner application
src	Target vector of the preconditioner application

Member Data Documentation

P_data

template<typename VectorType >

void* SUNDIALS::SundialsPreconditioner< VectorType >::P_data

private

Data necessary to calls p_solve_fn

Definition at line 160 of file sunlinsol_wrapper.h.

p_solve_fn

template<typename VectorType >

SUNPSolveFn SUNDIALS::SundialsPreconditioner< VectorType >::p_solve_fn

private

Function pointer to a function that computes the preconditioner application.

Definition at line 167 of file sunlinsol_wrapper.h.

linsol_ctx

template<typename VectorType >

SUNContext SUNDIALS::SundialsPreconditioner< VectorType >::linsol_ctx

private

Context object used for SUNDIALS logging.

Definition at line 172 of file sunlinsol_wrapper.h.

tol

template<typename VectorType >

double SUNDIALS::SundialsPreconditioner< VectorType >::tol

private

Potential tolerance to use in the internal solve of the preconditioner equation.

Definition at line 185 of file sunlinsol_wrapper.h.

---

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

• include/deal.II/sundials/sunlinsol_wrapper.h