Navigate through an ORANGE geometry on a single thread. More...

#include <OrangeTrackView.hh>

Public Types
Type aliases
using	ParamsRef = NativeCRef< OrangeParamsData >

using	StateRef = NativeRef< OrangeStateData >

using	Initializer_t = GeoTrackInitializer

using	LSA = LevelStateAccessor

using	UniverseIndexer = detail::UniverseIndexer

Public Member Functions
CELER_FUNCTION	OrangeTrackView (ParamsRef const &params, StateRef const &states, TrackSlotId tid)
	Construct from persistent and state data.

CELER_FUNCTION OrangeTrackView &	operator= (Initializer_t const &init)
	Construct the state.

CELER_FUNCTION Real3 const &	pos () const
	The current position.

CELER_FUNCTION Real3 const &	dir () const
	The current direction.

CELER_FUNCTION VolumeId	volume_id () const
	The current canonical volume ID.

CELER_FUNCTION VolumeInstanceId	volume_instance_id () const
	The current volume instance.

CELER_FUNCTION void	volume_instance_id (Span< VolumeInstanceId >) const
	Get the volume instance ID at every level.

CELER_FUNCTION bool	is_outside () const
	Whether the track is outside the valid geometry region.

CELER_FUNCTION bool	is_on_boundary () const
	Whether the track is exactly on a surface.

CELER_FORCEINLINE_FUNCTION bool	failed () const
	Whether the last operation resulted in an error.

CELER_FUNCTION Real3	normal () const
	Get the normal vector of the current surface.

CELER_FUNCTION Propagation	find_next_step ()
	Find the distance to the next geometric boundary.

CELER_FUNCTION Propagation	find_next_step (real_type max_step)
	Find a nearby distance to the next geometric boundary up to a distance.

CELER_FUNCTION real_type	find_safety ()
	Find the distance to the nearest boundary in any direction.

CELER_FUNCTION real_type	find_safety (real_type max_step)
	Find the distance to the nearest nearby boundary.

CELER_FUNCTION void	move_to_boundary ()
	Move to the next straight-line boundary but do not change volume.

CELER_FUNCTION void	move_internal (real_type step)
	Move within the current volume.

CELER_FUNCTION void	move_internal (Real3 const &pos)
	Move within the current volume to a nearby point.

CELER_FUNCTION void	cross_boundary ()
	Cross from one side of the current surface to the other.

CELER_FUNCTION void	set_dir (Real3 const &newdir)
	Change the track's direction.

CELER_FUNCTION OrangeParamsScalars const &	scalars () const
	Geometry constant parameters.

CELER_FUNCTION LevelId const &	level () const
	The current universe hierarchy depth.

CELER_FUNCTION ImplVolumeId	impl_volume_id () const
	The current "global" volume ID.

CELER_FUNCTION ImplSurfaceId	impl_surface_id () const
	The current surface ID.

CELER_FUNCTION ImplSurfaceId	next_impl_surface_id () const
	After 'find_next_step', the next straight-line surface.

CELER_FUNCTION UniverseIndexer	make_universe_indexer () const
	Make a UniverseIndexer to convert local to global IDs.

CELER_FUNCTION LSA	make_lsa () const
	Make a LevelStateAccessor for the current thread and level.

CELER_FUNCTION LSA	make_lsa (LevelId level) const
	Make a LevelStateAccessor for the current thread and a given level.

Detailed Description

Navigate through an ORANGE geometry on a single thread.

Since the navigation relies on computationally expensive calls and must ensure a consistent state between physical and logical boundaries, there is an ordering followed by Celeritas' internal calls to each track's state. Access (pos, dir, volume/surface/is_outside/is_on_boundary) is valid at any time.

The required ordering is:

Initialization, via the assignment operator
Locating the boundary crossing along the current direction, find_next_step
Locating the closest point on the boundary in any direction, find_safety
Movement within a volume, not crossing a boundary: move_internal or move_to_boundary
If on a boundary, logically moving to the adjacent volume ("relocation") with cross_boundary

At any time, set_dir may be called, but then find_next_step must again be called before any subsequent move or cross action above .

The main point is that find_next_step depends on the current straight-line direction, move_to_boundary and move_internal (with a step length) depends on that distance, and cross_boundary depends on being on the boundary with a knowledge of the post-boundary state.

The direction of normal is set to always point out of the volume the track is currently in. On the boundary this is determined by the sense of the track rather than its direction.

Todo:: move_internal with a position should depend on the safety distance, but that check is not yet implemented.

Todo:: LevelId should be ImplLevelId .

Member Function Documentation

◆ cross_boundary()

CELER_FUNCTION void celeritas::OrangeTrackView::cross_boundary ( )

inline

Cross from one side of the current surface to the other.

