Commit 69313966 authored by Philipp Arras's avatar Philipp Arras

Merge branch 'fixup_cf_docstring' into 'NIFTy_7'

Fixup `add_fluctuations` docstring

See merge request !561
parents 8087f286 661f9df3
Pipeline #78760 passed with stages
in 26 minutes and 4 seconds
......@@ -429,15 +429,19 @@ class CorrelatedFieldMaker:
:class:`~nifty7.domain_tuple.DomainTuple`
Target subdomain on which the correlation structure defined
in this call should hold.
fluctuations : tuple of float
fluctuations : tuple of float (mean, std)
Total spectral energy -> Amplitude of the fluctuations
flexibility : tuple of float or None
LogNormal distribution
flexibility : tuple of float (mean, std) or None
Amplitude of the non-power-law power spectrum component
asperity : tuple of float or None
LogNormal distribution
asperity : tuple of float (mean, std) or None
Roughness of the non-power-law power spectrum component
Used to accommodate single frequency peaks
loglogavgslope : tuple of float
LogNormal distribution
loglogavgslope : tuple of float (mean, std)
Power law component exponent
Normal distribution
prefix : string
prefix of the power spectrum parameter domain names
index : int
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment