Skip to content

Commit f7e0163

Browse files
committed
move domain info after functor description
1 parent a693f82 commit f7e0163

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/source/usage/plugins/binningPlugin.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,21 @@ For two fields with one extra data parameter:
101101

102102
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.
103103

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.
109+
110+
.. literalinclude:: ../../../../share/picongpu/tests/compile2/include/picongpu/param/binningSetup.param
111+
:language: c++
112+
:start-after: doc-include-start: units
113+
:end-before: doc-include-end: units
114+
:dedent:
115+
116+
.. doxygenenum:: picongpu::SIBaseUnits::SIBaseUnits_t
117+
118+
104119
Domain Info
105120
-----------
106121
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:
194209

195210
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.
196211

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.
202-
203-
.. literalinclude:: ../../../../share/picongpu/tests/compile2/include/picongpu/param/binningSetup.param
204-
:language: c++
205-
:start-after: doc-include-start: units
206-
:end-before: doc-include-end: units
207-
:dedent:
208-
209-
.. doxygenenum:: picongpu::SIBaseUnits::SIBaseUnits_t
210-
211-
212212
Axis
213213
----
214214
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

Comments
 (0)