zapdos
zapdos copied to clipboard
shannon-lab
Consistent naming conventions across all inputs
Motivation
Currently the same input parameter across a majority of the Zapdos objects is scattered and not immediately obvious. I would like to propose the following standard for input parameter naming conventions.
| Description | input |
|---|---|
| Electron density in log-molar form | electrons |
| Mean electron energy multiplied by electron density in log form | electron_energy |
| Multiple Ion Densities in log-molar form | ions |
| Ion Specific Potentials | ion_potentials |
| Species dependent secondary electron emission coefficient | emission_coeffs |
If there are other common inputs missing from this list please let me know or propose a standard for those as well. Or if others would like to propose potential modifications to these standards I am open to feedback as well!
This issue goes into helping resolve some parts of #49 and #73 as well and improve the user experience by reducing the amount of input for certain cases by enabling the users to define these variables once with the GlobalParams block.
Solution
Deprecate all existing inconsistent input parameters from objects currently available in Zapdos with a removal date for those options set to be 01/01/2025
@lindsayad @csdechant @cticenhour What are your thoughts on adopting this naming convention standard?
