- type: setup/action command.
- function: generate matrix output, or set up to do so later.
- Command syntax, including use of equations and subcommands, is discussed in 7.2.
STRING printout = NULL;
long printout_order = 1;
STRING printout_format = "%22.15e ";
long full_matrix_only = 0;
long print_element_data = 1;
long mathematica_full_matrix = 0;
STRING mathematica_matrix_name = "MFull";
STRING mathematica_matrix_file = NULL;
STRING SDDS_output = NULL;
long SDDS_output_order = 1;
long individual_matrices = 0;
STRING SDDS_output_match = NULL;
long output_at_each_step = 0;
STRING start_from = NULL;
long start_from_occurence = 1;
- printout — The (incomplete) name of a file to which the matrix output will be printed (as
text). Recommended value: “%s.mpr”.
- printout_order — The order to which the matrix is printed.
- printout_format — The C-style formatting statement for the matrix elements. A space,
comma, or other separator should appear at the end of the string.
- full_matrix_only — A flag indicating that only the matrix of the entire accelerator is to
- print_element_data — A flag indicating whether the element data should be printed out.
- mathematica_full_matrix — If non-zero, print the full linear matrix in a format that can read by
- mathematica_matrix_name — The name of the Mathematica variable to which the
linear matrix will be assigned.
- mathematica_matrix_file — The name a file to which the Mathematica-format matrix
will be written.
- SDDS_output — The (incomplete) name of an SDDS file to which the matrix will be written.
Recommended value: “%s.mat”.
- SDDS_output_order — The order to which the matrix is output in SDDS format.
- individual_matrices — If non-zero, the matrices in the SDDS file are the individual on-trajectory
matrices of the elements, rather than the concatenated matrix of the beamline.
- SDDS_output_match — A wildcard string which element names must match in order for data to
appear in the SDDS output file.
- output_at_each_step — A flag indicating whether matrix output is desired at every simulation
- start_from — The optional name of the accelerator element from which to begin concatenation and
- start_from_occurence — If start_from is not NULL, the number of the occurrence of the named
element from which to start.