Commit edc99725 authored by Philipp Arras's avatar Philipp Arras
Browse files

Add docstrings

parent e5f17f22
Pipeline #75304 failed with stages
in 3 minutes and 9 seconds
...@@ -408,8 +408,12 @@ class CorrelatedFieldMaker: ...@@ -408,8 +408,12 @@ class CorrelatedFieldMaker:
If not 0, the first entry of the operators target will be an If not 0, the first entry of the operators target will be an
:class:`~nifty.domains.unstructured_domain.UnstructuredDomain` :class:`~nifty.domains.unstructured_domain.UnstructuredDomain`
with length `total_N`. with length `total_N`.
dofdex : np.array dofdex : np.array of integers
#FixMe An integer array specifying the zero mode models used if
total_N > 1. It needs to have length of total_N. If total_N=3 and
dofdex=[0,0,1], that means that two models for the zero mode are
instanciated; the first one is used for the first and second copy
of the model and the second is used for the third.
""" """
if dofdex is None: if dofdex is None:
dofdex = np.full(total_N, 0) dofdex = np.full(total_N, 0)
...@@ -472,10 +476,15 @@ class CorrelatedFieldMaker: ...@@ -472,10 +476,15 @@ class CorrelatedFieldMaker:
Power law component exponent Power law component exponent
prefix : string prefix : string
prefix of the power spectrum parameter domain names prefix of the power spectrum parameter domain names
index : index : int
#FixMe Position target_subdomain in the final total domain of the
dofdex : correlated field operator.
#FixMe dofdex : np.array
An integer array specifying the amplitude models used if
total_N > 1. It needs to have length of total_N. If total_N=3 and
dofdex=[0,0,1], that means that two models for the zero mode are
instanciated; the first one is used for the first and second copy
of the model and the second is used for the third.
harmonic_partner : :class:`~nifty6.domain.Domain`, \ harmonic_partner : :class:`~nifty6.domain.Domain`, \
:class:`~nifty6.domain_tuple.DomainTuple` :class:`~nifty6.domain_tuple.DomainTuple`
In which harmonic space to define the power spectrum In which harmonic space to define the power spectrum
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
# Copyright(C) 2013-2019 Max-Planck-Society # Copyright(C) 2013-2020 Max-Planck-Society
# #
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik. # NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
......
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