Skip to content

Commit a2fe438

Browse files
Added sobol_scatter in the documentation.
1 parent 34084e6 commit a2fe438

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

Modules/Ensemble.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,6 +1054,8 @@ class is created.
10541054
Defines if the calculation uses random Gaussian generator or Sobol Gaussian generator.
10551055
sobol_scramble : bool, optional (Default = False)
10561056
Set the optional scrambling of the generated numbers taken from the Sobol sequence.
1057+
sobol_scatter : real (0.0 to 1) (Deafault = 0.0)
1058+
Set the scatter parameter to displace the Sobol positions randommly.
10571059
10581060
"""
10591061

Modules/Relax.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,8 @@ def relax(self, restart_from_ens = False, get_stress = False,
285285
Defines if the calculation uses random Gaussian generator or Sobol Gaussian generator.
286286
sobol_scramble : bool, optional (Default = False)
287287
Set the optional scrambling of the generated numbers taken from the Sobol sequence.
288+
sobol_scatter : real (0.0 to 1) (Deafault = 0.0)
289+
Set the scatter parameter to displace the Sobol positions randommly.
288290
289291
Returns
290292
-------
@@ -442,7 +444,9 @@ def vc_relax(self, target_press = 0, static_bulk_modulus = 100,
442444
Defines if the calculation uses random Gaussian generator or Sobol Gaussian generator.
443445
sobol_scramble : bool, optional (Default = False)
444446
Set the optional scrambling of the generated numbers taken from the Sobol sequence.
445-
447+
sobol_scatter : real (0.0 to 1) (Deafault = 0.0)
448+
Set the scatter parameter to displace the Sobol positions randommly.
449+
446450
Returns
447451
-------
448452
status : bool

0 commit comments

Comments
 (0)