&run_setup STRING lattice = NULL; STRING use_beamline = NULL; STRING rootname = NULL; STRING output = NULL; STRING centroid = NULL; STRING sigma = NULL; STRING final = NULL; STRING acceptance = NULL; STRING losses = NULL; STRING magnets = NULL; STRING semaphore_file = NULL; STRING parameters = NULL; long combine_bunch_statistics = 0; long wrap_around = 1; long final_pass = 0; long default_order = 2; long concat_order = 0; long print_statistics = 0; long random_number_seed = 987654321; long correction_iterations = 1; double p_central = 0.0; double p_central_mev = 0.0; long always_change_p0 = 0; STRING expand_for = NULL; long tracking_updates = 1; long echo_lattice = 0; STRING search_path = NULL; long element_divisions = 0; long load_balancing_on = 0; &end
lattice-- Name of the lattice definition file.
echo_lattice-- If nonzero, the lattice input is echoed to the standard output as the lattice is parsed. This can help detect certain problems with the lattice that cause
use_beamline-- Name of the beamline to use.
rootname-- Filename fragment used in forming complete names from incomplete filenames. By default, the filename minus extension of the input file is used.
output-- The (incomplete) name of an SDDS file into which final phase-space coordinates will be written. Recommended value: ``%s.out''.
centroid-- The (incomplete) name of an SDDS file into which beam centroids as a function of s will be written. Recommended value: ``%s.cen''.
sigma-- The (incomplete) name of an SDDS file into which the beam sigma matrix as a function of z will be written. Recommended value: ``%s.sig''. N.B.: confusion sometimes occurs about some of the quantities related to the s coordinate in this file. Please see Section 4 above.
final-- The (incomplete) name of an SDDS file into which final beam and transport parameters will be written. Recommended value: ``%s.fin''. N.B.: confusion sometimes occurs about some of the quantities related to the s coordinate in this file. Please see Section 4 above.
acceptance-- The (incomplete) name of an SDDS file into which the initial coordinates of transmitted particles will be written. Recommended value: ``%s.acc''.
losses-- The (incomplete) name of an SDDS file into which information on lost particles will be written. Recommended value: ``%s.lost''.
magnets-- The (incomplete) name of an SDDS file into which a magnet layout representation will be written. Recommended value: ``%s.mag''.
semaphore_file-- The (incomplete) name of file that will be created just before exit from the program, but only if no errors occured. If the file exists, it is deleted. This file can be used to record the fact that the run completed without error.
parameters-- The (incomplete) name of an SDDS file into which parameters of accelerator elements are written. N.B.: this file does not contain any non-numerical parameters of the lattice. Hence, it is not a complete description of the settings of the lattice.
combine_bunch_statistics-- A flag indicating whether to combine statistical information for all simulation steps. If non-zero, then the
centroiddata will be combined over all simulation steps.
wrap_around-- A flag indicating whether the s coordinate should wrap-around or increase monotonically in multipass simulations. If zero, then the centroid and sigma data is computed for each turn with the s coordinate increasing continuously.
final_pass-- A flag indicating whether the centroid and sigma output should be computed only from the data from the final pass. By default, the statistics include data from all passes.
default_order-- The default order of transfer matrices used for elements having matrices.
concat_order-- If non-zero, the order of matrix concatenation used.
print_statistics-- A flag indicating whether to print information as each element is tracked.
random_number_seed-- A seed for the random number generators. If zero, a seed will be generated from the system clock.
correction_iterations-- Number of iterations of tune and chromaticity correction.
p_central-- Central momentum of the beamline, about which expansions are done. This is .
p_central_mev-- Central momentum of the beamline in MeV/c, about which expansions are done. Ignored if
always_change_p0-- If nonzero, then elegant will match the reference momentum to the beam momentum after each element. For example, in a beamline with radiation losses, one might want to adjust downstream magnets to match the energy of the incoming beam.
expand_for-- Name of an SDDS file containing particle information, from which the central momentum will be set. The file contents are the same as required for elegant input with the
tracking_updates-- A flag indicating whether to print summary information about tracking.
search_path-- Specify a list of pathnames in which to look for input files, including lattice files, wakefield input, particle input, etc. This allows storing common input files in a convenient location without having to put the location into every filename.
element_divisions-- Specify how many pieces to split elements into. Only certain elements (basically, those with a matrix) are split. Results in creation of
element_divisionsnew elements having the same name as each split element.
load_balancing_on-- If non-zero, load-balancing is performed for parallel mode. This can result in non-deterministic results if the load-balancing is different on two otherwise identical runs. Load-balancing variations may occur in heterogeneous clusters, clusters with multiple users, or for other reasons. In such situations, turning off load balancing can be useful if, for example, one is performing parameter scans and wishes to eliminate spurious sources of variation.