changelog.tex 3.68 KB
Newer Older
snuverink_j's avatar
snuverink_j committed
1 2 3 4 5
\input{header}

\chapter{Changelog}
\label{chp:changelog}

6
Since \textit{OPAL}\ moved to {\tt gitlab} visit \url{https://gitlab.psi.ch/OPAL/src/wikis/OPALReleaseNotes} for the latest release notes.
snuverink_j's avatar
snuverink_j committed
7 8


9
\section{Changes in \textit{OPAL} Version 1.3.0}
snuverink_j's avatar
snuverink_j committed
10 11
\subsection{Cyclotron Element}
In order to accommodate axial injection through a spiral inflector, the Cyclotron element has been updated with
snuverink_j's avatar
snuverink_j committed
12
a z coordinate and a pz for the reference particle (\texttt{ZINIT}, \texttt{PZINIT}).
snuverink_j's avatar
snuverink_j committed
13 14 15 16 17

\subsection{AMG Solver}
The AMG Solver (including arbitrary boundary condition) is enabled per default.

\subsection{Variable Frequency RF}
18
Variable frequency RF is now available in \textit{OPAL-cycl} mode when using the
snuverink_j's avatar
snuverink_j committed
19 20
\texttt{RINGDEFINITION} as described in
Section~\ref{variable-rf-cavity-cycl}. A new \texttt{LOCAL\_CARTESIAN\_OFFSET}
snuverink_j's avatar
snuverink_j committed
21
element is introduced to enable overlapping elements in the
snuverink_j's avatar
snuverink_j committed
22
\texttt{RINGDEFINITION}, described in Section~\ref{ringdefinition}.
snuverink_j's avatar
snuverink_j committed
23 24

\subsection{Appendix}
25
Two new Appendices,  Appendix~\ref{benchmarks} with Benchmarks (TRANSPORT, TRACE3D and IMPACT-T) and in Appendix~\ref{autophasing} a description of the auto phasing mechanism in \textit{OPAL-t} and \textit{OPAL-e} is available.
snuverink_j's avatar
snuverink_j committed
26 27

\subsection{Unit Tests}
snuverink_j's avatar
snuverink_j committed
28
Parts of \textit{OPAL} can be tested using unit tests, details can be found in Chapter \ref{unittest}
snuverink_j's avatar
snuverink_j committed
29

30
\section{Changes in \textit{OPAL} Version 1.2.0}
snuverink_j's avatar
snuverink_j committed
31 32
\subsection{Distribution}
The distribution class is totally rewritten. You have to indicate the units to be used for $p_x,p_y$ and $p_z$ with the
snuverink_j's avatar
snuverink_j committed
33
new argument \texttt{INPUTMOUNITS}. At the moment electron volt (\texttt{EV}) or $\beta\gamma$ (\texttt{NONE} which is default) are available.
snuverink_j's avatar
snuverink_j committed
34 35 36 37 38 39 40 41 42 43 44
\begin{Verbatim}[label={My orange command sample output}]
Dist1:DISTRIBUTION, TYPE = GAUSS,
                    SIGMAX = 1.e-03,
                    SIGMAPX = 1.0,
                    CORRX = 0.0,
                    SIGMAY = 1.e-03,
                    SIGMAPY = 1.0,
                    CORRY = 0.0,
                    SIGMAT = 2.e-3 ,
                    INPUTMOUNITS = EV;
\end{Verbatim}
snuverink_j's avatar
snuverink_j committed
45
An hands-on example is given in Section~\ref{oldtonewdist}. Furthermore the \texttt{PC} argument of the \texttt{BEAM} command defines the mean energy of the generated distribution. The attributes \texttt{PZ} and \texttt{PT} are no longer supported. The full
snuverink_j's avatar
snuverink_j committed
46
correlation matrix $\mathbfgma$ can be defined for the \texttt{GAUSS} distribution.
snuverink_j's avatar
snuverink_j committed
47

snuverink_j's avatar
snuverink_j committed
48
\subsection{\texttt{SBEND} and \texttt{RBEND}}
49
The elements \texttt{SBEND} and \texttt{RBEND} for \textit{OPAL-t} have also been rewritten. (See Section~\ref{bend} for a
snuverink_j's avatar
snuverink_j committed
50
full description.) If you have input files with an \texttt{SBEND} or \texttt{RBEND} already defined, here are the key
snuverink_j's avatar
snuverink_j committed
51 52 53 54 55
changes you must make for those definitions to work properly:

\begin{enumerate}
\item All angles are now specified in radians.
\item Energy units for the bend reference particle are now specified in eV.
snuverink_j's avatar
snuverink_j committed
56
\item For bend definitions that use your own, custom field map, \emph{do not specify the bend length, \texttt{L}}.
snuverink_j's avatar
snuverink_j committed
57 58 59
\end{enumerate}

\subsection{Misalignment}
snuverink_j's avatar
snuverink_j committed
60
The misalignment argument \texttt{DZ}, misalignment in z direction is no longer supported, instead use \texttt{ELEMEDGE}.
snuverink_j's avatar
snuverink_j committed
61

snuverink_j's avatar
snuverink_j committed
62
\subsection{New elements: \texttt{SBend3D} \& \texttt{RINGDEFINITION}}
snuverink_j's avatar
snuverink_j committed
63

snuverink_j's avatar
snuverink_j committed
64
\texttt{SBend3D} see~Section~\ref{SBend3D} \& \texttt{RingDefinition} see~Section~\ref{ringdefinition} adding FFAG and more general Ring modeling capabilities.
snuverink_j's avatar
snuverink_j committed
65 66

\subsection{Space Charge Solver}
snuverink_j's avatar
snuverink_j committed
67
Still in an experimental stage, two iterative solvers can be enabled see~Chapter~\ref{installation}. With both solvers the exact boundary conditions
snuverink_j's avatar
snuverink_j committed
68 69 70
cab be applied.  Per default and in the binary distribution the solvers are disabled. We are working on regression tests and plan to have them ready in Version 1.2.1.

\input{footer}