matrix_output

• type: setup/action command.
• function: generate matrix output, or set up to do so later.

&matrix_output
    STRING printout = NULL;
    long printout_order = 1;
    long full_matrix_only = 0;
    STRING SDDS_output = NULL;
    long SDDS_output_order = 1;
    STRING SDDS_output_match = NULL;
    long output_at_each_step = 0;
    STRING start_from = NULL;
    long start_from_occurrence = 1;
&end

• 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.
• full_matrix_only -- A flag indicating that only the matrix of the entire accelerator is to be output.
• 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.
• 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 step.
• start_from -- The optional name of the accelerator element from which to begin concatenation and output.
• start_from_occurrence -- If start_from is not NULL, the number of the occurrence of the named element from which to start.