User’s Manual for elegant

Program Version 33.0.0
Advanced Photon Source
Michael Borland, Tim Berenc

March 3, 2017

Note: another source of help for elegant is the on-line forum. Users are encouraged to join and participate. At minimum, users should subscribe to the “Bugs” topic, since this is where bug notifications are posted. Contrary to previous practice, we will no longer announce bugs via email.

A set of examples and scripts is available that demonstrates many features of elegant. A brief overview of elegant is also available, which introduces the capabilities at a high level.

1 Highlights of What’s New in Version 33.0
 1.1 Bug Fixes for Elements
 1.2 Bug Fixes for Commands
 1.3 New and Modified Elements
 1.4 New and Modified Commands
 1.5 Changes Specific to Parallel Version
 1.6 Changes to Related Programs and Files
 1.7 Known Bugs, Problems, and Limitations
2 Credits
3 Introduction
 3.1 Program Philosophy
 3.2 Capabilities of elegant
4 Digression on the Longitudinal Coordinate Definition
5 Fiducialization in elegant
6 Preparing beams for bunch-mode simulations
7 Namelist Command Dictionary
 7.1 Commandline Syntax
 7.2 General Command Syntax
 7.3 Setup and Action Commands
 7.4 Table of elegant commands and their functions
 7.5 alter_elements
 7.6 amplification_factors
 7.7 analyze_map
 7.8 aperture_data
 7.9 bunched_beam
 7.10 change_particle
 7.11 chromaticity
 7.12 closed_orbit
 7.13 correct
 7.14 correction_matrix_output
 7.15 correct_tunes
 7.16 coupled_twiss_output
 7.17 divide_elements
 7.18 error_element
 7.19 error_control
 7.20 find_aperture
 7.21 floor_coordinates
 7.22 frequency_map
 7.23 global_settings
 7.24 insert_elements
 7.25 insert_sceffects
 7.26 linear_chromatic_tracking_setup
 7.27 link_control
 7.28 link_elements
 7.29 load_parameters
 7.30 matrix_output
 7.31 modulate_elements
 7.32 moments_output
 7.33 momentum_aperture
 7.34 optimize
 7.35 optimization_constraint
 7.36 optimization_covariable
 7.37 optimization_setup
 7.38 parallel_optimization_setup
 7.39 optimization_term
 7.40 optimization_variable
 7.41 print_dictionary
 7.42 ramp_elements
 7.43 rf_setup
 7.44 replace_elements
 7.45 rpn_expression
 7.46 rpn_load
 7.47 run_control
 7.48 run_setup
 7.49 sasefel
 7.50 save_lattice
 7.51 sdds_beam
 7.52 semaphores
 7.53 slice_analysis
 7.54 subprocess
 7.55 steering_element
 7.56 touschek_scatter
 7.57 transmute_elements
 7.58 tune_footprint
 7.59 twiss_analysis
 7.60 twiss_output
 7.61 track
 7.62 tune_shift_with_amplitude
 7.63 vary_element
8 Specialized Tools for Use with elegant
 8.1 abrat
 8.2 astra2elegant
 8.3 computeGeneralizedGradients
 8.4 coreEmittance
 8.5 csrImpedance
 8.6 doubleDist6
 8.7 haissinski
 8.8 ibsEmittance
 8.9 ionTrapping
 8.10 elegantto
 8.11 sddsanalyzebeam
 8.12 sddsbrightness
 8.13 sddsbunchingfactor
 8.14 sddsemitproc
 8.15 sddsfindresonances
 8.16 sddsfluxcurve
 8.17 sddsmatchtwiss
 8.18 sddsrandmult
 8.19 sddsurgent
 8.20 smoothDist6
 8.21 TFBFirSetup
 8.22 touschekLifetime
 8.23 view3dGeometry
9 Accelerator and Element Description
 9.1 Magnet Strength
