apixpart.rst

Xpart API

Table of Contents

• The particle class
• The build_particles function
• Longitudinal coordinates generation
• Normalized transverse coordinates generation
  • Gaussian
  • Polar grid
  • Uniform circular sector
  • Pencil
• Gaussian bunch generation (6D)

The particle class

.. autoclass:: xpart.Particles
    :members:
    :undoc-members:
    :member-order: bysource

The build_particles function

.. autofunction:: xpart.build_particles

Longitudinal coordinates generation

.. autofunction:: xpart.generate_longitudinal_coordinates

Normalized transverse coordinates generation

Gaussian

.. autofunction:: xpart.generate_2D_gaussian

Polar grid

.. autofunction:: xpart.generate_2D_polar_grid

Uniform circular sector

.. autofunction:: xpart.generate_2D_uniform_circular_sector

Pencil

.. autofunction:: xpart.generate_2D_pencil

Gaussian bunch generation (6D)

.. autofunction:: xpart.generate_matched_gaussian_bunch