Apply suggestions from code review

Co-authored-by: Ethan Peterson <ethan.peterson@mit.edu>
This commit is contained in:
Patrick Shriwise 2022-01-26 15:22:51 -06:00 committed by GitHub
parent c6d4f1a5ed
commit 70d1665643
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -49,8 +49,9 @@ class WeightWindows(IDManagerMixin):
Ratio of the survival weight to the lower weight window bound for
rouletting
max_lower_bound_ratio: float
Maximum allowed ratio of a weight window's lower bound to particle weight.
A factor will be applied to raise the weight window to the particle's weight
Maximum allowed ratio of a particle's weight to the weight window's
lower bound. A factor will be applied to raise the weight window to
be lower than the particle's weight by a factor of max_lower_bound_ratio
during transport if exceeded. Only applied if > 1.0. (Default: 1.0).
max_split : int
Maximum allowable number of particles when splitting
@ -81,8 +82,8 @@ class WeightWindows(IDManagerMixin):
Ratio of the survival weight to the lower weight window bound for
rouletting
max_lower_bound_ratio: float
Maximum allowed ratio of a weight window's lower bound to particle
weight. (Default: 1.0)
Maximum allowed ratio of a particle's weight to the weight window's
lower bound. (Default: 1.0)
max_split : int
Maximum allowable number of particles when splitting
weight_cutoff : float