Skip to content

Commit

Permalink
Add new output frequency options for meshes. No longer assumed a freq…
Browse files Browse the repository at this point in the history
…uency=1 by default
  • Loading branch information
Chrismarsh committed Aug 8, 2024
1 parent bd0e728 commit 9b7f08a
Show file tree
Hide file tree
Showing 3 changed files with 282 additions and 191 deletions.
32 changes: 29 additions & 3 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,11 @@ mesh
The entire mesh may be written to Paraview’s vtu format for
visualization in Paraview and for analysis. This is denoted by a ``"mesh":{ ... }`` key.

For more details, please see the :ref:`output` section.
For more details on the output files, please see the :ref:`output` section.

.. note::
The default behaviour of ``mesh`` output is not to output any vtu files. The user must specify the output frequency
or timing.

.. confval:: base_name

Expand All @@ -509,7 +513,7 @@ For more details, please see the :ref:`output` section.

:type: ``[ "variable", ... ]``

The default behaviour to is write every variable at each timestep. This may produce an undesirable amount of output. This takes a list of variables to output.
The default behaviour to is to write every variable at each timestep. This may produce an undesirable amount of output. This takes a list of variables to output.

.. code:: json
Expand All @@ -525,7 +529,10 @@ For more details, please see the :ref:`output` section.
:type: int
:default: 1
Frequency can be set to write ever *N* timesteps.
Frequency can be set to write ever *N* timesteps. If the automatic checkpoint system is used, this might not
produce a consistent output frequency and time. For example, suppose daily midnight output was chosen
(``frequency:24``) as the model simulation starts at 00:00. However, the auto-checkpoint suspends at the 8am
timestep, the next output will be at 8am instead of midnight.
.. confval write_parameters::
Expand All @@ -541,8 +548,26 @@ For more details, please see the :ref:`output` section.
Write each MPI rank's ghost face data to vtu output
.. confval specific_datetime::
:type: string
:default: ""
Output at a specific date-time, given in the iso format, e.g., ``"specific_datetime": "20191227T160000"``
.. confval specific_time::
:type: string
:default: ""
Output at a specific time every day, given in a "HH:MM" 24hr-format, e.g., ``"specific_time": "14:00"``
Example:

All of the frequency options can mixed together, allowing more complex output frequency selections

.. code:: json
"output":
Expand All @@ -556,6 +581,7 @@ Example:
"iswr"
],
"frequency": "24",
"specific_datetime": "20191227T160000",
"write_parameters": false,
"write_ghost_neighbors": false
}
Expand Down
Loading

0 comments on commit 9b7f08a

Please sign in to comment.