Export4Pele
Functions
|
Export fuel properties to input file for Pele simulations. |
|
Main function to execute the export process. |
|
Convert a list or numpy array to a string representation. |
- Export4Pele.export_pele(fuel, path='/home/runner/work/FuelLib/FuelLib/exportData', units='mks', dep_fuel_names=None, export_mix=False, export_mix_name=None, liq_prop_model='gcm', psat_antoine=True)
Export fuel properties to input file for Pele simulations.
- Parameters:
fuel (fuel object) – An instance of the fuel class.
path (str, optional (default: FuelLib/exportData)) – Directory to save the input file.
units (str, optional (default: "mks")) – Units for the properties (“mks” for SI, “cgs” for CGS).
dep_fuel_names (list of str, optional (default: None)) – List or single fuel that each compound deposits to.
export_mix (bool, optional (default: False)) – Option to export mixture properties of the fuel (True or False).
export_mix_name (str, optional (default: None)) – Name the mixture if different than fuel_name.
liq_prop_model (str, optional (default: "gcm")) – Model for liquid properties. Options are “gcm” (default) or “mp”.
psat_antoine (bool, optional) – Use Antoine coefficients for vapor pressure in MP model (True or False). Default is True.
- Returns:
None
- Return type:
None
- Export4Pele.main()
Main function to execute the export process.
- Parameters:
--fuel_name (str) – Name of the fuel (mandatory).
--fuel_data_dir (str, optional) – Directory where fuel data files are located. Default is FuelLib/fuelData.
--units (str, optional) – Units for critical properties. Options are “mks” (default) or “cgs”.
--dep_fuel_names (str, optional) – Space-separated list with len(fuel.compounds) or single fuel that all compounds deposit. Default is fuel.compounds.
--export_dir (str, optional) – Directory to export the properties. Default is “FuelLib/exportData”.
--export_mix (bool, optional) – Option to export mixture properties of the fuel (True or False). Default is False.
--export_mix_name (str, optional) – Name the mixture if different than fuel_name. Default is fuel_name.
--liq_prop_model (str, optional) – Model for liquid properties. Options are “gcm” (default) or “mp”.
--psat_antoine (bool, optional) – Use Antoine coefficients for vapor pressure in MP model (True or False). Default is True.
- Raises:
FileNotFoundError – If required files for the specified fuel are not found.
- Export4Pele.vec_to_str(vec)
Convert a list or numpy array to a string representation.
- Parameters:
vec – List or numpy array to convert.
- Returns:
String representation of the vector.