Skip to content

Commit

Permalink
Minor doc update.
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidSagan committed Nov 1, 2023
1 parent 1999c0c commit 8d4a87e
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 14 deletions.
24 changes: 12 additions & 12 deletions bmad/doc/beam-init.tex
Original file line number Diff line number Diff line change
Expand Up @@ -430,27 +430,27 @@ \subsection{New Beam Initialization Format}
must start with ``\#!'' and this line defines the particle parameter table columns. With the
exception of the last line, all header lines will be ignored except ones that begin with a
recognized parameter followed by an equal sign. Recognized parameters are the components of the
\vn{coord_struct} (\sref{s:coord.struct}) that describes individual particles. In addition, the
following parameters are recognized:
\vn{coord_struct}, as documented in \sref{s:coord.struct}, that describes individual particles. In
addition, the following parameters are recognized:
\begin{example}
charge_tot ! Total bunch charge (including dead particles).
s_position ! Longitudinal position of bunch. Can be used in place of "s".
time ! Time particles of bunch are at. Can be used in place of "t".
\end{example}
These parameters, if present, will be used to set the corresponding particle parameter in all the
particles of the corresponding bunch. Possible \vn{location} and \vn{state} settings are given in
\sref{s:coord.struct}. The string equivalent to any setting is obtained by removing the trailing
``\$'' from the variable name. For example, the variable \vn{alive\$} which is a possible \vn{state}
setting becomes the string \vn{alive}. Note: \vn{charge_tot} (total bunch charge) will superceed
\vn{charge} (the charge per particle).
particles of the corresponding bunch. Possible \vn{location} and \vn{state} parameter settings are
documented in \sref{s:coord.struct}. The string equivalent to any setting is obtained by removing
the trailing ``\$'' from the variable name. For example, the variable \vn{alive\$} which is a
possible \vn{state} setting becomes the string \vn{alive}. Note: \vn{charge_tot} (total bunch
charge) will superceed \vn{charge} (the charge per particle).

The particle parameter table follows the header section. Each row gives the parameters for one
particle. Not all particle parameters must be specified. If a particular parameter is not present,
its default value will be used or, if present, the value given in the header section. Column order
is irrelavent and what determines what particle parameter is associated with a given column is the
last line of the header section which starts with the characters \vn{\#!}. Column names correspond
to \vn{coord_struct} parameters the same as in the header section. For parameters that are vectors,
the mapping from column name to parameter is:
last line of the header section which starts with the characters \vn{\#!}. Except for vector
parameters, column names correspond to \vn{coord_struct} parameters the same as in the header
section. For parameters that are vectors, the mapping from column name to parameter is:
\begin{example}
Column Name Corresponding coord_struct components
---------------------- -----------------------------------------
Expand All @@ -461,6 +461,6 @@ \subsection{New Beam Initialization Format}
\end{example}
Additionally, there can be (but is not required) an \vn{index} column giving the particle index in
the array of particles of a bunch. This column is ignored so, for example, values in the first line
of the table will, on input, always be used to set the particle with index 1 independent of the
value given in the index column. This rule is implemented so that a beam file can be edited to add
of the table will always be used to set the particle with index 1 independent of the
value given in the index column. This behavior is implemented so that a beam file can be edited to add
or remove particles without worrying about reindexing.
2 changes: 1 addition & 1 deletion bmad/doc/cover-page.tex
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

\begin{flushright}
\large
Revision: October 3, 2023 \\
Revision: November 1, 2023 \\
\end{flushright}

\pdfbookmark[0]{Preamble}{Preamble}
Expand Down
2 changes: 1 addition & 1 deletion bmad/doc/elements.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5049,7 +5049,7 @@ \section{Taylor}
%-----------------------------------------------------------------
\section{Thick_Multipole}
\label{s:thick.multipole}
\label{s:thick.mult}
\index{thick_multipole|hyperbf}
A \vn{thick_multipole} element is like a \vn{sextupole} or \vn{octupole} element except that the
Expand Down
29 changes: 29 additions & 0 deletions bmad/doc/list-element-attributes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1320,6 +1320,35 @@ \chapter{List of Element Attributes}
\end{tabular}
\vfill

%---------------------------------
\section{Thick_Multipole Element Attributes}
\label{s:list.thick.multipole}

\begin{tabular}{llll} \toprule
a0 - a20, b0 - b20 & fringe_at & ptc_canonical_coords & wall \\
alias & fringe_type & ptc_integration_type & wrap_superimpose \\
aperture [m] & gen_grad_map & ref_origin & x1_limit [m] \\
aperture_at & grid_field & ref_time_start [sec] & x2_limit [m] \\
aperture_type & hkick & reference & x_limit [m] \\
bl_hkick [T*m] & integrator_order & scale_multipoles & x_offset [m] \\
bl_vkick [T*m] & is_on & space_charge_method & x_offset_tot [m] \\
cartesian_map & l [m] & spin_fringe_on & x_pitch [rad] \\
create_jumbo_slave & lord_pad1 [m] & spin_tracking_method & x_pitch_tot [rad] \\
csr_ds_step [m] & lord_pad2 [m] & sr_wake & y1_limit [m] \\
csr_method & lr_freq_spread [Hz] & sr_wake_file & y2_limit [m] \\
cylindrical_map & lr_self_wake_on & static_linear_map & y_limit [m] \\
delta_ref_time [sec] & lr_wake & superimpose & y_offset [m] \\
descrip & lr_wake_file & symplectify & y_offset_tot [m] \\
ds_step [m] & mat6_calc_method & taylor_map_includes_offsets & y_pitch [rad] \\
e_tot [eV] & multipoles_on & tilt [rad] & y_pitch_tot [rad] \\
ele_origin & num_steps & tilt_tot [rad] & z_offset [m] \\
field_calc & offset [m] & tracking_method & z_offset_tot [m] \\
field_master & offset_moves_aperture & type & \\
field_overlaps & p0c [eV] & vkick & \\
\bottomrule
\end{tabular}
\vfill

%---------------------------------
\section{Wiggler and Undulator Element Attributes}
\label{s:list.wiggler}
Expand Down

0 comments on commit 8d4a87e

Please sign in to comment.