Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Docs/source/autodiff.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ numbers as well.

``autodiff::seed(x)`` sets the derivative term of ``x`` to 1 (it is equivalent
to ``x.grad = 1.0``), which effectively tells the code that
:math:`\frac{\partial x}{\partial x} = 1`. This propagates through any
operations that ``f(x)`` does, and we end up with :math:`\frac{\partial
f(x)}{\partial x}` in the derivative term of ``result``.
:math:`{\partial x}/{\partial x} = 1`. This propagates through any
operations that ``f(x)`` does, and we end up with :math:`{\partial
f(x)}/{\partial x}` in the derivative term of ``result``.


Derivatives of multi-variable functions
Expand Down
16 changes: 9 additions & 7 deletions Docs/source/integrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Reaction ODE System

.. important::

This describes the integration done when doing Strang operator-splitting, which is the
default mode of coupling burning to application codes.
This describes the integration done when doing Strang
operator-splitting, which is the default mode of coupling burning
to application codes. For SDC coupling see the :ref:`sdc-evolution`
section.

The equations we integrate to do a nuclear burn are:

Expand All @@ -30,9 +32,9 @@ energy. This allows us to easily call the EOS during the burn to obtain the temp

.. note::

The energy generation rate includes a term for neutrino losses in addition
to the energy release from the changing binding energy of the
fusion products.
The energy generation rate includes a term for neutrino losses (see
:ref:`neutrino_loss`) in addition to the energy release from the
changing binding energy of the fusion products.

.. index:: integrator.use_number_densities

Expand All @@ -55,7 +57,7 @@ energy. This allows us to easily call the EOS during the burn to obtain the temp
requiring $\sum_k X_k = 1$.


While this is the most common way to construct the set of
While the system above is the most common way to construct the set of
burn equations, and is used in most of our production networks,
all of them are ultimately implemented by the network itself, which
can choose to disable the evolution of any of these equations by
Expand Down Expand Up @@ -95,7 +97,7 @@ The input is a ``burn_t``.
.. note::

For the thermodynamic state, only the density, temperature, and
mass fractions are used directly--we compute the internal energy
mass fractions are used directly---we compute the internal energy
corresponding to this input state through the equation of state
before integrating.

Expand Down
2 changes: 1 addition & 1 deletion Docs/source/nse_net.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ variations. The overview of the steps we take are the following:

t_{i,k} < \epsilon t_s

*
* the forward and reverse rates satisfy:

.. math::

Expand Down
2 changes: 1 addition & 1 deletion Docs/source/ode_integrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Presently, allowed integrators are:
comparing to a single full step. This error is then used to control
the timestep by using the local truncation error scaling. Optionally, the
user can disable error estimation and force a single-step backward-Euler
integration by setting `integrator.do_single_step = 1`.
integration by setting ``integrator.do_single_step = 1``.

* ``ForwardEuler``: an explicit first-order forward-Euler method. This is
meant for testing purposes only. No Jacobian is needed.
Expand Down
2 changes: 1 addition & 1 deletion Docs/source/unit_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ One-zone tests
* ``burn_cell_sdc`` :

similar to ``burn_cell`` except this uses the SDC integration code paths.
See :ref:`sec:burn_cell_sdc` for more information.
See :ref:`sec:burn_cell_sdc` for more information.

* ``eos_cell`` :

Expand Down
Loading