source: PSPA/madxPSPA/doc/usrguide/sodd/sodd.html @ 430

Last change on this file since 430 was 430, checked in by touze, 11 years ago

import madx-5.01.00
File size: 6.1 KB
Line 
1<head>
2<title>SODD</title>
3<!-- Changed by: E. T. d'Amico, 8-Sep-2004 -->
4</head>
5
6<body bgcolor="#ffffff">
7<center>
8EUROPEAN ORGANIZATION FOR NUCLEAR RESEARCH
9<IMG SRC="http://cern.ch/madx/icons/mx7_25.gif" align=right>
10<h2>SODD</h2>
11</center>
12<p>
13This command will execute the Second Order Detuning and Distortion as
14described in the paper of J. Bengtsson and J. Irwin
15"Analytical Calculation of Smear and Tune Shift " (SSC-232, February
161990), on the beam line defined by the last USE command followed by a
17TWISS command. It is based on the stand-alone program written by Frank
18Schmidt in November 1998 - January 1999 who also extended the
19analytical computation to the second order distortion (cfr. Beam
20Physics Note 60 F. Schmidt "SODD: A physics Guide").
21It consists of three parts:
22<p>
23<li><h4>Subroutine detune (launched by the attribute detune)</h4>
24It calculates the detuning
25function terms in first and second order in the strength of the
26multipoles.
27If the attribute print_at_end has been set, the following two files
28(and the corresponding madx tables) are created :
29<p>
30<i>detune_1_end</i> containing five columns :
31<ul>
321) 'multipole order', 2) '(hor., ver. plane => (1/2)',
333) 'hor. or ver. detuning', 4) 'order of horizontal invariant', 5) 'order of
34vertical invariant'.
35</ul>
36<p> 
37<i>detune_2_end</i>  containing five columns :
38<ul>
391) 'first multipole order', 2) 'second multipole order',
403) 'horizontal detuning', 4) 'order of horizontal invariant', 5)'order of
41vertical invariant'.
42</ul>
43If the attribute print_all has been set, the following two files
44(and the corresponding madx tables) are created :
45<p>
46<i>detune_1_all</i>  containing  five columns :
47<ul>
481) 'multipole order', 2) '(hor., ver. plane => (1/2)',
493) 'hor. or ver. detuning', 4) 'order of horizontal invariant', 5)'order of
50vertical invariant'.
51</ul> 
52<i>detune_2_all</i>  containing five columns :
53<ul>
541) 'first multipole order', 2) 'second multipole order',
553) 'horizontal detuning', 4) 'order of horizontal invariant', 5) 'order of
56vertical invariant'.
57</ul>
58<p>
59<li><h4>Subroutine distort1 (launched by the attribute distort1)</h4> 
60It calculates the distortion function and the
61Hamiltonian terms in first order in the strength of the multipoles.
62If the attribute print_at_end has been set, the two files
63(and the corresponding madx tables) are created :
64<p>
65<i>distort_1_F_end</i> containing eight columns :
66<ul>
671) 'multipole order', 2) 'cosine part
68of distortion', 3) 'sine part of distortion', 4) 'amplitude of distortion',
695) 'j', 6) 'k', 7) 'l', 8) 'm'.
70</ul> 
71<i>distort_1_H_end</i>  containing eight columns :
72<ul>
731) 'multipole order', 2) 'cosine part
74of Hamiltonian', 3) 'sine part of Hamiltonian', 4) 'amplitude of Hamiltonian',
755) 'j', 6) 'k', 7) 'l', 8) 'm'.
76</ul>
77If the attribute print_all has been set, the following two files
78(and the corresponding madx tables) are created :
79<p>
80<i>distort_1_F_all</i> containing eleven columns :
81<ul>
821) 'multipole order', 2) 'appearance
83number in position range', 3) 'number of resonance', 4) 'position', 5)
84'cosine part of distortion', 6) 'sine part of distortion', 7) 'amplitude of distortion',
858) 'j', 9) 'k', 10) 'l', 11) 'm'.
86</ul> 
87<i>distort_1_H_all</i>  containing eleven columns :
88<ul>
891) 'multipole order', 2) 'appearance
90number in position range, 3) 'number of resonance', 4) 'position', 5) 'cosine part
91of Hamiltonian', 6) 'sine part of Hamiltonian', 7) 'amplitude of Hamiltonian',
928) 'j', 9) 'k', 10) 'l', 11) 'm'.
93</ul>
94<p>
95<li><h4>Subroutine distort2 (launched by the attribute distort2)</h4> 
96It calculates the distortion function and Hamiltonian
97terms in second order in the strength of the multipoles.
98If the attribute print_at_end has been set, the following two files
99(and the corresponding madx tables) are created :
100<p>
101<i>distort_2_F_end</i> containing nine columns :
102<ul>
1031) 'first multipole order',2) 'second multipole order',
1043) 'cosine part of distortion', 4) 'sine part of distortion', 5) 'amplitude of distortion',
1056) 'j', 7) 'k', 8) 'l', 9) 'm'.
106</ul> 
107<i>distort_2_H_end</i>  containing nine columns :
108<ul>
1091) 'first multipole order', 2) 'second multipole order',
1103) 'cosine part of Hamiltonian', 4) 'sine part of Hamiltonian', 5) 'amplitude of Hamiltonian',
1116) 'j', 7) 'k', 8) 'l', 9) 'm'.
112</ul>
113<p>
114N. B. The first row of every file is a header containing the names of
115the columns. This row is absent in the internal tables.
116<p>
117<li><h4><a name=sodd>SODD</a></h4>
118<pre>
119sodd,
120detune=logical,
121distort1=logical,
122distort2=logical,
123start_stop = start,stop
124multipole_order_range = fist,last
125noprint = logical
126print_all = logical
127print_at_end = logical
128nosixtrack  = logical
129</pre>
130where the parameters have the following meaning:
131</ul>
132<ul>
133<li>detune : logical, default=false. If true, the detune subroutine is executed.
134<li>distort1 : logical, default=false. If true, the distort1 subroutine is executed.
135<li>distort2 : logical, default=false. If true, the distort2 subroutine is executed.
136<li>start_stop : longitudinal interval of the beam line (in m). start
137and stop should be given as real numbers.
138<li>multipole_order_range : the lowest and the largest multipole order
139which will be taken in account. first and last should be given as integers.
140<li>noprint : logical, default=false. If true, no file or internal
141table will be created to keep the results. In this case the attributes
142print_all or print_at_end have no effect.
143<li>print_all : logical, default=false. If true, the files and
144internal tables containing results at each multipole will be generated.
145<li>print_at_end : logical, default=false. If true, the files and
146internal tables containing results at the end of the
147position range will be generated.
148<li>nosixtrack  : logical, default=false. If true, the input file
149fc.34 will not be generated internally by invoking the conversion
150routine of sixtrack and the user should provide it before the
151execution of the sodd command.
152</ul>
153<li>A more detailed description can be found in
154<address>
155<a href="http://cern.ch/madx/doc/ab-note-2004-069">AB-note-2004-069</a>
156</address>
157</ul>
158<address>
159<a href="http://xwho.web.cern.ch/xwho/people/show/6175">damico</a>,
160September 10, 2004
161</address>
162
163</body>
Note: See TracBrowser for help on using the repository browser.