SUNDIALS Namespace Reference

Namespaces
namespace	internal
namespace	Utilities

Classes
class	ARKode
class	IDA
class	KINSOL
struct	SundialsOperator
struct	SundialsPreconditioner

Typedefs
using	booltype = sunbooleantype
using	realtype = ::sunrealtype
template<typename VectorType >
using	LinearSolveFunction

Functions
static ::ExceptionBase &	ExcARKodeError (int arg1)
static ::ExceptionBase &	ExcSundialsSolverError (int arg1)

Detailed Description

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

Typedef Documentation

booltype

using SUNDIALS::booltype = sunbooleantype

Alias for the bool and real types used by SUNDIALS.

Definition at line 31 of file sundials_types.h.

realtype

using SUNDIALS::realtype = ::sunrealtype

Definition at line 32 of file sundials_types.h.

LinearSolveFunction

template<typename VectorType >

using SUNDIALS::LinearSolveFunction

Initial value:

 
    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:

Parameters

[in]	op	A LinearOperator that applies the matrix vector product
[in]	prec	A LinearOperator that applies the preconditioner
[out]	x	The output solution vector
[in]	b	The right-hand side
[in]	tol	Tolerance for the iterative solver

Note

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 214 of file sunlinsol_wrapper.h.