Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
N
NIFTy
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
13
Issues
13
List
Boards
Labels
Service Desk
Milestones
Merge Requests
13
Merge Requests
13
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
ift
NIFTy
Commits
aef6ea9b
Commit
aef6ea9b
authored
Jan 29, 2019
by
Martin Reinecke
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
tweak docs
parent
a85c366b
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
17 additions
and
19 deletions
+17
-19
nifty5/field.py
nifty5/field.py
+4
-4
nifty5/library/correlated_fields.py
nifty5/library/correlated_fields.py
+13
-15
No files found.
nifty5/field.py
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.
"""
...
...
nifty5/library/correlated_fields.py
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
:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment