Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
NIFTy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ift
NIFTy
Commits
aef6ea9b
Commit
aef6ea9b
authored
6 years ago
by
Martin Reinecke
Browse files
Options
Downloads
Patches
Plain Diff
tweak docs
parent
a85c366b
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
nifty5/field.py
+4
-4
4 additions, 4 deletions
nifty5/field.py
nifty5/library/correlated_fields.py
+13
-15
13 additions, 15 deletions
nifty5/library/correlated_fields.py
with
17 additions
and
19 deletions
nifty5/field.py
+
4
−
4
View file @
aef6ea9b
...
...
@@ -36,8 +36,8 @@ class Field(object):
This object
'
s global shape must match the domain shape
After construction, the object will no longer be writeable!
Note
----
Note
s
----
-
If possible, do not invoke the constructor directly, but use one of the
many convenience functions for instantiation!
"""
...
...
@@ -190,8 +190,8 @@ class Field(object):
def
val
(
self
):
"""
dobj.data_object : the data object storing the field
'
s entries.
Note
----
Note
s
----
-
This property is intended for low-level, internal use only. Do not use
from outside of NIFTy
'
s core; there should be better alternatives.
"""
...
...
This diff is collapsed.
Click to expand it.
nifty5/library/correlated_fields.py
+
13
−
15
View file @
aef6ea9b
...
...
@@ -51,13 +51,12 @@ def CorrelatedField(target, amplitude_operator, name='xi', codomain=None):
Operator
Correlated field
Note
----
Non-harmonic RGSpaces are by definition periodic in NIFTy. Thereby, the
output of the operator being constructed by the method at hand, is a
correlated field with *periodic* boundary conditions. If a non-periodic
field is needed, one needs to compose this operator with a
:class:`FieldZeroPadder`.
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder`.
"""
tgt
=
DomainTuple
.
make
(
target
)
if
len
(
tgt
)
>
1
:
...
...
@@ -99,14 +98,13 @@ def MfCorrelatedField(target, amplitudes, name='xi'):
Operator
Correlated field
Note
----
Non-harmonic RGSpaces are by definition periodic in NIFTy. Thereby, the
output of the operator being constructed by the method at hand, is a
correlated field with *periodic* boundary conditions. If a non-periodic
field is needed, one needs to compose this operator with a
:class:`FieldZeroPadder` or even two of them (one for the energy and one
for the spatial subdomain).
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder` or even
two (one for the energy and one for the spatial subdomain)
"""
tgt
=
DomainTuple
.
make
(
target
)
if
len
(
tgt
)
!=
2
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment