Cavity

Cavity element factory

elementary.cavity.cavity_factory(rigidity: float, kind: Literal['kick', 'main'] = 'kick', beta: float | None = None, gamma: float | None = None, driver: Callable[[...], jax.Array] | None = None, settings: dict | None = None, order: int = 0, iterations: int = 1, final: bool = True, epsilon: float = 1e-15) → Callable[[...], jax.Array][source]

Cavity element transfer map

Parameters:

  • rigidity (float) – magnetic rigidity

  • kind (Literal['kick', 'main'], default='kick') – cavity type

  • beta (Optional[float]) – relativistic beta

  • gamma (Optional[float]) – relativistic gamma

  • driver (Optional[Callable[..., Array]]) – symplectic integrator (tao)

  • settings (Optional[dict]) – configuration settings for integrator

  • order (int, default=0) – yoshida composition order

  • iterations (int, default=1) – number of integration

  • final (bool, default=True) – flag to return only the final state

  • epsilon (float, default=1.0E-15) – epsilon

Return type:

Callable[…, Array]