Commit d9b2edd6 authored by snuverink_j's avatar snuverink_j
Browse files

replace chpref

parent 80a5152d
......@@ -25,7 +25,7 @@ element is introduced to enable overlapping elements in the
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.
\subsection{Unit Tests}
Parts of \textit{OPAL} can be tested using unit tests, details can be found in \chpref{unittest}
Parts of \textit{OPAL} can be tested using unit tests, details can be found in Chapter \ref{unittest}
\section{Changes in \textit{OPAL} Version 1.2.0}
\subsection{Distribution}
......
......@@ -15,7 +15,7 @@
\begin{center}\footnotesize
\caption{Possible distribution types. Note that the \texttt{SURFACEEMISSION} and \texttt{SURFACERANDCREATE}
distribution types will not be discussed in this chapter. Instead, refer to
\chpref{femiss} on field emission for using these types.}
Chapter \ref{femiss} on field emission for using these types.}
\label{tab:disttypes}
\begin{tabularx}{\textwidth-1cm}{|l|X|}
\hline
......@@ -33,9 +33,9 @@
\texttt{BINOMIAL} & Initial distribution generated using binomial distribution(s)
see~Section~\ref{binomialdisttype}. \\
%\hline
\texttt{SURFACEEMISSION} & For dark current and multipacting simulations. This type of distribution will not be covered in this chapter, see instead \chpref{femiss}. \\
\texttt{SURFACEEMISSION} & For dark current and multipacting simulations. This type of distribution will not be covered in this chapter, see instead Chapter \ref{femiss}. \\
%\hline
\texttt{SURFACERANDCREATE} & For dark current and multipacting simulations. This type of distribution will not be covered in this chapter, see instead \chpref{femiss}. \\
\texttt{SURFACERANDCREATE} & For dark current and multipacting simulations. This type of distribution will not be covered in this chapter, see instead Chapter \ref{femiss}. \\
%\hline
\texttt{GUNGAUSSFLATTOPTH} & Legacy. Special case of \texttt{FLATTOP} distribution see~Section~\ref{gungaussflattopthdisttype}. \\
%\hline
......@@ -331,7 +331,7 @@ by the attribute \texttt{EMISSIONMODEL}, which is described in Section~\ref{emis
distribution coordinates at all.
To maintain consistency $N$ and \texttt{NPART} from the \texttt{BEAM} command in \chpref{beam} must be equal.
To maintain consistency $N$ and \texttt{NPART} from the \texttt{BEAM} command in Chapter \ref{beam} must be equal.
\section{\texttt{GAUSS} Distribution Type}
\label{sec:gaussdisttype}
......
......@@ -5,7 +5,7 @@
\index{Field Solver|(}
Space charge effects are included in the simulation by specifying a field solver described in this chapter and attaching it to the
track command as described in \chpref{track}.
track command as described in Chapter \ref{track}.
By default, the code does not assume any symmetry i.e. full 3D. In the near future it is planed to implement also a slice (2D) model.
This will allow the use of less numbers of macro-particles in the simulation which reduces the computational time significantly.
......@@ -391,7 +391,7 @@ the bounding box can be enlarged by a factor given in percent of the minimal rec
\section{Define Geometry}
\label{sec:GEOMETRY}
\index{GEOMETRY}
The list of geometries defining the beam line boundary. For further details see \chpref{geometry}.
The list of geometries defining the beam line boundary. For further details see Chapter \ref{geometry}.
\section{Define Iterative Solver}
\label{sec:ITSOLVER}
......
......@@ -4,7 +4,6 @@
\label{chp:lines}
\index{Line|(}
\label{sec:line}
\index{LINE}
The accelerator to be studied is known to \textit{OPAL}
......@@ -28,7 +27,6 @@ Each \texttt{member} may be one of the following:
Beam lines can be nested to any level.
\section{Simple Beam Lines}
\label{sec:line:simple}
The simplest beam line consists of single elements:
\begin{verbatim}
label:LINE=(member,...,member);
......@@ -44,7 +42,6 @@ L:LINE=(A,B,C,D,A,D);
\end{description}
\section{Sub-lines}
\label{sec:subline}
Instead of referring to an element,
a beam line member can refer to another beam line
defined in a separate command.
......
......@@ -56,8 +56,8 @@ respectively. More details will be given in Version 2.0.0. .
\subsection{Space Charge}
\label{sec:opalFlavours:spacecharge}
\index{SpaceCharge}
space charge effects will be included in the simulation by specifying a field solver described in \chpref{fieldsolver} and using the solver in the
track command described in \chpref{track}.
space charge effects will be included in the simulation by specifying a field solver described in Chapter \ref{fieldsolver} and using the solver in the
track command described in Chapter \ref{track}.
By default, the code does not assume any symmetry i.e. full 3D. In the near future it is planed to implement also a slice (2D) model.
This will allow the use of less numbers of macro-particles in the simulation which reduces the computational time
significantly.
......@@ -187,7 +187,7 @@ spread is small and hence the electrostatic approximation is valid.
\subsection{Wake Fields}
Longitudinal and transverse short range wakefields wake fields are described in \chpref{wakefields}.
Longitudinal and transverse short range wakefields wake fields are described in Chapter \ref{wakefields}.
\subsection{Multiple Species}
In the present version only one particle species can be defined see~Chapter~\ref{physics}), however
......@@ -510,7 +510,7 @@ For the first time in the cyclotron community, \textit{OPAL-cycl} has the capabi
and take into account the beam-beam effects of the radial neighboring bunches (we call it neighboring bunch effects for short)
by using a self-consistent numerical simulation model.
According to the number of particles defined (by the argument \texttt{NPART} in \texttt{BEAM}, see \chpref{beam}) ,
According to the number of particles defined (by the argument \texttt{NPART} in \texttt{BEAM}, see Chapter \ref{beam}) ,
\textit{OPAL-cycl} selects the following three operation modes automatically:
\begin{description}
......
......@@ -237,7 +237,7 @@ Limited by size of the user guide, we don't plan to show too much details as in
\section{Translate Old to New Distribution Commands}
\label{sec:oldtonewdist}
\index{Distribution!Translate Old}
As of \textit{OPAL} 1.2, the distribution command see~Chapter~\ref{distribution} was changed significantly. Many of the changes were internal to the code, allowing us to more easily add new distribution command options. However, other changes were made to make creating a distribution easier, clearer and so that the command attributes were more consistent across distribution types. Therefore, we encourage our users to refer to \chpref{distribution} when creating any new input files, or if they wish to update existing input files.
As of \textit{OPAL} 1.2, the distribution command see~Chapter~\ref{distribution} was changed significantly. Many of the changes were internal to the code, allowing us to more easily add new distribution command options. However, other changes were made to make creating a distribution easier, clearer and so that the command attributes were more consistent across distribution types. Therefore, we encourage our users to refer to Chapter \ref{distribution} when creating any new input files, or if they wish to update existing input files.
With the new distribution command, we did attempt as much as possible to make it backward compatible so that existing \textit{OPAL} input files would still work the same as before, or with small modifications. In this section of the manual, we will give several examples of distribution commands that will still work as before, even though they have antiquated command attributes. We will also provide examples of commonly used distribution commands that need small modifications to work as they did before.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment