Commit 9863f379 authored by Roberto Porcu's avatar Roberto Porcu
Browse files

minor fixes to inputs prefixes

parent a1346e5e
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
Checkpoint/Restart
==================

The following inputs must be preceded by "mfix" and control checkpoint/restart.
The following inputs must be preceded by "mfix." and control checkpoint/restart.

+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                         | Description                                                           |   Type      | Default   |
+3 −3
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
Initialization
==============

The following inputs must be preceded by "mfix" and determine how we initialize a calculation:
The following inputs must be preceded by "mfix." and determine how we initialize a calculation:

+----------------------+-----------------------------------------------------------------------+-------------+--------------+
|                      | Description                                                           |   Type      | Default      |
@@ -18,7 +18,7 @@ The following inputs must be preceded by "mfix" and determine how we initialize
+----------------------+-----------------------------------------------------------------------+-------------+--------------+


The following inputs must be preceded by "mfix" and determine how we initialize a calculation:
The following inputs must be preceded by "mfix." and determine how we initialize a calculation:

+----------------------+-----------------------------------------------------------------------+-------------+--------------+
|                      | Description                                                           |   Type      | Default      |
@@ -31,7 +31,7 @@ The following inputs must be preceded by "mfix" and determine how we initialize
| initial_iterations   | How many pressure iterations before starting the first timestep       |  Int        |    3         |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+

The following inputs must be preceded by "particles."
The following inputs must be preceded by "particles.":

+--------------------+---------------------------------------------------------------------------+-------------+-----------+
|                    | Description                                                               |   Type      | Default   |
+5 −5
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@
Gridding and Load Balancing
===========================

The following inputs must be preceded by "amr" and determine how we create the grids.
The following inputs must be preceded by "amr." and determine how we create the grids.

+----------------------+-----------------------------------------------------------------------+-------------+-----------+
|                      | Description                                                           |   Type      | Default   |
@@ -24,7 +24,7 @@ The following inputs must be preceded by "amr" and determine how we create the g
| blocking_factor_z    | Each grid must be divisible by blocking_factor_z in z-direction       |    Int      |  8        |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+

The following inputs must be preceded by "mfix" and determine how often we regrid.
The following inputs must be preceded by "mfix." and determine how often we regrid.

+----------------------+-----------------------------------------------------------------------+-------------+-----------+
|                      | Description                                                           |   Type      | Default   |
@@ -33,7 +33,7 @@ The following inputs must be preceded by "mfix" and determine how often we regri
|                      | if regrid_int = -1 then no regridding will occur                      |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+

The following inputs must be preceded by "fabarray_mfiter" and determine how we create the logical tiles:
The following inputs must be preceded by "fabarray_mfiter." and determine how we create the logical tiles:

+----------------------+-----------------------------------------------------------------------+----------+-------------+
|                      | Description                                                           | Type     | Default     |
@@ -42,7 +42,7 @@ The following inputs must be preceded by "fabarray_mfiter" and determine how we
|                      |        (3D CPU-only)                                                  |          | 1024000,8,8 |
+----------------------+-----------------------------------------------------------------------+----------+-------------+

The following inputs must be preceded by "particles"
The following inputs must be preceded by "particles."

+----------------------+-----------------------------------------------------------------------+-------------+--------------+
|                      | Description                                                           |   Type      | Default      |
@@ -68,7 +68,7 @@ the :cpp:`particles.max_grid_size` (in each direction) have no meaning. Therefor
sizes should be set for particle load balancing. It may also be necessary to set the blocking factors to 1.


The following inputs must be preceded by "mfix" and determine how we load balance:
The following inputs must be preceded by "mfix." and determine how we load balance:

+----------------------+-----------------------------------------------------------------------+-------------+--------------+
|                      | Description                                                           |   Type      | Default      |
+7 −7
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
Spatial averages
================

The following inputs must be preceded by "mfix" and control whether to compute
The following inputs must be preceded by "mfix." and control whether to compute
spatial averages, and how often to output the results.  n is the number of
spatial averages implicitly defined by the size of avg_region_x_w.

@@ -52,7 +52,7 @@ A Monitor is a tool for capturing data from the solver about the model.

Data (such as volume fraction, pressure, velocity, etc.) for a given
monitor region is written to a CSV file while the solver is running.
To define monitors, the following inputs must be preceded by "mfix" prefix.
To define monitors, the following inputs must be preceded by "mfix.":

+--------------------+------------------------------------------------------+-------------+-----------+
|                    | Description                                          |   Type      | Default   |
@@ -75,8 +75,8 @@ Region Selection

To define a monitor, there must be a region already defined in the regions
inputs. A Monitor region is a single point, plane, or volume. Multiple regions
cannot be combined for a monitor. The following inputs must be preceded by the
"mfix.monitors" prefix.
cannot be combined for a monitor. The following inputs must be preceded by
"mfix.monitors.":

+------------------+-----------------------------------------------------------------------+-------------+-----------+
|                  | Description                                                           |   Type      | Default   |
@@ -97,8 +97,8 @@ Monitor Output
The monitor data will be output to a file with name given by the input
"plot_file", and the extension ``.csv`` is automatically added. The monitor
output file is in Comma Separated Value (CSV) format. The first line of the file
provides header information. The following inputs must be preceded by the
"mfix.monitors" prefix.
provides header information. The following inputs must be preceded by
"mfix.monitors.":

+-------------------------------+----------------------------------------------------------+-------------+-----------+
|                               | Description                                              |   Type      | Default   |
@@ -139,7 +139,7 @@ Monitor Variables
-----------------

The variables to be monitored can be specified in the inputs by including the
following input preceded by the "mfix.monitors" prefix.
following input preceded by the "mfix.monitors.":

+---------------------+--------------------------------------------------------------------+-------------+-----------+
|                     | Description                                                        |   Type      | Default   |
+3 −3
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ different solvers called by MFIX-Exa.
NOTE: the nodal solver settings are read in directly by AMReX, 
the MAC and diffusion settings by MFIX-Exa. 

These control the nodal projection and must be preceded by "nodal_proj": 
These control the nodal projection and must be preceded by "nodal_proj.": 

+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
|                         |  Description                                                          |   Type      | Default      |
@@ -42,7 +42,7 @@ These control the nodal projection and must be preceded by "nodal_proj":
|                         |  Options are ij, semi_structured or structured                        |             |              | 
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+

These control the MAC projection and must be preceded by "mac_proj":
These control the MAC projection and must be preceded by "mac_proj.":

+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
|                         | Description                                                           |   Type      | Default      |
@@ -78,7 +78,7 @@ These control the MAC projection and must be preceded by "mac_proj":
NOTE: If the :cpp:`nodal_proj` and :cpp:`mac_proj` :cpp:`hypre_namespace`'s are set, they must be distinct unless set to 
:cpp:`hypre`, in which case the default behavior is recovered in which case hypre settings apply to all solvers.  

These control the diffusion solver and must be preceded by "diffusion":
These control the diffusion solver and must be preceded by "diffusion.":

+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
|                         | Description                                                           |   Type      | Default      |
Loading