Skip to content

Commit

Permalink
Update user_guide_reference_actors.rst
Browse files Browse the repository at this point in the history
New details about the PhaseSpaceActor and its steps_to_stores options
  • Loading branch information
CarlottaTrigila authored and nkrah committed Nov 18, 2024
1 parent 0d3dec4 commit 8390933
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/user_guide/user_guide_reference_actors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,13 @@ By default, the PhaseSpaceActor stores information about particles entering the
phsp.steps_to_store = "entering" # this is the default
phsp.steps_to_store = "entering exiting first" # other options (combined)
The option “first” stores the particle information when it enters the volume to which the actor is attached for the first time. The variables to be used are the PrePosition, PreDirection, etc.

The option “entering” stores the particle information whenever it is at the boundary between the surrounding environment (world, another volume) and the volume to which the actor is attached. The variables to be used are the PrePosition, PreDirection, etc.
For example: if a particle enters the volume only once, its information is stored only once; the option entering is equal to the option first. If a particle passes through a volume, performs n scattering outside of it, and re-enters the volume, its entry information will be stored n times. If a particle interacts with the volume interfaces without exiting the volume (e.g., the reflection of optical photons), the actor will store all instances when the particle is at the boundary (all reflections are stored).

The option “exiting” stores the particle information whenever, starting from within the volume, it is at the boundary between the volume to which the actor is attached and the surrounding environment (world, another volume). The variables to be used are the PostPosition, PostDirection, etc.


Reference
~~~~~~~~~
Expand Down

0 comments on commit 8390933

Please sign in to comment.