Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
americocunhajr authored Jul 17, 2024
1 parent 42297cf commit b77ac80
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

**CRFlowLib** is a collection of computational libraries with routines to simulate chemically reacting flows employing In Situ Adaptive Tabulation (ISAT) algorithm for thermochemistry calculation.

## Documentation
### Documentation

**CRFlowLib** routines are commented to explain their functionality to the final user. Each routine has a short description of its purpose and a list of inputs and/or outputs. The users can use the file "main__pmsr-isat.c" as a baseline to define their own simulation problem.

## Software History
### Software History

**CRFlowLib** is the result of a master's thesis:

Expand All @@ -20,7 +20,7 @@ The results of this thesis were disclosed in the following publication:

The PDF of this article is available for free at: https://hal.archives-ouvertes.fr/hal-01438646

## Compilation
### Compilation

**CRFlowLib** uses a Makefile for compilation.

Expand All @@ -31,7 +31,7 @@ To compile a specific program type: make program-title.exe

See the Makefile for further details.

## Program Execution
### Program Execution

All programs depend on the ‘chem.bin’ file generated by ‘chem.exe’ program.

Expand All @@ -42,7 +42,7 @@ To run a specific program type: make run_program-title

See the Makefile for further details.

## External Dependencies
### External Dependencies

#### CRFlowLib-1.0 - the original implementation

Expand All @@ -66,21 +66,21 @@ The following Chenkin-II libraries are necessary:
- ckinterp.f
- ckstrt.h

## Reaction Mechanisms (CK-II format)
### Reaction Mechanisms (CK-II format)

This repository stores a collection of thermochemistry mechanisms in Chemkin-II format. These kinetic mechanisms were developed by several research groups that works in the simulation of chemically reactive flows. This collection is the result of more than 15 years of search. All of these mechanisms were made available, at some time, on the Internet or in specialized literature.

The repository owner makes them available here with the intention that they may be useful for researchers interested in the topic. Unfortunately, no guarantee can be given regarding the integrity of the files or the accuracy of the mechanisms. Use it at your own risk!

## Reproducibility
### Reproducibility

Simulations done with **CRFlowLib** are fully reproducible, as can be seen on this <a href="https://codeocean.com/capsule/2804669/tree/v1" target="_blank">CodeOcean capsule</a>

## Authors
### Authors
- Americo Cunha (UERJ)
- Luis Fernando Figueira da Silva (PUC-Rio / Institut Pprime)

## Citing CRFlowLib
### Citing CRFlowLib

We kindly ask users to cite the following references in any publications reporting work done with **CRFlowLib**:
- *A. Cunha Jr and L. F. Figueira da Silva, CRFlowLib --- Chemically Reacting Flow Library, Software Impacts, v. 11, pp. 100206, 2022 https://doi.org/10.1016/j.simpa.2021.100206*
Expand Down Expand Up @@ -122,16 +122,16 @@ We kindly ask users to cite the following references in any publications reporti
}
```

## License
### License

**CRFlowLib** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.

<img src="logo/mit_license_red.png" width="10%">

## Institutional support
### Institutional support

<img src="logo/logo_uerj_color.jpeg" width="10%"> &nbsp; &nbsp; <img src="logo/logo_pucrio_color.jpg" width="07%"> &nbsp; &nbsp; <img src="logo/logo_pprime_color.jpeg" width="15%">

## Funding
### Funding

<img src="logo/faperj.jpg" width="20%"> &nbsp; &nbsp; <img src="logo/cnpq.png" width="20%"> &nbsp; &nbsp; <img src="logo/capes.png" width="10%">

0 comments on commit b77ac80

Please sign in to comment.