Octupole

Octupole element factory

elementary.octupole.octupole_factory(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) Callable[[...], jax.Array][source]

Octupole element transfer map

Parameters:
  • 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

Return type:

Callable[…, Array]

elementary.octupole.vector(qs: jax.Array, s: jax.Array, kn: jax.Array, ks: jax.Array) tuple[jax.Array, jax.Array, jax.Array][source]

Vector potential