From 299c070ed079ded2b0a63e2204db85e79c715c77 Mon Sep 17 00:00:00 2001 From: Roberto Porcu Date: Wed, 7 Aug 2024 14:01:12 -0400 Subject: [PATCH] add UniformScalarField monitor documentation --- .../user_guide/inputs/output/monitors.rst | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/source_docs/user_guide/inputs/output/monitors.rst b/docs/source_docs/user_guide/inputs/output/monitors.rst index 1ff27e1..306934a 100644 --- a/docs/source_docs/user_guide/inputs/output/monitors.rst +++ b/docs/source_docs/user_guide/inputs/output/monitors.rst @@ -203,6 +203,31 @@ The following table lists all the fluid phase variables that can be monitored: +--------------------------+-----------------------------------------------------------------------------------------+ +Uniform Scalar Field +~~~~~~~~~~~~~~~~~~~~ + +The following table lists all the fluid phase space-uniform variables that can +be monitored: + ++--------------------------+-----------------------------------------------------------------------------------------+ +| | Description | ++==========================+=========================================================================================+ +| thermo_p_g | fluid thermodynamic pressure | ++--------------------------+-----------------------------------------------------------------------------------------+ + +For a uniform scalar field, the monitor data value is simply the value of the +variable at current time: + +Value + +-------------------------------------+ + | Eulerian::UniformScalarField::Value | + +-------------------------------------+ + + Returns the value of the field quantity in the selected region. + + .. math:: \phi_{ijk} + + Point Region ~~~~~~~~~~~~ -- GitLab