Commit fc6270e5 authored by Iain Bethune's avatar Iain Bethune Committed by Axel Kohlmeyer
Browse files

Docs for load balance changes

(cherry picked from commit fc7afc2242f25f3e1dae1ef0edfde61bde82a992)
parent f784f07b
Loading
Loading
Loading
Loading
+7 −1
Original line number Diff line number Diff line
@@ -58,6 +58,11 @@ subsequent run. To perform "dynamic" balancing, see the "fix
balance"_fix_balance.html command, which can adjust processor
sub-domain sizes and shapes on-the-fly during a "run"_run.html.

NOTE: If a particle is part of a "group"_group.html where a non-unity
{load_factor} is set, those particles are weighted when the load
balancer counts particles in each sub-domain.  Thus a particle with a
weight of 10 counts as much as 10 normal particles.

Load-balancing is typically only useful if the particles in the
simulation box have a spatially-varying density distribution.  E.g. a
model of a vapor/liquid interface, or a solid with an irregular-shaped
@@ -341,6 +346,7 @@ appear in {dimstr} for the {shift} style.

[Related commands:]

"processors"_processors.html, "fix balance"_fix_balance.html
"group"_group.html, "processors"_processors.html,
"fix balance"_fix_balance.html

[Default:] none
+6 −1
Original line number Diff line number Diff line
@@ -44,6 +44,11 @@ rebalancing is performed periodically during the simulation. To
perform "static" balancing, before or between runs, see the
"balance"_balance.html command.

NOTE: If a particle is part of a "group"_group.html where a non-unity
{load_factor} is set, those particles are weighted when the load
balancer counts particles in each sub-domain.  Thus a particle with a
weight of 10 counts as much as 10 normal particles.

Load-balancing is typically only useful if the particles in the
simulation box have a spatially-varying density distribution.  E.g. a
model of a vapor/liquid interface, or a solid with an irregular-shaped
@@ -340,6 +345,6 @@ style.

[Related commands:]

"processors"_processors.html, "balance"_balance.html
"group"_group.html, "processors"_processors.html, "balance"_balance.html

[Default:] none
+13 −4
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ group ID style args :pre
ID = user-defined name of the group :ulb,l
style = {delete} or {region} or {type} or {id} or {molecule} or {variable} or \
        {include} or {subtract} or {union} or {intersect} or \
        {dynamic} or {static} :l
        {dynamic} or {static} or {load_factor} :l
  {delete} = no args
  {clear} = no args
  {region} args = region-ID
@@ -42,7 +42,8 @@ style = {delete} or {region} or {type} or {id} or {molecule} or {variable} or \
      {region} value = region-ID
      {var} value = name of variable
      {every} value = N = update group every this many timesteps
  {static} = no args :pre
  {static} = no args
  {load_factor} value = weighting to apply to particles in the group for load balancing :pre
:ule

[Examples:]
@@ -60,7 +61,8 @@ group boundary subtract all a2 a3
group boundary union lower upper
group boundary intersect upper flow
group boundary delete
group mine dynamic all region myRegion every 100 :pre
group mine dynamic all region myRegion every 100
group mine load_factor 2.0 :pre


[Description:]
@@ -265,6 +267,12 @@ The {static} style removes the setting for a dynamic group, converting
it to a static group (the default).  The atoms in the static group are
those currently in the dynamic group.

The {load_factor} style applies a weight to all atoms in the group. When
load balancing is applied (by "balance"_balance.html or 
"fix balance"_fix_balance.html) the count of atoms per processor is
weighted by the produce of the load factors of the groups which each
atom is a member of.

:line

[Restrictions:]
@@ -276,7 +284,8 @@ The parent group of a dynamic group cannot itself be a dynamic group.

[Related commands:]

"dump"_dump.html, "fix"_fix.html, "region"_region.html,
"balance"_balance.html, "dump"_dump.html, "fix"_fix.html,
"fix balance"_fix_balance.html, "region"_region.html,
"velocity"_velocity.html

[Default:]