From 9b5192b357f4f46eb50c3ccfae3eea93130f21cb Mon Sep 17 00:00:00 2001 From: Magnus Ulimoen Date: Tue, 23 Mar 2021 19:37:27 +0100 Subject: [PATCH] Add documentation for utilities --- utils/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 utils/README.md diff --git a/utils/README.md b/utils/README.md new file mode 100644 index 0000000..26e2b37 --- /dev/null +++ b/utils/README.md @@ -0,0 +1,14 @@ +# Utilities + +## Integrate +The `Integrable` trait, Butcher Tableaus, and functions to integrate explicit partial differential equations. Embedded integration is additionally available, which allows for adaptive time-steps,although selection of timesteps is left to the users. + +## Constmatrix +A constant-size matrix which supports matrix-multiplication. + + +## Float +The basic building-block for selection of the float type. `f32` can be selected for applications requiring lower precision, such as direct visualisation in graphics. + +## Fast-Float +A wrapper-type around the unsafe float intrinsics