Index of modules

A
Adjoint [Idas]

(Adjoint) Sensitivity analysis of DAEs with respect to their parameters.

Adjoint [Cvodes]

(Adjoint) Sensitivity analysis of ODEs with respect to their parameters.

Algorithms [Sundials_LinearSolver.Iterative]

Low-level routines on arrays.

Alternate [Idas.Adjoint]

Alternate Linear Solvers.

Alternate [Cvodes.Adjoint]

Alternate Linear Solvers.

Alternate [Arkode.Mass]

Alternate mass matrix solvers

Alternate [Arkode]

Alternate Linear Solvers.

Alternate [Ida]

Alternate Linear Solvers.

Alternate [Kinsol]

Alternate Linear Solvers.

Alternate [Cvode]

Alternate Linear Solvers.

Arkode

Adaptive-step time integration for stiff, nonstiff, and multi-rate systems of ODE initial value problems with zero-crossing detection.

Arkode_bbd

Parallel band-block-diagonal preconditioners for ARKODE (requires MPI).

ArrayBand [Sundials_Matrix]

General-purpose band matrix operations on arrays.

ArrayDense [Sundials_Matrix]

General purpose dense matrix operations on arrays.

B
Band [Sundials_Matrix]

Banded matrices

Banded [Cvodes.Adjoint.Spils]

Banded preconditioners.

Banded [Arkode.Spils]

Banded preconditioners.

Banded [Cvode.Spils]

Banded preconditioners.

C
Config [Sundials]

Installation specific constants.

Constraint [Sundials]

Symbolic names for variable constraints.

Custom [Sundials_LinearSolver.Iterative]

Custom iterative linear solvers.

Custom [Sundials_LinearSolver.Direct]

Custom direct linear solvers.

Cvode

Variable-step solution of ODE initial value problems with zero-crossing detection.

Cvode_bbd

Parallel band-block-diagonal preconditioners for CVODE (requires MPI).

Cvodes

Sensitivity analysis (forward and adjoint) and quadrature equations for CVODE.

Cvodes_bbd

Parallel band-block-diagonal preconditioners for CVODES (requires MPI).

D
DataOps [Nvector_parallel]

Nvector operations on Nvector_parallel.data implemented in OCaml.

DataOps [Nvector_array.ARRAY_NVECTOR]

Standard operations over the underlying array.

DataOps [Nvector_serial]

Nvector operations on RealArrays implemented in OCaml.

DataOps [Nvector.NVECTOR]

Standard operations over the underlying data.

Dense [Sundials_Matrix]

Dense matrices

Diag [Cvodes.Adjoint]

Diagonal approximation of Jacobians by difference quotients.

Diag [Cvode]

Diagonal approximation of Jacobians by difference quotients.

Direct [Sundials_LinearSolver]

Direct Linear Solvers

Dls [Idas.Adjoint]

Direct Linear Solvers operating on dense, banded, and sparse matrices.

Dls [Cvodes.Adjoint]

Direct Linear Solvers operating on dense, banded, and sparse matrices.

Dls [Arkode.Mass]

Direct mass matrix solvers

Dls [Arkode]

Direct Linear Solvers operating on dense, banded, and sparse matrices.

Dls [Ida]

Direct Linear Solvers operating on dense, banded and sparse matrices.

Dls [Kinsol]

Direct Linear Solvers operating on dense, banded, and sparse matrices.

Dls [Cvode]

Direct Linear Solvers operating on dense, banded, and sparse matrices.

I
Ida

Variable-step solution of DAE initial value problems with zero-crossing detection.

Ida_bbd

Parallel band-block-diagonal preconditioners for IDA (requires MPI).

Idas

Sensitivity analysis (forward and adjoint) and quadrature equations for IDA.

Idas_bbd

Parallel band-block-diagonal preconditioners for IDAS (requires MPI).

Index [Sundials]

Index values for sparse matrices.

Iterative [Sundials_LinearSolver]

Iterative Linear Solvers

K
Kinsol

Solves nonlinear systems using Newton-Krylov techniques.

Kinsol_bbd

Parallel band-block-diagonal preconditioners for KINSOL (requires MPI).

Klu [Sundials_LinearSolver.Direct]

