From 3154a1c3f7167dd40163c149371f9a50b9cd0f42 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Tue, 9 Sep 2025 09:31:24 -0400 Subject: [PATCH] Add input docs for PSD reports --- docs/source_docs/user_guide/inputs/output.rst | 3 +- .../user_guide/inputs/output/reports.rst | 80 +++++++++++++++++++ 2 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 docs/source_docs/user_guide/inputs/output/reports.rst diff --git a/docs/source_docs/user_guide/inputs/output.rst b/docs/source_docs/user_guide/inputs/output.rst index 2043e27..897e668 100644 --- a/docs/source_docs/user_guide/inputs/output.rst +++ b/docs/source_docs/user_guide/inputs/output.rst @@ -1,7 +1,7 @@ Output ====== -Stuff here? +Various options for outputting simulation data from MFIX-Exa. .. toctree:: :maxdepth: 0 @@ -9,4 +9,5 @@ Stuff here? output/checkpointing output/plotfiles output/monitors + output/reports output/ascent diff --git a/docs/source_docs/user_guide/inputs/output/reports.rst b/docs/source_docs/user_guide/inputs/output/reports.rst new file mode 100644 index 0000000..f69ade8 --- /dev/null +++ b/docs/source_docs/user_guide/inputs/output/reports.rst @@ -0,0 +1,80 @@ +Reports +======= + +MFIX-Exa provides several options for reporting data from the solver. + +Particle size distribution +-------------------------- + +The particle size distribution (PSD) can be reported for different regions in the model. This feature requires +a region already defined in the regions inputs, and only volume regions are valid for PSD reports. +Each report must be associated with a single region; combining multiple regions in one report is not supported. + +The following inputs are defined using the prefix ``mfix.reports``: + ++--------------------+------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++====================+======================================================+=============+===========+ +| diameter | Names of the PSD reports | String | None | ++--------------------+------------------------------------------------------+-------------+-----------+ + + +The following inputs are defined using the prefix ``mfix.reports.diameter.[report]``: + ++--------------------+------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++====================+======================================================+=============+===========+ +| region | Region to compute the size distribution | String | None | ++--------------------+------------------------------------------------------+-------------+-----------+ +| int | Number of time steps between report outputs. | Int | None | +| | Cannot be used with ``per_approx``. | | | ++--------------------+------------------------------------------------------+-------------+-----------+ +| per_approx | Simulation time (in seconds) between report outputs. | Real | None | +| | Cannot be used with ``int``. | | | ++--------------------+------------------------------------------------------+-------------+-----------+ +| bins | Number of bins in PSD discretization | Int | None | ++--------------------+------------------------------------------------------+-------------+-----------+ +| min | Minimum particle size included in discretized PSD | Real | None | ++--------------------+------------------------------------------------------+-------------+-----------+ +| max | Maximum particle size included in discretized PSD | Real | None | ++--------------------+------------------------------------------------------+-------------+-----------+ + + +A sample :ref:`inputs snippet` for outputting the particle size distribution +is given below. Two regions are created that span the left and right sides of the domain, and used +to create two reports. The ``left-side`` report is a PSD consisting of 32 bins between 30-3000 microns +that is output every 50 time steps. The ``right-side`` report is a PSD consisting of 64 bins between +30-3000 microns that is output every 0.5 seconds of modeled time. + +.. _inputs_psd_report_ex: + +.. code-block:: bash + :caption: Snippet of inputs for particle size distribution reports. + + # Define two regions for collecting report data + # ------------------------------------------------------------- + mfix.regions = ... left right + + regions.left.lo = 0.00 0.00 0.00 + regions.left.hi = 0.05 0.10 0.10 + + regions.right.lo = 0.05 0.00 0.00 + regions.right.hi = 0.10 0.10 0.10 + + # Define two particle size distribution reports + # ------------------------------------------------------------- + mfix.reports.diameter = left-side right-side + + mfix.reports.diameter.left-side.region = left + + mfix.reports.diameter.left-side.int = 50 + mfix.reports.diameter.left-side.bins = 32 + mfix.reports.diameter.left-side.min = 30.0e-6 + mfix.reports.diameter.left-side.max = 3000.0e-6 + + mfix.reports.diameter.right-side.region = right + + mfix.reports.diameter.right-side.per_approx = 0.5 + mfix.reports.diameter.right-side.bins = 64 + mfix.reports.diameter.right-side.min = 30.0e-6 + mfix.reports.diameter.right-side.max = 3000.0e-6 -- GitLab