Reference documentation for deal.II version GIT relicensing-860-g3e6195f9ee 2024-06-20 00:40:01+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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
SUNDIALS::SundialsOperator< VectorType > Struct Template Reference

#include <deal.II/sundials/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
 

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.

Constructor & Destructor Documentation

◆ SundialsOperator()

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

Constructor.

Parameters
A_dataData required by a_times_fn
a_times_fnA function pointer to the function that computes A*v
linsol_ctxThe context object used to set up the linear solver and all vectors

Definition at line 361 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 388 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: