Skip to content

Commit ddc28f5

Browse files
committed
more
1 parent c4b162a commit ddc28f5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Docs/source/burn_failures.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ There are a few common reasons why the integrator might encounter trouble:
5555
Making the integration robust
5656
=============================
5757

58+
.. index:: integrator.atol_spec, integrator.species_failure_tolerance, integrator.use_jacobian_caching, integrator.do_corrector_validation, integrator.use_burn_retry
59+
5860
Some tips for helping the integrator:
5961

6062
* Use a tight absolute tolerance for the species
@@ -110,9 +112,14 @@ Some tips for helping the integrator:
110112

111113
* Use the corrector validation (``integrator.do_corrector_validation``).
112114

115+
This checks to make sure the state is valid inside of the corrector
116+
loop, and if not, it bails out of the corrector, forcing the
117+
integrator to retry the entire step.
113118

114119
Things we no longer recommend:
115120

121+
.. index:: integrator.do_species_clip, integrator.renormalize_abundances
122+
116123
* Clipping the species (``integrator.do_species_clip``) can lead to
117124
instabilities. This changes the integration state directly in the
118125
righthand side function, outside of the control of the integrator.

0 commit comments

Comments
 (0)