Commit bc4666c7 authored by Charles G Waldman's avatar Charles G Waldman
Browse files

Merge branch 'main' into cgw-doc-cleanup

parents 13048916 1e5b0260
Loading
Loading
Loading
Loading
+28 −25
Original line number Diff line number Diff line
@@ -193,63 +193,66 @@ The following inputs are valid when using ``BoomerAMG`` as a preconditioner or s
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
|                                   |  Description                                                          |   Type      | Default      |
+===================================+=======================================================================+=============+==============+
| bamg_verbose                      | Set BoomerAMG verbosity                                               |    Int      |   0          |
| bamg_agg_interp_type              | See HYPRE_BoomerAMGSetAggInterpType                                   |    Int      |   4          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_logging                      | See HYPRE_BoomerAMGSetLogging                                         |    Int      |   0          |
| bamg_agg_num_levels               | See HYPRE_BoomerAMGSetAggNumLevels                                    |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_max_iterations               | See HYPRE_BoomerAMGSetMaxIter                                         |    Int      |   1          |
| bamg_agg_pmax_elmts               | See HYPRE_BoomerAMGSetAggPMaxElmts                                    |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_precond_tolerance            | See HYPRE_BoomerAMGSetTol                                             |    Real     |   0.0        |
| bamg_coarse_relax_type            | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_coarsen_type                 | See HYPRE_BoomerAMGSetCoarsenType                                     |    Int      |   6          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_cycle_type                   | See HYPRE_BoomerAMGSetCycleType                                       |    Int      |   1          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_relax_order                  | See HYPRE_BoomerAMGSetRelaxOrder                                      |    Int      |   1          |
| bamg_down_relax_type              | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_relax_type                   | See HYPRE_BoomerAMGSetRelaxType                                       |    Int      |   6          |
| bamg_interp_type                  | See HYPRE_BoomerAMGSetInterpType                                      |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_down_relax_type              | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
| bamg_keep_transpose               | See HYPRE_BoomerAMGSetKeepTranspose                                   |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_up_relax_type                | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
| bamg_logging                      | See HYPRE_BoomerAMGSetLogging                                         |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_coarse_relax_type            | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
| bamg_max_coarse_size              | See HYPRE_BoomerAMGSetMaxCoarseSize                                   |    Int      |   9          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_num_sweeps                   | See HYPRE_BoomerAMGSetNumSweeps                                       |    Int      |   2          |
| bamg_max_iterations               | See HYPRE_BoomerAMGSetMaxIter                                         |    Int      |   1          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_num_down_sweeps              | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   2          |
| bamg_max_levels                   | See HYPRE_BoomerAMGSetMaxLevels                                       |    Int      |   20         |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_num_up_sweeps                | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   2          |
| bamg_min_coarse_size              | See HYPRE_BoomerAMGSetMinCoarseSize                                   |    Int      |   1          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_num_coarse_sweeps            | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   1          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_mdax_levels                   | See HYPRE_BoomerAMGSetMaxLevels                                       |    Int      |   20         |
| bamg_num_down_sweeps              | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   2          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_strong_threshold             | See HYPRE_BoomerAMGSetStrongThreshold                                 |    Real     |   0.57       |
| bamg_num_down_sweeps              | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   2          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_interp_type                  | See HYPRE_BoomerAMGSetInterpType                                      |    Int      |   0          |
| bamg_num_sweeps                   | See HYPRE_BoomerAMGSetNumSweeps                                       |    Int      |   2          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_variant                      | See HYPRE_BoomerAMGSetVariant                                         |    Int      |   0          |
| bamg_num_sweeps                   | See HYPRE_BoomerAMGSetNumSweeps                                       |    int      |   2          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_keep_transpose               | See HYPRE_BoomerAMGSetKeepTranspose                                   |    Int      |   0          |
| bamg_num_up_sweeps                | See HYPRE_BoomerAMGSetCycleNumSweeps                                  |    Int      |   2          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_min_coarse_size              | See HYPRE_BoomerAMGSetMinCoarseSize                                   |    Int      |   1          |
| bamg_pmax_elmts                   | See HYPRE_BoomerAMGSetPMaxElmts                                       |    Int      |   4          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_max_coarse_size              | See HYPRE_BoomerAMGSetMaxCoarseSize                                   |    Int      |   9          |
| bamg_precond_tolerance            | See HYPRE_BoomerAMGSetTol                                             |    Real     |   0.0        |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_pmax_elmts                   | See HYPRE_BoomerAMGSetPMaxElmts                                       |    Int      |   4          |
| bamg_relax_order                  | See HYPRE_BoomerAMGSetRelaxOrder                                      |    Int      |   1          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_agg_num_levels               | See HYPRE_BoomerAMGSetAggNumLevels                                    |    Int      |   0          |
| bamg_relax_type                   | See HYPRE_BoomerAMGSetRelaxType                                       |    Int      |   6          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_agg_interp_type              | See HYPRE_BoomerAMGSetAggInterpType                                   |    Int      |   4          |
| bamg_set_restriction              | See HYPRE_BoomerAMGSetRestriction                                     |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_agg_pmax_elmts               | See HYPRE_BoomerAMGSetAggPMaxElmts                                    |    Int      |   0          |
| bamg_strong_threshold             | See HYPRE_BoomerAMGSetStrongThreshold                                 |    Real     |   0.57       |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_trunc_factor                 | See HYPRE_BoomerAMGSetTruncFactor                                     |    Real     |   0.1        |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_set_restriction              | See HYPRE_BoomerAMGSetRestriction                                     |    Int      |   0          |
| bamg_up_relax_type                | See HYPRE_BoomerAMGSetCycleRelaxType                                  |    Int      |   11         |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_variant                      | See HYPRE_BoomerAMGSetVariant                                         |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bamg_verbose                      | Set BoomerAMG verbosity                                               |    Int      |   0          |
+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+




+2 −1
Original line number Diff line number Diff line
Output
======

Stuff here?
Various options for outputting simulation data from MFIX-Exa.

.. toctree::
   :maxdepth: 0
@@ -9,4 +9,5 @@ Stuff here?
   output/checkpointing
   output/plotting
   output/monitors
   output/reports
   output/ascent
+0 −2
Original line number Diff line number Diff line
@@ -513,8 +513,6 @@ The following table lists all the solids phase variables that can be monitored:
+--------------------------+-----------------------------------------------------------------------------------------+
| T_s                      | particles temperature                                                                   |
+--------------------------+-----------------------------------------------------------------------------------------+
| convection               | particles convective heat transfer                                                      |
+--------------------------+-----------------------------------------------------------------------------------------+
| phase                    | particles phase                                                                         |
+--------------------------+-----------------------------------------------------------------------------------------+
| state                    | particles state                                                                         |
+43 −33

File changed.

Preview size limit exceeded, changes collapsed.

+80 −0
Original line number Diff line number Diff line
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<inputs_psd_report_ex>` 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