Commit 8439fe6a authored by Ann Almgren's avatar Ann Almgren
Browse files

Update load balancing

parent 4e4b6ff0

docs/source/InputsLoadBalancing.rst

+2 −2
Original line number Diff line number Diff line
@@ -65,8 +65,8 @@ The following inputs must be preceded by "mfix" and determine how we load balanc 
+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| load_balance_fluid   | Only relevant if (dual_grid); if so do we also regrid mesh data       |  Int        | 1            |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| load_balance_type    | What strategy to use for load balancing                               |  String     | FixedSize    |

|                      | Options are "FixedSize", "KDTree" or "Knapsack"                       |             |              |

| load_balance_type    | What strategy to use for load balancing                               |  String     | KnapSack     |

|                      | Options are "KnapSack"or "SFC"                                        |             |              |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| knapsack_weight_type | What weighting function to use if using Knapsack load balancing       |  String     | RunTimeCosts |

|                      | Options are "RunTimeCosts" or "NumParticles""                         |             |              |

docs/source/LoadBalancing.rst

+2 −3
Original line number Diff line number Diff line
@@ -11,8 +11,7 @@ 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

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.)

assigned to 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
@@ -20,7 +19,7 @@ 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,

- 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