10 Element Dictionary
 10.1 ALPH
 10.2 BGGEXP
 10.3 BMAPXY
 10.4 BMXYZ
 10.5 BRANCH
 10.6 BRAT
 10.7 BUMPER
 10.8 CENTER
 10.9 CEPL
 10.10 CHARGE
 10.11 CLEAN
 10.12 CORGPIPE
 10.13 CSBEND
 10.14 CSRCSBEND
 10.15 CSRDRIFT
 10.16 CWIGGLER
 10.17 DRIF
 10.18 DSCATTER
 10.19 ECOL
 10.20 EDRIFT
 10.21 EHKICK
 10.22 EKICKER
 10.23 ELSE
 10.24 EMATRIX
 10.25 EMITTANCE
 10.26 ENERGY
 10.27 EVKICK
 10.28 FLOOR
 10.29 FMULT
 10.30 FRFMODE
 10.31 FTABLE
 10.32 FTRFMODE
 10.33 GFWIGGLER
 10.34 HISTOGRAM
 10.35 HKICK
 10.36 HMON
 10.37 IBSCATTER
 10.38 ILMATRIX
 10.39 KICKER
 10.40 KOCT
 10.41 KPOLY
 10.42 KQUAD
 10.43 KQUSE
 10.44 KSBEND
 10.45 KSEXT
 10.46 LMIRROR
 10.47 LRWAKE
 10.48 LSCDRIFT
 10.49 LSRMDLTR
 10.50 LTHINLENS
 10.51 MAGNIFY
 10.52 MALIGN
 10.53 MAPSOLENOID
 10.54 MARK
 10.55 MATR
 10.56 MATTER
 10.57 MAXAMP
 10.58 MBUMPER
 10.59 MHISTOGRAM
 10.60 MODRF
 10.61 MONI
 10.62 MRFDF
 10.63 MULT
 10.64 NIBEND
 10.65 NISEPT
 10.66 OCTU
 10.67 PEPPOT
 10.68 PFILTER
 10.69 QUAD
 10.70 QUFRINGE
 10.71 RAMPP
 10.72 RAMPRF
 10.73 RBEN
 10.74 RCOL
 10.75 RECIRC
 10.76 REFLECT
 10.77 REMCOR
 10.78 RFCA
 10.79 RFCW
 10.80 RFDF
 10.81 RFMODE
 10.82 RFTM110
 10.83 RFTMEZ0
 10.84 RIMULT
 10.85 RMDF
 10.86 ROTATE
 10.87 SAMPLE
 10.88 SBEN
 10.89 SCATTER
 10.90 SCMULT
 10.91 SCRAPER
 10.92 SCRIPT
 10.93 SEXT
 10.94 SOLE
 10.95 SREFFECTS
 10.96 STRAY
 10.97 TFBDRIVER
 10.98 TFBPICKUP
 10.99 TMCF
 10.100 TRCOUNT
 10.101 TRFMODE
 10.102 TRWAKE
 10.103 TSCATTER
 10.104 TUBEND
 10.105 TWISS
 10.106 TWLA
 10.107 TWMTA
 10.108 TWPL
 10.109 UKICKMAP
 10.110 VKICK
 10.111 VMON
 10.112 WAKE
 10.113 WATCH
 10.114 WIGGLER
 10.115 ZLONGIT
 10.116 ZTRANSVERSE
11 Examples
12 The rpn Calculator
13 Change Log
 13.1 Highlights of What’s New in Version 32.0, 5 Jan. 2017
 13.2 Highlights of What’s New in Version 31.0, 1 Oct. 2016
 13.3 Highlights of What’s New in Version 30.1, 3 Aug. 2016
 13.4 Highlights of What’s New in Version 30.0, 5 July 2016
 13.5 Highlights of What’s New in Version 29.1, 3 March 2016
 13.6 Highlights of What’s New in Version 29.0, 15 Jan. 2016
 13.7 Highlights of What’s New in Version 28.1.0, 23 July 2015
 13.8 Highlights of What’s New in Version 28.0.0, 18 June 2015
References