Skip to content
Snippets Groups Projects
Commit 30f0c275 authored by Theo Steininger's avatar Theo Steininger
Browse files

Fixed indentation in in sugar.py

parent 2580647e
No related branches found
No related tags found
4 merge requests!141Master,!137Master,!136Master,!135added documentation to create_power_operator and Field::synthesize/analyze_power…
Pipeline #
......@@ -26,30 +26,30 @@ __all__ = ['create_power_operator']
def create_power_operator(domain, power_spectrum, dtype=None,
distribution_strategy='not'):
"""Creates a diagonal operator with a certain power spectrum.
Constructs a diagonal operator that lives over the specified domain, or
its harmonic domain in case it is not harmonic.
Parameters
----------
domain : DomainObject
Domain over which the power operator shall live. If this is not a
harmonic domain, it will return an operator for its harmonic domain
instead.
power_spectrum : {array-like, method}
An array-like object, or a method that implements the square root
of a power spectrum as a function of k.
dtype : type, *optional*
dtype that the field holding the power spectrum shall use
{default : None}
if dtype == None: passes this on to constructor of Field
distribution_strategy : string, *optional*
Distributed strategy to be used by the underlying d2o objects.
{default : 'not'}
Returns
-------
DiagonalOperator : An operator that lives that implements the given power
spectrum.
"""
""" Creates a diagonal operator with a certain power spectrum.
Constructs a diagonal operator that lives over the specified domain, or
its harmonic domain in case it is not harmonic.
Parameters
----------
domain : DomainObject
Domain over which the power operator shall live. If this is not a
harmonic domain, it will return an operator for its harmonic domain
instead.
power_spectrum : {array-like, method}
An array-like object, or a method that implements the square root
of a power spectrum as a function of k.
dtype : type, *optional*
dtype that the field holding the power spectrum shall use
{default : None}
if dtype == None: passes this on to constructor of Field
distribution_strategy : string, *optional*
Distributed strategy to be used by the underlying d2o objects.
{default : 'not'}
Returns
-------
DiagonalOperator : An operator that lives that implements the given power
spectrum.
"""
if not domain.harmonic:
fft = FFTOperator(domain)
domain = fft.target[0]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment