Zgoubi commands

Zgoubi commands.

TODO

Zgoubidoo’s class hierarchy and bases classes for new commands

Say something here

Support for patchable elements

Patchable elements module.

Classes

Patchable()

Patchable elements are Zgoubi commands that affect the placement of the reference frame.

Class Inheritance Diagram

Support for plotable elements

Plotable type system.

Classes

Plotable

Plotable type.

Class Inheritance Diagram

Control-flow, calculation and miscellanous commands

Commands controlling Zgoubi’s control flow, geometry, tracking options, etc.

TODO

Classes

AutoRef([label1, label2])	Automatic transformation to a new reference frame.
BeamBeam([label1, label2])	Beam-beam lens.
Binary([label1, label2])	BINARY/FORMATTED data converter.
Chamber	alias of zgoubidoo.commands.commands.Chambre
Chambr	alias of zgoubidoo.commands.commands.Chambre
Chambre([label1, label2])	Long transverse aperture limitation.
ChangRef([label1, label2])	Transformation to a new reference frame.
ChangeRef	alias of zgoubidoo.commands.commands.ChangRef
Cible([label1, label2])	Generate a secondary beam following target interaction.
Collima	alias of zgoubidoo.commands.commands.Collimateur
Collimateur([label1, label2])	Collimator.
Collimator	alias of zgoubidoo.commands.commands.Collimateur
Command([label1, label2])	Test test test.
CommandType(name, bases, dct)	Dark magic.
Comment([comment])	Fake comment allowing to insert comments in the Zgoubi input.
FaiStore([label1, label2])	Store coordinates at labeled elements.
Fake([label1, label2])	Fake command for Zgoubi input.
Focale([label1, label2])	Particle coordinates and horizontal beam size at distance XL.
FocaleZ([label1, label2])	Particle coordinates and vertical beam size at distance XL.
GasScattering([label1, label2])	Gas scattering.
GetFitVal([label1, label2])	Get values of variables as saved from former FIT[2] run.
Histo([label1, label2])	1-Dhistogram
Image([label1, label2])	Localization and size of horizontal waist.
ImageZ([label1, label2])	Localization and size of vertical waist.
Images([label1, label2])	Localization and size of horizontal waists.
ImagesZ([label1, label2])	Localization and size of vertical waists.
MCDesintegration([label1, label2])	Monte-Carlo simulation of in-flight decay.
Marker([label1, label2, with_plt])	Marker.
Matrix([label1, label2])	Calculation of transfer coefficients, periodic parameters.
Optics([label1, label2])	Write out optical functions.
Ordre([label1, label2])	Taylor expansions order.
Pickups([label1, label2])	Beam centroid path; closed orbit.
PlotData([label1, label2])	Intermediate output for the PLOTDATA graphic software.
Rebelote([label1, label2])	’Do it again’.
Reset([label1, label2])	Reset counters and flags.
Scaling([label1, label2])	Power supplies and R.F.
Separa([label1, label2])	Wien Filter - analytical simulation.
Target([label1, label2])	Generate a secondary beam following target interaction.
TraRot	alias of zgoubidoo.commands.commands.TranslationRotation
TransferMatrix([label1, label2])	Transfer matrix.
TranslationRotation([label1, label2])	Translation-Rotation of the reference frame.
Twiss([label1, label2])	Calculation of periodic optical parameters.
Ymy([label1, label2])	Reverse signs of Y and Z reference axes, equivalent to a 180 degree rotation around the X axis.
ZgoubidooAttributeException(m)	Exception raised for errors in the Zgoubidoo commands module.
ZgoubidooException(m)	Exception raised for errors in the Zgoubidoo commands module.

Class Inheritance Diagram

Particule definition commands

Zgoubidoo’s interfaces to Zgoubi commands related to particle types.

More details here. TODO

Classes