KLU direct linear solver operating on sparse matrices (requires KLU).

L
LinearSolver [Sundials]
LintArray [Sundials]

Vectors of integers (one-dimensional bigarrays).

Logfile [Sundials]

Files for error and diagnostic information.

M
MakeOps [Nvector_parallel]

Produce a set of parallel Nvector.NVECTOR_OPS from basic operations on an underlying array.

MakeOps [Nvector_array]

Produce a custom nvector from basic operations on an underlying array.

MakeOps [Nvector_custom]

Turn a set of Nvector_custom.nvector_ops into an nvector module.

Mass [Arkode]

Mass Matrix Solvers

Matrix [Sundials]
N
Nvector

Generic nvector types and operations.

Nvector_array

A custom nvector based on float arrays.

Nvector_custom

An interface for creating custom nvectors in OCaml.

Nvector_openmp

The OpenMP nvectors of Sundials (requires OpenMP).

Nvector_parallel

The standard parallel nvectors of Sundials (requires MPI).

Nvector_pthreads

The Pthreads nvectors of Sundials (requires pthreads).

Nvector_serial

Standard serial nvectors of Sundials.

O
Ops [Nvector_pthreads]

Underlyling nvector operations on Pthreads nvectors.

Ops [Nvector_openmp]

Underlying nvector operations on OpenMP nvectors.

Ops [Nvector_parallel]

Underlying nvector operations on parallel nvectors.

Ops [Nvector_array.ARRAY_NVECTOR]

Standard operations over array nvectors.

Ops [Nvector_serial]

Underlying nvector operations on serial nvectors.

Ops [Nvector.NVECTOR]

Standard operations over nvectors.

Q
Quadrature [Idas.Adjoint]

Support for backward quadrature equations that may or may not depend on forward sensitivities.

Quadrature [Idas.Sensitivity]

Support for quadrature sensitivity equations.

Quadrature [Idas]

Integration of pure quadrature equations.

Quadrature [Cvodes.Adjoint]

Support for backward quadrature equations that may or may not depend on forward sensitivities.

Quadrature [Cvodes.Sensitivity]

Support for quadrature sensitivity equations.

Quadrature [Cvodes]

Integration of pure quadrature equations.

R
RealArray [Sundials]

Vectors of floats (one-dimensional bigarrays).

RealArray2 [Sundials]

Matrices of floats (wrappers around two-dimensional bigarrays with extra internal information required by Sundials).

RootDirs [Sundials]

Vectors of root (zero-crossing) directions.

Roots [Sundials]

Vectors of root (zero-crossing) statuses.

S
Sensitivity [Idas]

(Forward) Sensitivity analysis of DAEs with respect to their parameters.

Sensitivity [Cvodes]

(Forward) Sensitivity analysis of ODEs with respect to their parameters.

Sparse [Sundials_Matrix]

Sparse matrices

Spils [Idas.Adjoint]

Scaled Preconditioned Iterative Linear Solvers

Spils [Cvodes.Adjoint]

Scaled Preconditioned Iterative Linear Solvers.

Spils [Arkode.Mass]

Iterative mass matrix solvers

Spils [Arkode]

Scaled Preconditioned Iterative Linear Solvers.

Spils [Ida]

Scaled Preconditioned Iterative Linear Solvers.

Spils [Kinsol]

Scaled Preconditioned Iterative Linear Solvers.

Spils [Cvode]

Scaled Preconditioned Iterative Linear Solvers.

Sundials

Generic definitions, arrays, and utility functions.

Sundials_Config

The major, minor, patch, and binding version numbers of Sundials/ML.

Sundials_Index

Index values for sparse matrices.

Sundials_LinearSolver

Generic linear solvers.

Sundials_LintArray

A Bigarray of integers.

Sundials_Logfile

An open log file.

Sundials_Matrix

Generic matrices.

Sundials_RealArray

A Bigarray of floats.

Sundials_RealArray2
Superlumt [Sundials_LinearSolver.Direct]

SuperLUMT direct linear solver operating on sparse matrices (requires SuperLUMT).

U
Util [Sundials]
V
VarId [Ida]

Symbolic names for constants used when calculating initial values or supressing local error tests.