Skip to content

Commit 9287a59

Browse files
committed
update docs
1 parent d03cab7 commit 9287a59

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

Docs/source/io.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -507,11 +507,12 @@ simulation time, and “0.005” is the level-0 time step. This file
507507
can be plotted very easily to monitor the time step.
508508

509509

510+
.. _sec:global_diag:
510511

511-
Integral Diagnostics
512-
--------------------
512+
Global Diagnostics
513+
-------------------
513514

514-
.. index:: castro.sum_interval, integral diagnostics, amr_diag.out, gravity_diag.out, grid_diag.out, species_diag.out
515+
.. index:: castro.sum_interval, global diagnostics, amr_diag.out, gravity_diag.out, grid_diag.out, species_diag.out
515516

516517
Castro can calculate integrals of quantities on the grid and other
517518
global quantities and output them to both the screen and to a runtime

Docs/source/performance.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ which is controlled by ``amr.subcycling_mode``, as described
3939
in :ref:`sec:subcycling`.
4040

4141

42+
Global Diagnostics
43+
------------------
44+
45+
.. index:: castro.sum_interval
46+
47+
:ref:`sec:global_diag` are output at regular intervals. These can
48+
require reduction operations across all processors, which can be
49+
expensive for big calculations. Often we don't need the diagnostics
50+
every step, so setting ``castro.sum_interval`` to a larger value (like
51+
``10``) could improve performance.
52+
4253
Metrics
4354
=======
4455

0 commit comments

Comments
 (0)