apace.distributions

Module Contents

Functions

distribution(n_particles, x_dist=None, x_center=0, x_width=0, y_dist=None, y_center=0, y_width=0, x_dds_dist=None, x_dds_center=0, x_dds_width=0, y_dds_dist=None, y_dds_center=0, y_dds_width=0, l_dist=None, l_center=0, l_width=0, delta_dist=None, delta_center=0, delta_width=None)

Create a particle distribution array (6, N).

_create_distribution(n_particles, dist_type, center, width)

apace.distributions.distribution(n_particles, x_dist=None, x_center=0, x_width=0, y_dist=None, y_center=0, y_width=0, x_dds_dist=None, x_dds_center=0, x_dds_width=0, y_dds_dist=None, y_dds_center=0, y_dds_width=0, l_dist=None, l_center=0, l_width=0, delta_dist=None, delta_center=0, delta_width=None)

Create a particle distribution array (6, N).

Parameters

  • n_particles (int) – Number of particles.

  • x_dist (str) – Type of distribution in horizontal phase space.

  • x_center (float) – Center of distribution.

  • x_width (float) – Width of distribution.

  • y_dist (str) – Type of distribution in vertical phase space.

  • y_center (float) – Center of distribution.

  • y_width (float) – Width of distribution.

  • x_dds_dist (str) – Type of distribution in horizontal slope phase space.

  • x_dds_center (float) – Center of distribution.

  • x_dds_width (float) – Width of distribution.

  • y_dds_dist (str) – Type of distribution in vertical slope phase space.

  • y_dds_center (float) – Center of distribution.

  • y_dds_width (float) – Width of distribution.

  • l_dist (str) – Type of distribution in longitudinal phase space.

  • l_center (float) – Center of distribution.

  • l_width (float) – Width of distribution.

  • delta_dist (str) – Type of distribution in momentum phase space.

  • delta_center (float) – Center of distribution.

  • delta_width (float) – Width of distribution.

Returns

Array of shape (6, n_particles)

Return type

numpy.ndarray

apace.distributions._create_distribution(n_particles, dist_type, center, width)