diff --git a/docs/source/InputsMonitors.rst b/docs/source/InputsMonitors.rst index 3d54a4a1d20c83d2984c9b314323d715603c44d2..580cea30c22ff5b3804cdc70e4da91a6c26dcf1e 100644 --- a/docs/source/InputsMonitors.rst +++ b/docs/source/InputsMonitors.rst @@ -4,16 +4,16 @@ Monitors ======== The following inputs must be preceded by "amr" and control whether to compute -monitors, i.e., spatial averages, and how often to output the results. -n is the number of monitors implicitly defined by the size of avg_region_x_w. +monitors, i.e., spatial averages, and how often to output the results. +n is the number of monitors implicitly defined by the size of avg_region_x_w. +------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +==================+=======================================================================+=============+===========+ | avg_int | Interval, in number of CFD dt's, to write output | Int | -1 | +------------------+-----------------------------------------------------------------------+-------------+-----------+ -| avg_file | Base file name which is appended with the data type (vel_p_, p_g_, | String | avg_region| -| | ep_g_ or vel_g_), the number of this type of averaging, and the .csv | | | +| avg_file | Base file name which is appended with the data type (vel_p, p_g, | String | avg_region| +| | ep_g or vel_g), the number of this type of averaging, and the .csv | | | | | file extension | | | +------------------+-----------------------------------------------------------------------+-------------+-----------+ | avg_vel_p | Average and save particle velocity (if 1) | n*Int | 0 | @@ -36,6 +36,3 @@ n is the number of monitors implicitly defined by the size of avg_region_x_w. +------------------+-----------------------------------------------------------------------+-------------+-----------+ | avg_region_z_t | Upper bound of averaging region in z-direction | n*Real | None | +------------------+-----------------------------------------------------------------------+-------------+-----------+ - - - diff --git a/docs/source/InputsProblemDefinition.rst b/docs/source/InputsProblemDefinition.rst index bd6c14c7f0dca0719e8e66913405d0b933efce85..66fef77f7509f2028d3723a9da8ef34640e100d7 100644 --- a/docs/source/InputsProblemDefinition.rst +++ b/docs/source/InputsProblemDefinition.rst @@ -27,12 +27,12 @@ The following inputs must be preceded by "geometry." The following inputs must be preceded by "mfix." -+----------------------+-------------------------------------------------------------------------+-------------+--------+ ++----------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +======================+=========================================================================+==========+===========+ | geometry | Which type of EB geometry are we using? | String | | +----------------------+-------------------------------------------------------------------------+----------+-----------+ -| levelset__refinement | Refinement factor of levelset resolution relative to level 0 resolution | Int | 1 ! +| levelset__refinement | Refinement factor of levelset resolution relative to level 0 resolution | Int | 1 | +----------------------+-------------------------------------------------------------------------+----------+-----------+ Setting basic EB walls can be specified by inputs preceded by "xlo", "xhi", "ylo", "yhi", "zlo", and "zhi" diff --git a/docs/source/LoadBalancing.rst b/docs/source/LoadBalancing.rst index 7496e3934c3b7ea16081b9e1f1e97057350dc60d..7c685d8617a693bcd8fc432e2389aebbfedbfe7c 100644 --- a/docs/source/LoadBalancing.rst +++ b/docs/source/LoadBalancing.rst @@ -9,23 +9,23 @@ Load Balancing -------------- -The process of load balancing is typically independent of the process of grid creation; -the inputs to load balancing are a given set of grids with a set of weights +The process of load balancing is typically independent of the process of grid creation; +the inputs to load balancing are a given set of grids with a set of weights assigned to each grid. (The exception to this is the KD-tree approach in which the grid creation process is governed by trying to balance the work in each grid.) -Single-level load balancing algorithms are sequentially applied to each AMR level independently, -and the resulting distributions are mapped onto the ranks taking into account the weights +Single-level load balancing algorithms are sequentially applied to each AMR level independently, +and the resulting distributions are mapped onto the ranks taking into account the weights already assigned to them (assign heaviest set of grids to the least loaded rank) Options supported by AMReX include: -- Knapsack: the default weight of a grid in the knapsack algorithm is the number of grid cells, - but AMReX supports the option to pass an array of weights – one per grid – or alternatively +- Knapsack: the default weight of a grid in the knapsack algorithm is the number of grid cells, + but AMReX supports the option to pass an array of weights – one per grid – or alternatively to pass in a MultiFab of weights per cell which is used to compute the weight per grid -- SFC: enumerate grids with a space-filling Z-morton curve, then partition the +- SFC: enumerate grids with a space-filling Z-morton curve, then partition the resulting ordering across ranks in a way that balances the load - Round-robin: sort grids and assign them to ranks in round-robin fashion -- specifically - FAB *i* is owned by CPU *i*%N where N is the total number of MPI ranks. + FAB ``i`` is owned by CPU ``i % N`` where N is the total number of MPI ranks.