AntiMuon([label1, label2])	An anti-muon particle.
AntiProton([label1, label2])	An anti-proton particle.
CarbonIon([label1, label2])	A fully stripped Carbon ion
Electron([label1, label2])	An electron particle.
HMinus([label1, label2])	An H- ion.
Helion	alias of zgoubidoo.commands.particules.HeliumIon
HeliumIon([label1, label2])	A fully stripped Helium ion
ImmortalAntiMuon([label1, label2])	An anti-muon particle (no decay).
ImmortalMuon([label1, label2])	A muon particle (no decay).
Ion([label1, label2])	Base class for ion particles.
LeadIon([label1, label2])	A fully stripped Lead ion
Muon([label1, label2])	A muon particle.
NativeParticule([label1, label2])	TODO
NativeParticuleType(name, bases, dct)	TODO
NegativePion([label1, label2])	A pion particle.
OxygenIon([label1, label2])	A fully stripped Oxygen ion
Particule([label1, label2])	Particle characteristics.
ParticuleType(name, bases, dct)	TODO
Pion([label1, label2])	A pion particle.
PositivePion([label1, label2])	A pion particle.
Positron([label1, label2])	A positron particle.
Proton([label1, label2])	A proton particle.
SulfurIon([label1, label2])	A fully stripped Sulfur ion
XenonIon([label1, label2])	A fully stripped Sulfur ion

Class Inheritance Diagram

Objet (bunch) definition commands

Zgoubi commands for the generation of Objet’s.

The description of the object, i.e., initial coordinates of the ensemble of particles, must be the first procedure in the zgoubi input data file, zgoubi.dat.

Several types of automatically generated objects are available, they are described in the following pages and include:

• non-random object, with various distributions : individual particles, grids, object for MATRIX, etc.

• Monte Carlo distribution (see MCObjet), with various distributions as well : 6-D window, ellipsoids, etc.

A recurrent quantity appearing in these procedures is IMAX, the number of particles to be ray-traced. The maximum value allowed for IMAX can be changed at leisure in the include file MAXTRA.H where it is defined (that requires re-compiling zgoubi).

Classes

Objet([label1, label2])	Generation of an object.
Objet1([label1, label2])	Objet with initial coordinates drawn from a regular grid
Objet2([label1, label2])	Objet with all initial coordinates entered explicitely.
Objet3([label1, label2])	Examples
Objet4([label1, label2])	Default initializer for all Commands.
Objet5([label1, label2])	Generation of 11 particles, or 11*NN if I ≥ 2 (for use with MATRIX, IORD = 1).
Objet6([label1, label2])	Generation of 61 particles.
Objet7([label1, label2])	Command attributes
Objet8([label1, label2])	Command attributes
ObjetA([label1, label2])	Object from Monte-Carlo simulation of decay reaction.
ObjetType(name, bases, dct)	Type system for Objet types.

Class Inheritance Diagram

Monte-Carlo Objet (bunch) definition commands

Zgoubidoo’s interfaces to Monte-Carlo object definition commands.

More details here.

Classes

MCObjet([label1, label2])	Monte-Carlo generation of a 6-D object.
MCObjet1([label1, label2])	Command attributes
MCObjet2([label1, label2])	Command attributes
MCObjet3([label1, label2])	Monte-Carlo generation of a 6-D object.

Class Inheritance Diagram

Magnetic elements

Zgoubidoo’s interfaces to purefly magnetic Zgoubi commands.

More details here. TODO

Classes

