You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/usage/plugins/binningPlugin.rst
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,6 +101,21 @@ For two fields with one extra data parameter:
101
101
102
102
Fields and extra data may be tuples with multiple elements which are unpacked and passed to the user-defined functors. Therefore, it is the responsibility of the user to ensure that their functors have an appropriate number of arguments to match the provided tuples.
103
103
104
+
Dimensionality and units
105
+
^^^^^^^^^^^^^^^^^^^^^^^^
106
+
Users can specify the units of their functor output using a 7 dimensional array. Each element of the array corresponds to an SI base unit, and the value stored in that index is the exponent of the unit.
107
+
The dimensional base quantities are defined in ``SIBaseUnits_t`` following the international system of quantities (ISQ).
108
+
If no units are given, the quantity is assumed to be dimensionless.
The binning plugin passes the domain info object to functors as a parameter to give the user access to some useful PIConGPU quantities inside the functor.
@@ -194,21 +209,6 @@ The available units are:
194
209
195
210
Using positions in SI/PIC units introduces floating point numerical errors and may be especially problematic when using the ``TOTAL`` origin with moving window, because floating-point precision decreases as the distance from the origin increases.
196
211
197
-
Dimensionality and units
198
-
^^^^^^^^^^^^^^^^^^^^^^^^
199
-
Users can specify the units of their functor output using a 7 dimensional array. Each element of the array corresponds to an SI base unit, and the value stored in that index is the exponent of the unit.
200
-
The dimensional base quantities are defined in ``SIBaseUnits_t`` following the international system of quantities (ISQ).
201
-
If no units are given, the quantity is assumed to be dimensionless.
Axis is a combination of a :ref:`functor description <usage/plugins/binningPlugin:Functor Description>` and an :ref:`axis splitting <usage/plugins/binningPlugin:Axis Splitting>`.
0 commit comments