celeritas::optical::CoreTrackView Class Reference

Access all core properties of a physics track. More...

#include <CoreTrackView.hh>

Public Types
Type aliases
using	ParamsRef = NativeCRef< CoreParamsData >
using	StateRef = NativeRef< CoreStateData >

Public Member Functions
CELER_FUNCTION	CoreTrackView (ParamsRef const &params, StateRef const &states, TrackSlotId slot)
	Construct with comprehensive param/state data and track slot. More...
CELER_FUNCTION CoreTrackView &	operator= (TrackInitializer const &)
	Initialize the track states. More...
CELER_FUNCTION GeoTrackView	geometry () const
	Return a geometry view.
CELER_FUNCTION MaterialView	material () const
	Return a material view.
CELER_FUNCTION MaterialView	material (GeoTrackView const &) const
	Return a material view using an existing geo track view.
CELER_FUNCTION SimTrackView	sim () const
	Return a simulation management view.
CELER_FUNCTION ParticleTrackView	particle () const
	Return a particle view.
CELER_FUNCTION RngEngine	rng () const
	Return the RNG engine.
CELER_FUNCTION TrackSlotId	track_slot_id () const
	Get the track's index among the states.
CELER_FUNCTION ActionId	boundary_action () const
	Get the action ID for encountering a geometry boundary.
CELER_FUNCTION void	apply_errored ()
	Set the 'errored' flag and tracking cut post-step action. More...

Detailed Description

Access all core properties of a physics track.

Constructor & Destructor Documentation

CoreTrackView()

CELER_FUNCTION celeritas::optical::CoreTrackView::CoreTrackView ( ParamsRef const &  params, StateRef const &  states, TrackSlotId  track_slot  )

inline

Construct with comprehensive param/state data and track slot.

For optical tracks, the value of the track slot is the same as the track ID.

Member Function Documentation

apply_errored()

CELER_FUNCTION void celeritas::optical::CoreTrackView::apply_errored ( )

inline

Set the 'errored' flag and tracking cut post-step action.

Precondition

This cannot be applied if the current action is after post-step. (You can't guarantee for example that sensitive detectors will pick up the energy deposition.)

Todo:

Add a tracking cut action? Currently the track is simply killed.

operator=()

CELER_FUNCTION CoreTrackView & celeritas::optical::CoreTrackView::operator= ( TrackInitializer const &  init )

inline

Initialize the track states.

Todo:

Add physics view and clear physics state

---

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

• optical/CoreTrackView.hh