Skip to content

Commit

Permalink
Add cross-ref to section about creating new derived variables (#2772)
Browse files Browse the repository at this point in the history
It took me a little while to find where this is in the docs.
  • Loading branch information
yut23 authored Mar 12, 2024
1 parent fbd880f commit e94d826
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Docs/source/creating_a_problem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,9 @@ each of these in the main source tree.
problem which refines a rectangular region (fuel layer) based on
a density parameter and the H mass fraction.

- ``Problem_Derives.H``, ``Problem_Derive.H``, and ``Problem_Derives.cpp``
.. _problem_derives:

- ``Problem_Derives.H``, ``Problem_Derive.H``, and ``Problem_Derive.cpp``

Together, these provide a mechanism to create derived quantities
that can be stored in the plotfile. ``Problem_Derives.H``
Expand Down
2 changes: 2 additions & 0 deletions Docs/source/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,8 @@ Derived variables
problem-specific plotfile variables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See the section on :ref:`Problem_Derives.H <problem_derives>` for more details about defining your own plotfile variables.

+-----------------------------------+---------------------------------------------------+--------------------------------------+
| variable name | description | units |
+===================================+===================================================+======================================+
Expand Down

0 comments on commit e94d826

Please sign in to comment.