qmat 0.1.19

Generation of Q-coefficients for Spectral Deferred Corrections (and other time-integration methods ...)

QMat Package

qmat is a python package to generate matrix coefficients related to Collocation methods, Spectral Deferred Corrections (SDC), and more generally for Runge-Kutta methods.

It allows to generate $Q$-coefficients for multi-stages methods (equivalent to Butcher tables) :

$$ Q\text{-coefficients : } \begin{array}{c|c} \tau & Q \ \hline & w^\top \end{array} \quad \Leftrightarrow \quad \begin{array}{c|c} c & A \ \hline & b^\top \end{array} \quad\text{(Butcher table)} $$

and many different lower-triangular approximations of the $Q$ matrix, named $Q_\Delta$, which are key elements for Spectral Deferred Correction (SDC), or more general Iterated Runge-Kutta Methods.

Installation

pip install qmat

🔍 See more detailed instructions for conda environment, development, ...

Basic usage

📜 If you are already familiar with those concepts, you can use this package like this :

from qmat import genQCoeffs, genQDeltaCoeffs

# Coefficients or specific collocation method
nodes, weights, Q = genQCoeffs(
    "Collocation", nNodes=4, nodeType="LEGENDRE", quadType="RADAU-RIGHT")

# QDelta matrix from Implicit-Euler based SDC
QDelta = genQDeltaCoeffs("IE", nodes=nodes)

# Butcher table of the classical explicit RK4 method
c, b, A = genQCoeffs("ERK4")

🔔 If you are not familiar with SDC or related methods, and want to learn more about it, checkout the latest documentation build and in particular the step by step notebook tutorials

For any contribution, please checkout out (very cool) Contribution Guidelines and the current Development Roadmap.

Projects relying on qmat

• pySDC : Python implementation of the spectral deferred correction (SDC) approach and its flavors, esp. the multilevel extension MLSDC and PFASST.
• SWEET : Shallow Water Equation Environment for Tests, Awesome! (C++).

Links

• Documentation : https://qmat.readthedocs.io/
• Issues Tracker : https://github.com/Parallel-in-Time/qmat/issues
• Q&A : https://github.com/Parallel-in-Time/qmat/discussions/categories/q-a
• Project Proposals : https://github.com/Parallel-in-Time/qmat/discussions/categories/project-proposals