&load_parameters STRING filename = NULL; STRING filename_list = NULL; STRING include_name_pattern = NULL; STRING exclude_name_pattern = NULL; STRING include_item_pattern = NULL; STRING exclude_item_pattern = NULL; STRING include_type_pattern = NULL; STRING exclude_type_pattern = NULL; STRING edit_name_command = NULL; long change_defined_values = 0; long clear_settings = 0; long allow_missing_elements = 0; long allow_missing_parameters = 0; long allow_missing_files = 0; long force_occurence_data = 0; long verbose = 0; long use_first = 0; &end
filename-- Name (possibly containing the ``%s'' field) of SDDS file from which to take data. The file must contain some of the following columns:
change_defined_values is set, successive pages of the
file are used for successive steps of the simulation. Several elegant commands generate output that may be used (on a subsequent
load_parameters; among these are the tune and
chromaticity correction commands and the
filename_list-- A list of filenames, which may be given in place of
filename. If used, each file in the list is treated as if it was separately supplied with an individual
exclude_name_pattern-- A comma- or space-separated list of wildcard patterns to be used in selecting, respectively, which elements to include and which to exclude from loading. To be used, data must match at least one inclusion pattern and no exclusion patterns.
exclude_item_pattern-- A comma- or space-separated list of wildcard patterns to be used in selecting, respectively, which items (i.e., which element parameters) to include and which to exclude from loading. To be used, data must match at least one inclusion pattern and no exclusion patterns.
exclude_type_pattern-- Wildcard patterns to be used in selecting, respectively, which element types (e.g., QUAD, DRIFT) to include and which to exclude from loading. To be used, data must match at least one inclusion pattern and no exclusion patterns.
edit_name_command-- A command using the syntax of the editstring program, allowing the strings in the
ElementNamecolumn to be modified before values are assigned.
change_defined_values-- Changes the defined values of the parameters. This means that when the lattice is saved (using
save_lattice), the parameters will have the altered values. Also, if one wants to alter the values for all steps of the simulation, one must set this flag.
Note that the
ElementOccurence data is normally ignored if
change_defined_values is nonzero. This is because there is
only one definition of each element, even if it is used multiple times.
This behavior can be altered with the next control.
force_occurence_data-- If set, then occurence data is used even in
use_first-- It is possible that the input file will contain multiple lines for any given parameter. In this case, elegant will by default process all lines. For example, if the lines give differential values, then all would be included. However, if the lines give absolute values, then the last one will overwrite the previous values; this flag allows overriding the behavior in this case to force elegant to use the first value. This can have speed advantages for cases where there are many identical occurences of the same element.
clear_settings-- If set, clear all settings and files being used for loading parameters.
allow_missing_elements-- If set, allow elements in the file that are not in the lattice. In this case, the nonapplicable data is simply ignored.
allow_missing_parameters-- If set, it is not an error if any element in the lattice lacks a parameter that exists in the file.
allow_missing_files-- If set, it is not an error if any listed file is missing.
verbose-- If set, provide informational printouts about changes to parameters.