API Reference
=============

Simulator Core
--------------

simulator
~~~~~~~~~

.. automodule:: simulator


simulator.cli
~~~~~~~~~~~~~

.. automodule:: simulator.cli
   :members:
   :undoc-members:
   :show-inheritance:


simulator.main
~~~~~~~~~~~~~~

.. automodule:: simulator.main
   :members:
   :undoc-members:
   :show-inheritance:


simulator.app
~~~~~~~~~~~~~

.. automodule:: simulator.app
   :members:
   :undoc-members:
   :show-inheritance:


simulator.apis
~~~~~~~~~~~~~~

.. automodule:: simulator.apis
   :members:
   :undoc-members:
   :show-inheritance:


simulator.core
~~~~~~~~~~~~~~

.. automodule:: simulator.core
   :members:
   :undoc-members:
   :show-inheritance:


simulator.design
~~~~~~~~~~~~~~~~

.. automodule:: simulator.design
   :members:
   :undoc-members:
   :show-inheritance:


simulator.fuels
~~~~~~~~~~~~~~~

.. automodule:: simulator.fuels
   :members:
   :undoc-members:
   :show-inheritance:


simulator.io
~~~~~~~~~~~~

.. automodule:: simulator.io
   :members:
   :undoc-members:
   :show-inheritance:


simulator.turbo
~~~~~~~~~~~~~~~

.. automodule:: simulator.turbo
   :members:
   :undoc-members:
   :show-inheritance:


simulator.utils
~~~~~~~~~~~~~~~

.. automodule:: simulator.utils
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps
~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps


simulator.pumps.affinity
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.affinity
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.cavitation
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.cavitation
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.combined
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.combined
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.curves
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.curves
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.power
~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.power
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.pump_map
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.pump_map
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.system_curve
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.system_curve
   :members:
   :undoc-members:
   :show-inheritance:


simulator.pumps.water_pump
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.pumps.water_pump
   :members:
   :undoc-members:
   :show-inheritance:


Thermochemistry Core
--------------------

simulator.thermo.equilibrium
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.equilibrium
   :members:
   :undoc-members:
   :show-inheritance:


simulator.thermo.reactor0d
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.reactor0d
   :members:
   :undoc-members:
   :show-inheritance:


simulator.thermo.species
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.species
   :members:
   :undoc-members:
   :show-inheritance:


simulator.thermo.thermo_state
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.thermo_state
   :members:
   :undoc-members:
   :show-inheritance:


Thermochemistry Tools
---------------------

simulator.thermo.tools.equilibrium_flame
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.tools.equilibrium_flame
   :members:
   :undoc-members:
   :show-inheritance:


simulator.thermo.tools.equilibrium_flame_compare
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.thermo.tools.equilibrium_flame_compare
   :members:
   :undoc-members:
   :show-inheritance:


Engineering Tools
-----------------

simulator.tools.bsfc_sweep_phi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.bsfc_sweep_phi
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_contours
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_contours
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_map_epa
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_map_epa
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_table
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_table
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_vs_displacement
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_vs_displacement
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_vs_phi_rc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_vs_phi_rc
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_bsfc_vs_speed_rc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_bsfc_vs_speed_rc
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_compressor_map_efr71
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_compressor_map_efr71
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_cycle_thermo_plot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_cycle_thermo_plot
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_flame_summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_flame_summary
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_full_load_sweep
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_full_load_sweep
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_generate_template_input
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_generate_template_input
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_indicator_from_result
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_indicator_from_result
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_turbine_map_gt4088
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_turbine_map_gt4088
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.tool_turbo_match_opline
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.tool_turbo_match_opline
   :members:
   :undoc-members:
   :show-inheritance:


simulator.tools.turbo_match
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: simulator.tools.turbo_match
   :members:
   :undoc-members:
   :show-inheritance: