Skip to content

Fix minor typo in docs and Export4Pele #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-montgomery merged 1 commit into from
Aug 19, 2025
Merged

Fix minor typo in docs and Export4Pele #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Export4Pele.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
for use in Pele simulations.

This script is designed to be run from the command line and will create
a file named "sprayPropsfl.inp" in the specified directory.
a file named "sprayPropsGCM_<fuel_name>.inp" in the specified directory.
The file contains properties for each compound in the fuel, formatted for Pele.

Usage:
Expand Down Expand Up @@ -68,7 +68,7 @@ def export_pele(
os.makedirs(path)

# Names of the input file
file_name = os.path.join(path, "sprayPropsfl.inp")
file_name = os.path.join(path, f"sprayPropsGCM_{fuel.name}.inp")

# If dep_fuel_names is not provided, use fuel.compounds
if dep_fuel_names is None:
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ properties can be exported for use in the spray module of the `PelePhysics <http
for combustion simulations in the `PeleLMeX <https://github.com/AMReX-Combustion/PeleLMeX>`_
flow solver\ :footcite:p:`henry_de_frahan_pele_2024` \ :footcite:p:`esclapez_pelelmex_2023`.

The export script, ``Export4Pele.py``, generates an input file named ``sprayPropsfl.inp`` containing
The export script, ``Export4Pele.py``, generates an input file named ``sprayPropsGCM_<fuel_name>.inp`` containing
the necessary properties for each compound in the fuel. The properties are formatted for use in Pele and includes:

- Initial mass fraction
Expand Down Expand Up @@ -136,7 +136,7 @@ From the ``FuelLib`` directory, run the following command in the terminal, notin
python Export4Pele.py --fuel_name heptane-decane


This generates the following input file, ``FuelLib/sprayPropsGCM/sprayPropsfl.inp``, for use in a PeleLMeX simulation: ::
This generates the following input file, ``FuelLib/sprayPropsGCM/sprayPropsGCM_heptane-decane.inp``, for use in a PeleLMeX simulation: ::

particles.spray_fuel_num = 2
particles.fuel_species = NC7H16 NC10H22
Expand Down Expand Up @@ -165,10 +165,10 @@ This generates the following input file, ``FuelLib/sprayPropsGCM/sprayPropsfl.in
particles.NC10H22_cp = 1630.488028169014 3098.1056338028166 -1024.456338028169 # J/kg/K
particles.NC10H22_latent = 368035.211268 # J/kg

To include these parameters in your Pele simulation, copy the ``sprayPropsfl.inp``
To include these parameters in your Pele simulation, copy the ``sprayPropsGCM.inp``
file to the specific case directory and include the following line in your Pele input file: ::

FILE = sprayPropsfl.inp
FILE = sprayPropsGCM.inp


Note: for liquid fuels from FuelLib with greater than 30 components, the script
Expand Down