Manual.asciidoc 4.03 KB
Newer Older
gsell's avatar
gsell committed
1
= The _OPAL_ Framework: Version 2.5
gsell's avatar
gsell committed
2 3 4 5 6 7 8
Andreas Adelmann (PSI); Pedro Calvo (CIEMAT); Matthias Frey (PSI); Achim Gsell (PSI); Uldis Locans (PSI); Christof Metzger-Kraus; Nicole Neveu (SLAC); Chris Rogers (RAL); Steve Russell (LANL); Suzanne Sheehy (Oxford); Jochem Snuverink (PSI); Daniel Winklehner (MIT)
ifdef::backend-docbook5,backend-html5[]
:docinfo1:
:toc: left
:numbered:
:description: _OPAL_ User Manual
:keywords: _OPAL_
gsell's avatar
gsell committed
9
:revdate: @REVDATE@
gsell's avatar
gsell committed
10
endif::[]
gsell's avatar
gsell committed
11

gsell's avatar
gsell committed
12 13 14 15
ifdef::backend-html5[]

[cols="<19,<27,<.^27,<27",frame="none",grid="none"]
|===
gsell's avatar
gsell committed
16 17 18 19
| image:logos/psi_logo.png[width=121]
| image:logos/ciemat_logo.jpg[width=242]
| image:logos/SLAC-lab-hires.png[width=220]
| image:logos/UKRI_STF_logo.png[width=176]
gsell's avatar
gsell committed
20

gsell's avatar
gsell committed
21
| image:logos/MIT-logo-with-spelling-design1-large-black-red.svg[width=175] | | |
gsell's avatar
gsell committed
22 23 24
|===

'''
gsell's avatar
gsell committed
25 26 27

endif::[]

gsell's avatar
gsell committed
28
include::Manual.macros[]
gsell's avatar
gsell committed
29

30
:sectnums!:
gsell's avatar
gsell committed
31 32
== Preliminary note

gsell's avatar
gsell committed
33
This is the manual for _OPAL_ 2.3. Odd minor version numbers identify
gsell's avatar
gsell committed
34
development versions. Use these versions only if you know what you are
gsell's avatar
gsell committed
35 36 37 38
doing!

New feature might not yet be documented or something is already documented
but not yet implemented.
gsell's avatar
gsell committed
39

40
:sectnums:
gsell's avatar
gsell committed
41
== Abstract
gsell's avatar
gsell committed
42

snuverink_j's avatar
snuverink_j committed
43
_OPAL_ is a parallel open source tool for charged-particle optics in linear accelerators and rings, including 3D space charge.
snuverink_j's avatar
snuverink_j committed
44 45
Using the _MAD_ language with extensions, _OPAL_ can run on a laptop as well as on the largest high performance computing systems.
_OPAL_ is built from the ground up as a parallel application exemplifying the fact that high performance computing is the third leg of science, complementing theory and experiment.
gsell's avatar
gsell committed
46

snuverink_j's avatar
snuverink_j committed
47 48
The _OPAL_ framework makes it easy to add new features in the form of new _C++_ classes.
_OPAL_ comes in the following flavours:
gsell's avatar
gsell committed
49

50
_OPAL-cycl_::
gsell's avatar
gsell committed
51
  tracks particles with 3D space charge including neighbouring turns in
snuverink_j's avatar
snuverink_j committed
52
  cyclotrons and FFAs with time as the independent variable.
53
_OPAL-t_::
snuverink_j's avatar
snuverink_j committed
54
  models beam lines, linacs, rf-photo injectors and
gsell's avatar
gsell committed
55
  complete XFELs excluding the undulator.
56
_OPAL-map_::
adelmann's avatar
adelmann committed
57
  map tracking (experimental, no space charge yet)
gsell's avatar
gsell committed
58 59

It should be noted that not all features of _OPAL_ are available in all
60
flavours.
gsell's avatar
gsell committed
61

gsell's avatar
gsell committed
62

gsell's avatar
gsell committed
63
ifdef::env-gitlab[]
gsell's avatar
gsell committed
64
== Table of Contents
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
. {baseurl}/introduction.{adoc}[Introduction]
. {baseurl}/conventions.{adoc}[Conventions]
. {baseurl}/pitfalls.{adoc}[Pitfalls and Limitations]
. {baseurl}/tutorial.{adoc}[Tutorial]
. {baseurl}/opalt.{adoc}[OPAL-T]
. {baseurl}/opalcycl.{adoc}[OPAL-CYCL]
. {baseurl}/opalmap.{adoc}[OPAL-MAP]
. {baseurl}/format.{adoc}[Command Format]
. {baseurl}/control.{adoc}[Control Statements]
. {baseurl}/elements.{adoc}[Elements]
. {baseurl}/field-output.{adoc}[Field Output Commands]
. {baseurl}/lines.{adoc}[Beam Lines]
. {baseurl}/beam-command.{adoc}[Beam Command]
. {baseurl}/distribution.{adoc}[Distribution Command]
. {baseurl}/fieldsolvers.{adoc}[Field Solver]
. {baseurl}/track.{adoc}[Tracking]
. {baseurl}/wakefields.{adoc}[Wakefields]
. {baseurl}/geometry.{adoc}[Geometry]
. {baseurl}/partmatter.{adoc}[Physics Models Used in the Particle Matter Interaction Model]
. {baseurl}/optimiser.{adoc}[Multi Objective Optimization]
. {baseurl}/sampler.{adoc}[Sampler]
gsell's avatar
gsell committed
86 87 88

.Appendices
[upperalpha]
89 90 91 92 93
. {baseurl}/syntax.{adoc}[OPAL Language Syntax]
. {baseurl}/fieldmaps.{adoc}[OPAL-T Field Maps]
. {baseurl}/opal-madx.{adoc}[OPAL-MADX Conversion Guide]
. {baseurl}/autophase.{adoc}[Auto-phasing Algorithm]
. {baseurl}/benchmarks.{adoc}[Benchmarks]
gsell's avatar
gsell committed
94 95
endif::[]

gsell's avatar
gsell committed
96
ifdef::backend-docbook5,backend-html5[]
gsell's avatar
gsell committed
97 98 99 100 101 102
include::introduction.adoc[]
include::conventions.adoc[]
include::pitfalls.adoc[]
include::tutorial.adoc[]
include::opalt.adoc[]
include::opalcycl.adoc[]
gsell's avatar
gsell committed
103
include::opalmap.adoc[]
gsell's avatar
gsell committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
include::format.adoc[]
include::control.adoc[]
include::elements.adoc[]
include::field-output.adoc[]
include::lines.adoc[]
include::beam-command.adoc[]
include::distribution.adoc[]
include::fieldsolvers.adoc[]
include::track.adoc[]
include::wakefields.adoc[]
include::geometry.adoc[]
include::partmatter.adoc[]
include::optimiser.adoc[]
include::sampler.adoc[]
include::syntax.adoc[]
include::fieldmaps.adoc[]
include::opal-madx.adoc[]
include::autophase.adoc[]
include::benchmarks.adoc[]
endif::[]

gsell's avatar
gsell committed
125
// EOF