cea-rs/README.md

41 lines
1.2 KiB
Markdown

# cea-rs 🚀🦀
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
This is a rust port of the Chemical Equilibrium with Applications method.
Code was generally developed following the approach described in and not really from referencing the [NASA open source codebase](https://github.com/nasa/cea).
>Gordon, S., & McBride, B. J. (1994). Computer program for calculation of complex chemical equilibrium compositions and applications. Part 1: Analysis (No. NAS 1.61: 1311).
## Completeness
Below are the list of solvers in CEA and whether they are currently supported or not:
- [ ] TP, HP, SP
- [ ] TV, UV, SV
- [ ] CJ detonation
- [ ] shock
- [ ] rocket
## Overview
```
.
├── Cargo.toml
├── LICENSE
├── README.md
└── src
├── properties/ # Thermodynamic input data and polynomial calculations
├── models/ # Basic Gas and GasMixture structs
├── equilibrium/ # Iterative solvers for TP, HP, SP, UV, TV, SV
├── rocket/ # Rocket solver functions
├── cj/ # Cj detonation functions
├── shock/ # shock solver functions
├── inputs.rs # input file parsing
└── main.rs
```
## License
This project is licensed under the [MIT License](LICENSE).