AGSMainMagnet([label1, label2])	AGS main magnet.
AGSQuadrupole([label1, label2])	AGS quadrupole.
Aimant([label1, label2])	Generation of dipole mid-plane 2-D map, polar frame.
Bend([label1, label2])	Bending magnet, Cartesian frame.
CartesianMagnet([label1, label2])	Base class for magnetic elements in cartesian coordinates.
CartesianMagnetType(name, bases, dct)	Type for cartesian magnets.
Decapole([label1, label2])	Decapole magnet.
Dipole([label1, label2])	Dipole magnet, polar frame.
DipoleM([label1, label2])	TODO.
Dipoles([label1, label2])	Dipole magnet N-tuple, polar frame.
Dodecapole([label1, label2])	Dodecapole magnet.
Drift([label1, label2])	Field free drift space.
ESL([label1, label2])	Field free drift space (“espace libre”).
Emma([label1, label2])	2-D Cartesian or cylindrical mesh field map for EMMA FFAG.
FFAG([label1, label2])	FFAG magnet, N-tuple.
FFAGSpirale([label1, label2])	Spiral FFAG magnet, N-tuple.
Magnet([label1, label2])	Base class for all magnetic elements.
MagnetType(name, bases, dct)	Type for magnetic element commands.
Multipol	alias of zgoubidoo.commands.magnetique.Multipole
Multipole([label1, label2])	Magnetic multipole.
Octupole([label1, label2])	Octupole magnet.
PS170([label1, label2])	Simulation of a round shape dipole magnet.
PolarMagnet([label1, label2])	Base class for magnetic elements in polar coordinates.
PolarMagnetType(name, bases, dct)	Type for polar magnets.
PolarMultiMagnet([label1, label2])	Default initializer for all Commands.
Quadisex([label1, label2])	Sharp edge magnetic multipoles.
Quadrupole([label1, label2])	Quadrupole magnet.
SexQuad([label1, label2])	Sharp edge magnetic multipole.
Sextupole([label1, label2])	Sextupole magnet.
Solenoid([label1, label2])	Solenoid.
Undulator([label1, label2])	Undulator magnet.
Venus([label1, label2])	Simulation of a rectangular shaped dipole magnet.

Class Inheritance Diagram

Electric elements

Zgoubidoo’s interfaces to purefly electric Zgoubi commands.

More details here.

Classes

Cavite([label1, label2])	Accelerating cavity.
Cavity	alias of zgoubidoo.commands.electrique.Cavite
EBMult([label1, label2])	Electro-magnetic multipole.
EBMultipole	alias of zgoubidoo.commands.electrique.EBMult
EL2Tub([label1, label2])	Two-tube electrostatic lens.
ELMir([label1, label2])	Electrostatic N-electrode mirror/lens,straight slits.
ELMirCircular([label1, label2])	Electrostatic N-electrode mirror/lens, circular slits.
ELMulti([label1, label2])	Electric multipole.
ELRevol([label1, label2])	1-D uniform mesh electric field map.
Unipot([label1, label2])	Unipotential cylindrical electrostatic lens.

Class Inheritance Diagram

Field-map elements

Zgoubidoo’s interfaces to field map tracking commands.

More details here.

Classes

Brevol([label1, label2])	1-D uniform mesh magnetic field map.
CartesianMesh([label1, label2])	2-D Cartesian uniform mesh magnetic field map.
Map2D([label1, label2])	2-D Cartesian uniform mesh field map - arbitrary magnetic field.
Map2DElectric([label1, label2])	2-D Cartesian uniform mesh field map - arbitrary electric field.
Poisson([label1, label2])	Read magnetic field data from POISSON parent.
PolarMesh([label1, label2])	2-D polar mesh magnetic field map.
Tosca([label1, label2])	2-D and 3-D Cartesian or cylindrical mesh field map.

Class Inheritance Diagram

Spin tracking commands

Zgoubidoo’s interfaces to spin tracking commands.

More details here.

Classes

SpinPrint	alias of zgoubidoo.commands.spin.SpnPrt
SpinRotation([label1, label2])	Spin rotation.
SpinStore([label1, label2])	Store spin coordinates every IP other pass at labeled elements.
SpinTracking	alias of zgoubidoo.commands.spin.SpnTrk
SpnPrt([label1, label2])	Print spin coordinates.
SpnTrk([label1, label2])	Spin tracking.
Spnprnl([label1, label2])	Store spin coordinates into file FNAME.

Class Inheritance Diagram

Synchrotron radiation commands

Commands controlling Zgoubi’s control flow, geometry, tracking options, etc.

TODO

Classes

SRLoss	alias of zgoubidoo.commands.radiation.SynchrotronRadiationLosses
SRPrint	alias of zgoubidoo.commands.radiation.SynchrotronRadiationPrint
SynchrotronRadiationLosses([label1, label2])	Synchrotron radiation loss.
SynchrotronRadiationPrint([label1, label2])	Print SR loss statistics.
SynchrotronRadiationSpectral([label1, label2])	Synchrotron radiation spectral-angular densities.

Class Inheritance Diagram