Skip to content

Commit cec4b29

Browse files
committed
include link to swarm packs
1 parent a772fcb commit cec4b29

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

doc/sphinx/src/particles.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,16 @@ Similarly to grid variables, particle swarms support
151151
This also supports ``FlatIdx`` for indexing; see the
152152
``particle_leapfrog`` example for usage.
153153

154-
``SwarmPack``s
155-
----------------
154+
. _swarm_packs:
155+
156+
``SwarmPack``\ s
157+
--------------
156158

157-
Similar to grid variables, swarms can be packed over ``MeshBlock``s via ``SwarmPack``s.
158-
``SwarmPack``s are the particle analog to ``SparsePack``s for field variables. A single
159+
Similar to grid variables, swarms can be packed over ``MeshBlock``\ s via ``SwarmPack``\ s.
160+
``SwarmPack``\ s are the particle analog to ``SparsePack``\ s for field variables. A single
159161
``SwarmPack`` can contain either ``int`` or ``Real`` entries, but not both. One can pack
160162
a ``SwarmPack`` via a ``std::vector<std::string>`` or the type-based variable prescription
161-
previously used by ``SparsePack``s.
163+
previously used by ``SparsePack``\ s (see :ref:`sparse_packs`).
162164

163165
For packing via string (wherein below, ``swarm_position::x::name()`` returns a string),
164166
one must specify the data type by template argument:

doc/sphinx/src/sparse_packs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ etc. within a kernel.
1616

1717
``SparsePack``\ *s work for all types of variables (both dense and sparse). They were originally implemented to support sparse variables and to supersede the older* ``VariablePack``\ *s and* ``VariableFluxPack``\ *s and picked up the* ``Sparse`` *modifier to differentiate them. The latter have not been removed from ``Parthenon`` because some downstream codes still rely on them, but they are deprecated and will be removed eventually.*
1818

19+
*If you want to deal with particle fields, you will need to use* ``SwarmPack``\ *s, which are described at :ref:`swarm_packs`.
1920
Type-based Packing
2021
------------------
2122

0 commit comments

Comments
 (0)