:py:mod:`astronomix._modules._cosmic_rays.cr_injection`
=======================================================

.. py:module:: astronomix._modules._cosmic_rays.cr_injection

.. autodoc2-docstring:: astronomix._modules._cosmic_rays.cr_injection
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`inject_crs_at_strongest_shock <astronomix._modules._cosmic_rays.cr_injection.inject_crs_at_strongest_shock>`
     - .. autodoc2-docstring:: astronomix._modules._cosmic_rays.cr_injection.inject_crs_at_strongest_shock
          :summary:

API
~~~

.. py:function:: inject_crs_at_strongest_shock(primitive_state: astronomix.option_classes.simulation_config.STATE_TYPE, gamma: typing.Union[float, jaxtyping.Float[jaxtyping.Array, ]], helper_data: astronomix.data_classes.simulation_helper_data.HelperData, cosmic_ray_params: astronomix._modules._cosmic_rays.cosmic_ray_options.CosmicRayParams, config: astronomix.option_classes.simulation_config.SimulationConfig, registered_variables: astronomix.variable_registry.registered_variables.RegisteredVariables, dt: typing.Union[float, jaxtyping.Float[jaxtyping.Array, ]]) -> astronomix.option_classes.simulation_config.STATE_TYPE
   :canonical: astronomix._modules._cosmic_rays.cr_injection.inject_crs_at_strongest_shock

   .. autodoc2-docstring:: astronomix._modules._cosmic_rays.cr_injection.inject_crs_at_strongest_shock