Skip to content

Commit

Permalink
document SMALL_X_SAFE and do_species_clip (#1562)
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale authored May 24, 2024
1 parent 6674a9d commit 7a4346d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions sphinx_docs/source/ode_integrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,39 @@ to :math:`10^{-12}` for the species, and a relative tolerance of :math:`10^{-6}`
is used for the temperature and energy.


Controlling Species $\sum_k X_k = 1$
====================================

The ODE integrators don't know about the constraint that

$$\sum_k X_k = 1$$

so this is only going to be preserved to the level that the integrator
tolerances allow. There are a few parameters that help enforce this
constraint on the intermediate states during the integration.

* ``integrator.renormalize_abundances`` : this controls whether we
renormalize the abundances so that the mass fractions sum to one
during a burn.

This has the positive benefit that in some cases it can prevent the
integrator from going off to infinity or otherwise go crazy; a
possible negative benefit is that it may slow down convergence
because it interferes with the integration scheme. Regardless of
whether you enable this, we will always ensure that the mass
fractions stay positive and larger than some floor ``small_x``.

This option is disabled by default.

* ``integrator.SMALL_X_SAFE`` : this is the floor on the mass fractions.
The default is ``1.e-30``.

* ``integrator.do_species_clip`` : this enforces that the mass fractions
all in $[\mathtt{SMALL\_X\_SAFE}, 1.0]$.

This is enabled by default.


Retry Mechanism
===============

Expand Down

0 comments on commit 7a4346d

Please sign in to comment.