Reference documentation for deal.II version Git 78a8940608 2021-04-17 09:24:19 -0400
\(\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

Namespaces

 internal
 

Classes

class  ARKode
 
class  KINSOL
 
struct  SundialsOperator
 
struct  SundialsPreconditioner
 

Typedefs

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

Functions

 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

◆ LinearSolveFunction

template<typename VectorType >
using SUNDIALS::LinearSolveFunction = typedef std::function<int(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:

Parameters
[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 function should return:

  • 0: Success
  • >0: Recoverable error, ARKode will reattempt the solution and call this function again.
  • <0: Unrecoverable error, the computation will be aborted and an assertion will be thrown.

Definition at line 155 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.