SUNDIALS::SundialsOperator< VectorType > Struct Template Reference

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

Detailed Description

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

A linear operator that wraps SUNDIALS functionality.

Definition at line 46 of file sunlinsol_wrapper.h.

Public Member Functions
void	vmult (VectorType &dst, const VectorType &src) const
	SundialsOperator (void *A_data, SUNATimesFn a_times_fn, SUNContext linsol_ctx)

Private Attributes
void *	A_data
SUNATimesFn	a_times_fn
SUNContext	linsol_ctx

Constructor & Destructor Documentation

SundialsOperator()

template<typename VectorType>

SUNDIALS::SundialsOperator< VectorType >::SundialsOperator	(	void *	A_data,
		SUNATimesFn	a_times_fn,
		SUNContext	linsol_ctx )

Constructor.

Parameters

A_data	Data required by a_times_fn
a_times_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

Definition at line 364 of file sunlinsol_wrapper.cc.

Member Function Documentation

vmult()

template<typename VectorType>

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

Apply this LinearOperator to src and store the result in dst.

Definition at line 391 of file sunlinsol_wrapper.cc.

Member Data Documentation

A_data

template<typename VectorType>

void* SUNDIALS::SundialsOperator< VectorType >::A_data

private

Data necessary to evaluate a_times_fn.

Definition at line 79 of file sunlinsol_wrapper.h.

a_times_fn

template<typename VectorType>

SUNATimesFn SUNDIALS::SundialsOperator< VectorType >::a_times_fn

private

Function pointer declared by SUNDIALS to evaluate the matrix vector product.

Definition at line 86 of file sunlinsol_wrapper.h.

linsol_ctx

template<typename VectorType>

SUNContext SUNDIALS::SundialsOperator< VectorType >::linsol_ctx

private

Context object used for SUNDIALS logging.

Definition at line 91 of file sunlinsol_wrapper.h.

---

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

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