The position must be on the boundary following a move-to-boundary. This should only be called once per boundary crossing.

◆ find_next_step()

CELER_FUNCTION Propagation celeritas::OrangeTrackView::find_next_step ( real_type max_step )

inline

Find a nearby distance to the next geometric boundary up to a distance.

This may reduce the number of surfaces needed to check, sort, or write to temporary memory, thereby speeding up transport.

◆ find_safety() [1/2]

CELER_FUNCTION real_type celeritas::OrangeTrackView::find_safety ( )

inline

Find the distance to the nearest boundary in any direction.

The safety distance at a given point is the minimum safety distance over all levels, since surface deduplication can potentionally elide bounding surfaces at more deeply embedded levels.

◆ find_safety() [2/2]

CELER_FUNCTION real_type celeritas::OrangeTrackView::find_safety ( real_type max_step )

inline

Find the distance to the nearest nearby boundary.

Since we currently support only "simple" safety distances, we can't eliminate anything by checking only nearby surfaces.

◆ impl_volume_id()

CELER_FUNCTION ImplVolumeId celeritas::OrangeTrackView::impl_volume_id ( ) const

inline

The current "global" volume ID.

Note: It is allowable to call this function when "outside", because the outside in ORANGE is just a special volume.

◆ level()

CELER_FORCEINLINE_FUNCTION LevelId const & celeritas::OrangeTrackView::level ( ) const

inline

The current universe hierarchy depth.

Zero corresponds to being in the global universe.

◆ make_lsa() [1/2]

CELER_FORCEINLINE_FUNCTION auto celeritas::OrangeTrackView::make_lsa ( ) const

inline

Make a LevelStateAccessor for the current thread and level.

Please treat as read-only outside this class!

◆ make_lsa() [2/2]

CELER_FORCEINLINE_FUNCTION auto celeritas::OrangeTrackView::make_lsa ( LevelId level ) const

inline

Make a LevelStateAccessor for the current thread and a given level.

Note that access beyond the current level is allowable: cross_boundary locally updates the level before committing the change.

◆ move_internal() [1/2]

CELER_FUNCTION void celeritas::OrangeTrackView::move_internal ( Real3 const & pos )

inline

Move within the current volume to a nearby point.

Todo:: Currently it's up to the caller to make sure that the position is "nearby". We should actually test this with an "is inside" call.

◆ move_internal() [2/2]

CELER_FUNCTION void celeritas::OrangeTrackView::move_internal ( real_type dist )

inline

Move within the current volume.

The straight-line distance must be less than the distance to the boundary.

◆ normal()

CELER_FUNCTION Real3 celeritas::OrangeTrackView::normal ( ) const

inline

Get the normal vector of the current surface.

The direction of the normal is determined by the sense of the track such that the normal always points out of the volume that the track is currently in.

◆ operator=()

CELER_FUNCTION OrangeTrackView & celeritas::OrangeTrackView::operator= ( Initializer_t const & init )

inline

Construct the state.

Expensive. This function should only be called to initialize an event from a starting location and direction. Secondaries will initialize their states from a copy of the parent.

◆ set_dir()

CELER_FUNCTION void celeritas::OrangeTrackView::set_dir ( Real3 const & newdir )

inline

Change the track's direction.

This happens after a scattering event or movement inside a magnetic field. It resets the calculated distance-to-boundary. It is allowed to happen on the boundary, but changing direction so that it goes from pointing outward to inward (or vice versa) will mean that cross_boundary will be a null-op.

TODO: This needs to be updated to handle reflections through levels

◆ volume_id()

CELER_FUNCTION VolumeId celeritas::OrangeTrackView::volume_id ( ) const

inline

The current canonical volume ID.

This is the volume identifier in the user's geometry model, not the ORANGE implementation of it. For unit tests and certain use cases where the volumes have not been loaded from Geant4 or a structured geometry model, it may not be available.

◆ volume_instance_id()

CELER_FUNCTION void celeritas::OrangeTrackView::volume_instance_id ( Span< VolumeInstanceId > levels ) const

inline

Get the volume instance ID at every level.

The input span size must be equal to the value of "level" plus one. The top-most level ("world" or level zero) starts at index zero and moves downward. Note that Geant4 uses the reverse nomenclature.

Todo:: Implement parent_impl_volumes in OrangeData.

The documentation for this class was generated from the following file:

OrangeTrackView.hh

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ cross_boundary()

◆ find_next_step()

◆ find_safety() [1/2]

◆ find_safety() [2/2]

◆ impl_volume_id()

◆ level()

◆ make_lsa() [1/2]

◆ make_lsa() [2/2]

◆ move_internal() [1/2]

◆ move_internal() [2/2]

◆ normal()

◆ operator=()

◆ set_dir()

◆ volume_id()

◆ volume_instance_id()