Skip to content

Commit 9572fae

Browse files
committed
Mention that particles with invalid ids are removed by default and be explicit about allowed ranges
1 parent 89409f8 commit 9572fae

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Docs/sphinx_documentation/source/Particle.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,13 @@ the creation of particle initial conditions in parallel. In storing these
4848
identifying numbers, 39 bits are devoted to the `id`, allowing approximately 550 billion
4949
possible *local* `id` numbers, and 24 bits are used to store the `cpu`, allowing about 16.8 million
5050
unique (MPI) processes.
51-
One bit is devoted to mark a particle valid or invalid.
51+
52+
One bit is devoted to mark a particle valid or invalid. This is often used to remove particles from a
53+
simulation. During :cpp:`Redistribute()`, particles with
54+
invalid ids are removed from the simulation by default, although this behavior is customizable. Particles
55+
with invalid ids are also not written out during plotfile writes or checkpoint / restart operations.
56+
The allowed values for :cpp:`p.id()` are 0 to 2**39, and the allowed values for :cpp:`p.cpu()` are
57+
0 to 2**24.
5258

5359
To pack and unpack these numbers, one uses the following syntax:
5460

0 commit comments

Comments
 (0)