Add documentation for utilities

This commit is contained in:
Magnus Ulimoen 2021-03-23 19:37:27 +01:00
parent ce2e8f17ec
commit 9b5192b357
1 changed files with 14 additions and 0 deletions

14
utils/README.md Normal file
View File

@ -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