Skip to content

Commit cfa7ea6

Browse files
committed
add changelog entry about abundance-based timestep controls now being arrays
1 parent 632539e commit cfa7ea6

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/source/changelog.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,40 @@ like to see the changes without modifying the file.
4545

4646
``sed`` is a standard tool that is included with macOS and most Linux distributions.
4747

48+
Abundance-based timestep controls are now arrays
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
The previous controls ::
52+
53+
dH_limit_min_H = 1d99
54+
dH_limit = 1d99
55+
dH_hard_limit = 1d99
56+
dH_decreases_only = .true.
57+
dH_div_H_limit_min_H = 1d-3
58+
dH_div_H_limit = 0.9d0
59+
dH_div_H_hard_limit = 1d99
60+
61+
and similar controls for ``He`` and ``He3`` have been replaced with
62+
arrays. This simplifies the code and allows the controls to be
63+
applied to any species in the net. A new control
64+
``dX_limit_species(...)`` specifies which elements will be checked.
65+
The previous behaviour for ``H``, for example, has been replaced with
66+
::
67+
68+
dX_limit_species(1) = 'h1'
69+
dX_limit_min_X(1) = 1d99
70+
dX_limit(1) = 1d99
71+
dX_hard_limit(1) = 1d99
72+
dX_decreases_only(1) = .true.
73+
dX_div_X_limit_min_X(1) = 1d-3
74+
dX_div_X_limit(1) = 0.9d0
75+
dX_div_X_hard_limit(1) = 1d99
76+
77+
The old ``H``, ``He`` and ``He3`` controls correspond to species
78+
``h1``, ``he4`` and ``he3``, respectively. You can also set the
79+
species to ``X``, ``Y`` or ``Z``, in which case the checks are applied
80+
*individually* to all isotopes of hydrogen, helium or metals,
81+
respectively.
4882

4983
Changes in r22.11.1
5084
===================

0 commit comments

Comments
 (0)