Skip to content

Commit

Permalink
Docs: add note about derived quantities (io) (#1245)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkuhn authored Sep 17, 2024
1 parent e26eb80 commit 3a7b150
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/sphinx/user/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Flow physics

* Field plane averaging and second and third order moments

* Derived fields and field operators such as vorticity, q-criterion, strain-rates, gradients, divergence, laplacian
* Derived fields and field operators such as vorticity, q-criterion, strain-rates, gradients, divergence, laplacian [:ref:`inp <inputs_io_derived>`]

* in-situ post-processing with Ascent

Expand Down
21 changes: 21 additions & 0 deletions docs/sphinx/user/inputs_io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,27 @@ controls when these files are output.

Add variable names to this input argument to add them to the plotfile output. These must be variables that exist in the simulation and consist of integers (not real numbers).

.. _inputs_io_derived:

.. input_param:: io.derived_outputs

**type:** List of strings, optional, default = ""

Add derived variable names to this input argument
to add them to the plotfile output. These are derived
quantities that are functions of real variables that exist
in the simulation. Currently, the available derived quantity definitions
that operate on the velocity field are vorticity magnitude
(``mag_vorticity``), q-criterion (``q_criterion``),
nondimensional q-criterion (``q_criterion_nondim``),
and strain rate magnitude (``mag_strainrate``). Generic
derived quantity definitions, which operate on fields specified as an argument,
include the gradient operator (``grad``), the divergence
operator (``div``), the laplacian operator (``laplacian``),
and components (``components``), which isolates the specified
component of a field.


.. input_param:: io.skip_outputs

**type:** List of strings, optional, default = ""
Expand Down

0 comments on commit 3a7b150

Please sign in to comment.