impactx::TrackingState Struct Reference

#include <TrackingState.H>

Public Member Functions
void	set_no_element ()
bool	forward () const

Public Attributes
int	m_step = 0
int	m_period = 0
std::optional< elements::KnownElements * >	m_element
TrackingDirection	m_direction = TrackingDirection::Forward

Detailed Description

This class wraps a few states during tracking loops.

These states are useful to know in hooks (Python callback functions).

Member Function Documentation

forward()

bool impactx::TrackingState::forward ( ) const

inline

set_no_element()

void impactx::TrackingState::set_no_element ( )

inline

Member Data Documentation

m_direction

TrackingDirection impactx::TrackingState::m_direction = TrackingDirection::Forward

Tracking direction in the lattice

m_element

std::optional<elements::KnownElements*> impactx::TrackingState::m_element

For tracking hooks/callbacks, the current lattice element

m_period

int impactx::TrackingState::m_period = 0

For tracking hooks/callbacks, the period in the lattice (e.g., turn or channel period)

m_step

int impactx::TrackingState::m_step = 0

For tracking hooks/callbacks, a global step of the simulation

A state of internal simulation steps, increments also for space charge slice steps in elements. We start in "step 0" (initial state).

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/latest/src/tracking/TrackingState.H