API Reference

OperatorSplittingProblem(f::AbstractOperatorSplitFunction, u0, tspan, p::Tuple)

GenericSplitFunction(functions::Tuple, solution_indices::Tuple)
GenericSplitFunction(functions::Tuple, solution_indices::Tuple, synchronizers::Tuple)

This type of function describes a set of connected inner functions in mass-matrix form, as usually found in operator splitting procedures.

LieTrotterGodunov <: AbstractOperatorSplittingAlgorithm

First-order sequential operator splitting algorithm attributed to [1–3].

StrangMarchuk <: AbstractOperatorSplittingAlgorithm

Second-order symmetric (palindromic) operator splitting algorithm attributed to [4, 5].

For $N$ operators the scheme performs

$A_1(\Delta t/2) \to \cdots \to A_{N-1}(\Delta t/2) \to A_N(\Delta t) \to A_{N-1}(\Delta t/2) \to \cdots \to A_1(\Delta t/2)$

achieving second-order accuracy through symmetry.

PalindromicPairLieTrotterGodunov <: AbstractOperatorSplittingAlgorithm

Second-order sequential operator splitting algorithm.

One step solves the palindromic pair of LieTrotterGodunov sequences

$A_1(\Delta t) \to \cdots \to A_N(\Delta t)$ and $A_N(\Delta t) \to \cdots \to A_1(\Delta t)$

from the same initial value. The leading splitting error of a Lie-Trotter sequence is $\frac{\Delta t^2}{2}\sum_{i<j} [A_j, A_i]$, and reversing the sequence flips the sign of every pairwise commutator, so the average of the pair – which is taken as the solution – is second order accurate for any number of operators. Half the pair difference estimates the local splitting error of a single sequence and drives the step size controller, making this the only splitting algorithm in this package that supports adaptive time stepping of the splitting itself.

Both the order statement and the error estimate account for the splitting error only: they presume the inner solvers resolve their sub-problems accurately relative to it (adaptive inner solvers, or fixed steps well below the splitting step). With coarse fixed-step inner solvers – say Euler() stepping at the splitting step size – the overall method degrades to the inner order and the controller is blind to that part of the error.

SplitNode

Address of a node in an operator splitting tree, together with the object that lives at that address.

Nodes are minted by indexing a GenericSplitFunction with integers. f[] addresses the root, f[i] its i-th operator and f[i, j] the j-th operator of that one:

node = f[2, 1]        # equivalently f[2][1]
node.path             # (2, 1)
node.object           # the addressed sub function

The splitting function defines the shape of the tree, so an address minted from it denotes the same position in every tree that mirrors it and can be resolved against each of them:

f[node]               # the sub function
alg[node]             # the inner algorithm
integrator[node]      # the sub integrator

Addresses are also how a TreeOption is told which node to configure.

TreeOption(f::GenericSplitFunction, default)
TreeOption{T}(f::GenericSplitFunction, default)

A value per node of an operator splitting tree, used to give individual subintegrators their own settings where init only accepts one value for all of them.

The option mirrors the shape of f and starts out holding default everywhere. Plain assignment sets a single node; broadcast assignment sets a node and everything below it:

dt = TreeOption(f, 1.0e-2)
dt[2]     = 1.0e-4          # this node alone
dt[2]    .= 1.0e-4          # this node and all operators below it
dt       .= 1.0e-4          # every node
dt[f[2]]  = 1.0e-4          # addressed by a SplitNode instead of a path
dt[2, 1]                    # read the value at [2, 1]

Later assignments overwrite earlier ones, so a broadcast over a subtree clobbers more specific values written before it.

The element type is fixed by default; use TreeOption{Any}(f, default) for an option whose values are of mixed type, such as a step size controller.