run_setup

• type: setup command.
• function: set global parameters of the simulation and define primary input and output files.

&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 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;
    STRING expand_for = NULL; 
    long tracking_updates = 1;
    long echo_lattice = 0;
    STRING search_path = NULL;
    long element_divisions = 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 elegant to crash.
• 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''.
• final -- The (incomplete) name of an SDDS file into which final beam and transport parameters will be written. Recommended value: ``%s.fin''.
• 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.
• combine_bunch_statistics -- A flag indicating whether to combine statistical information for all simulation steps. If non-zero, then the sigma and centroid data will be combined over all simulation steps.
• wrap_around -- A flag indicating whether the z coordinate should wrap-around or increase monotonically in multipass simulations.
• 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 $\beta\gamma$.
• p_central_mev -- Central momentum of the beamline in MeV/c, about which expansions are done. Ignored if p_central is nonzero.
• 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 sdds_beam namelist.
• 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_divisions new elements having the same name as each split element.