Reference documentation for deal.II version GIT 29f9da0a34 2023-12-07 10:00: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\}}\)
Namespaces | Classes | Typedefs | Functions
SUNDIALS Namespace Reference




class  ARKode
class  IDA
class  KINSOL
struct  SundialsOperator
struct  SundialsPreconditioner


using realtype = ::sunrealtype
template<typename VectorType >
using LinearSolveFunction = std::function< void(SundialsOperator< VectorType > &op, SundialsPreconditioner< VectorType > &prec, VectorType &x, const VectorType &b, double tol)>


 DeclException1 (ExcARKodeError, int,<< "One of the SUNDIALS ARKode internal functions "<< " returned a negative error code: "<< arg1<< ". Please consult SUNDIALS manual.")
static ::ExceptionBaseExcSundialsSolverError (int arg1)

Detailed Description

A namespace for dealing with ODE solvers through the SUNDIALS package.

Typedef Documentation

◆ realtype

using SUNDIALS::realtype = typedef ::sunrealtype

Alias for the real type used by SUNDIALS.

Definition at line 32 of file sundials_types.h.

◆ LinearSolveFunction

template<typename VectorType >
using SUNDIALS::LinearSolveFunction = typedef std::function<void(SundialsOperator<VectorType> &op, SundialsPreconditioner<VectorType> &prec, VectorType &x, const VectorType &b, double tol)>

Type of function objects to interface with SUNDIALS' linear solvers

This function type encapsulates the action of solving \(P^{-1}Ax=P^{-1}b\). The LinearOperator op encapsulates the matrix vector product \(Ax\) and the LinearOperator prec encapsulates the application of the preconditioner \(P^{-1}z\). The user can specify function objects of this type to attach custom linear solver routines to SUNDIALS. The two LinearOperators op and prec are built internally by SUNDIALS based on user settings. The parameters are interpreted as follows:

[in]opA LinearOperator that applies the matrix vector product
[in]precA LinearOperator that applies the preconditioner
[out]xThe output solution vector
[in]bThe right-hand side
[in]tolTolerance for the iterative solver
This variable represents a user provided callback. See there for a description of how to deal with errors and other requirements and conventions. In particular, ARKode can deal with "recoverable" errors in some circumstances, so callbacks can throw exceptions of type RecoverableUserCallbackError.

Definition at line 201 of file sunlinsol_wrapper.h.

Function Documentation

◆ DeclException1()

SUNDIALS::DeclException1 ( ExcARKodeError  ,
int  ,
<< "One of the SUNDIALS ARKode internal functions "<< " returned a negative error code: "<< arg1<< ". Please consult SUNDIALS manual."   

Handle ARKode exceptions.