https://github.com/sandialabs/relleno
A SageMath library for jump expansions and Jacobian matrices of conservation laws and stability analysis
https://github.com/sandialabs/relleno
compressible-flow scr-2422 snl-comp-science-libs stability-analysis symbolic-math
Last synced: 3 months ago
JSON representation
A SageMath library for jump expansions and Jacobian matrices of conservation laws and stability analysis
- Host: GitHub
- URL: https://github.com/sandialabs/relleno
- Owner: sandialabs
- License: other
- Created: 2020-01-15T23:31:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-22T19:12:02.000Z (over 4 years ago)
- Last Synced: 2025-01-11T15:24:34.277Z (5 months ago)
- Topics: compressible-flow, scr-2422, snl-comp-science-libs, stability-analysis, symbolic-math
- Language: Sage
- Homepage:
- Size: 456 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
`Relleno` is a SageMath library that facilitates derivations of numerical flux functions for computational solution of conservation laws.
Its main application has been the derivation of entropy stable flux functions for compressible gas flows.
However, the fundamental library itself is quite general.
# Clone, Install, and Test
To use Relleno you'll need SageMath installed on your computer (see http://www.sagemath.org/index.html).
After installing SageMath, clone the `Relleno` repository:
```
git clone https://github.com/sandialabs/Relleno.git
```
This will create a directory named `Relleno`.
Enter into this directory and install with the following command.
```
cd Relleno
sage -pip install --upgrade --no-index -v .
```
To test that the installation was successful, run the following command from the `Relleno` directory.
This might take up to thirty seconds or so.
```
sage Relleno/tests.sage
```
# Theory Manual
The `docs/Relleno.pdf` file details the theory underlying `Relleno`. It probably won't be too helpful for learning how to use the code, though.
# Demonstrations
To see `Relleno` in use, check out the `demo` folder.
There are several `.ipynb` files for use with the Jupyter notebook interface to SageMath (`sage -n jupyter`).
# Help
If you need help installing or using `Relleno`, please write up an issue on the GitHub page or email Mike Hansen at [email protected].