From 3e00ca26b8c01367288cf1fbca8bb6cc60888b52 Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan Date: Thu, 31 Oct 2024 10:32:24 -0400 Subject: [PATCH] new options for MPMD --- docs/source_docs/user_guide/inputs/output.rst | 1 + .../user_guide/inputs/output/mpmd.rst | 24 +++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 docs/source_docs/user_guide/inputs/output/mpmd.rst diff --git a/docs/source_docs/user_guide/inputs/output.rst b/docs/source_docs/user_guide/inputs/output.rst index 4b9bad4..7ef1612 100644 --- a/docs/source_docs/user_guide/inputs/output.rst +++ b/docs/source_docs/user_guide/inputs/output.rst @@ -11,3 +11,4 @@ Stuff here? output/monitors output/ascent output/spatial_avgs + output/mpmd diff --git a/docs/source_docs/user_guide/inputs/output/mpmd.rst b/docs/source_docs/user_guide/inputs/output/mpmd.rst new file mode 100644 index 0000000..97ff21a --- /dev/null +++ b/docs/source_docs/user_guide/inputs/output/mpmd.rst @@ -0,0 +1,24 @@ +Multiple Program Multiple Data (MPMD) +-------------------------------------- + +MFIX-Exa utilizes the AMReX-MPMD interface to send data across to another program or application. In order to enable this feature, the executable has to be built with ``-DMFIX_MPMD = yes``. + +The following inputs must be preceded by "mfix." and control frequency and the data that will be sent to the other program. + ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++======================+=======================================================================+=============+===========+ +| mpmd_int | Frequency at which data is sent to the other application | Int | -1 | +| | when using MPMD. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| mpmd_per_approx | Time period for sending data to the other pipeline (approximate) | Real | -1 | +| | when using MPMD. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| mpmd_static_mfs | A list of the names of static multifabs that will be sent | String | None | +| | only once when using MPMD. Possible values are | | | +| | "volfrac" and "centroid". | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| mpmd_mfs | A list of the names of multifabs that will be sent per set frequency | String | None | +| | when using MPMD. Possible values are "ep_g", "vel_g", "T_g" | | | +| | and "X_gk". | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ -- GitLab