openmc-dev / openmc

OpenMC Monte Carlo Code
https://docs.openmc.org
Other
699 stars 444 forks source link

Rename max_splits to max_history_splits, set default value to 1.0e7 #2954

Open vanessalulla opened 3 weeks ago

vanessalulla commented 3 weeks ago

Description

It was noted that the two variables max_split and max_splits had very similar naming. Max_split is a member of the weight window object and limits the number of splits during a single check against the weight window. Max_splits is a member of the settings object and limits the number of times a history can be split. Max_splits has a notable effect on the effectiveness of the weight window while max_split does not.

It was also found that the default value of 1000 splits is not enough when you have many orders of magnitude decrease in your flux across your model.

This PR renames the variable max_splits variable to max_history_splits to make it more clear for users and sets the default value of max_history_splits to be 1.0e7.

Fixes #2774

Checklist