source: PSPA/madxPSPA/doc/usrguide/ptc_auxiliaries/PTC_Knob.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: 4.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6
7<head>
8<meta http-equiv=Content-Type content="text/html; charset=iso-8889-2">
9<meta name=Generator content="NEdit">
10<meta name=Originator content="Skowron">
11<link rel="stylesheet" type="text/css" href="../ptc_general/madxdoc_ps.css" />
12<title>PTC_KNOB</title>
13<style>
14</style>
15</head>
16
17<body bgcolor="#ffffff"'>
18
19<div style="text-align:center;">
20<center>
21  EUROPEAN ORGANIZATION FOR NUCLEAR RESEARCH
22  <IMG SRC="http://cern.ch/madx/icons/mx7_25.gif" align="right">
23  <h1>PTC_KNOB</h1>
24 
25</center>
26</div>
27
28
29<!--  ##########################################################              -->
30
31<div class="madxdocContent">
32
33
34<!--  ##########################################################              -->
35<!--  ##########################################################              -->
36<!--  ##########################################################              -->
37
38<h3 align=center style='margin-top:0cm;text-align:left;text-indent:0cm'>
39 <span>
40  USER MANUAL
41 </span>
42</h3>
43
44<div>
45
46<!--  ##########################################################              -->
47
48<h4>SYNOPSIS</h4>
49
50<pre>
51<big>
52PTC_KNOB,
53elementname = [s, none] ,
54kn    = [i, {-1}],
55ks    = [i, {-1}],
56exactmatch = [l, true, true] ;
57
58</big>
59</pre>
60
61</div>
62 
63<!--  ##########################################################              -->
64
65<h4> Description </h4>
66
67<div>
68Sets knobs in PTC calculations (currently ony in PTC_TWISS, PTC_NORMAL will follow).
69Knobs appear as the additional parameters of the phase space. Twiss functions are then obtained
70as functions of these parameters (Taylor series).
71Also map elements might be stored as functions of knobs, see
72<a href="PTC_Select.html"> ptc_select</a> command description to lear how to
73request given element to be stored as a Taylor series.
74
75The parametric results can be further
76<ol>
77<li> written to a file with <a href="PTC_PrintParametric.html">ptc_printparametric</a>.</li>
78<li> plotted and studied using <a href="">rviewer</a> command (rplot plugin). </li>
79<li> used to obtain very quickly approximate values of lattice functions for given values of knobs
80    (<a href="PTC_SetKnobValue.html">ptc_setknobvalue</a>).
81    This feature is the foundation of a fast matching alorithm with PTC.
82    </li>
83</ol>
84
85</div>
86
87<h4> Example </h4>
88
89<a href="http://cern.ch/frs/mad-X_examples/ptc_madx_interface/knobs/knobs.madx"> dog leg chicane  </a> :
90Dipolar components of both rbends and dipolar and quadrupolar components of the focusing quads set as knobs.
91Some first and second order map coefficients set to be stored as parametric results.
92ptc_twiss command is performed and the parametric results are written to files in two formats.
93
94<a href="http://cern.ch/frs/mad-X_examples/ptc_madx_interface/matchknobs/matchknobs.madx"> dog leg chicane  </a> :
95Knobs values are matched to get requested lattice functions.
96
97
98<!--  ##########################################################              -->
99
100<h4> Command parameters and switches </h4>
101<div>
102
103<dl>
104<dt><b> elementname </b></dt> 
105  <dd>
106  <i> string in range format, </i>
107  <p> Specifies name of the element containing the knob(s) to be set.
108  </dd>
109<dt><b> kn,ks </b></dt> 
110  <dd>
111  <i> list of integers,   </i>
112  <p> Defines which order
113  </dd>
114
115<dt><b> exactmatch <dt><b> 
116  <dd>
117  <i> logical, default true, if value explicitly not specified then true</i>
118  <p> Normally a knob is a property of a single element in a layout.
119      The specified name must match 1:1 to an element name. This is the case
120      when exactmatch is true.
121 
122  <p> Knobs might be alos set to all family of elements. In such case
123      the exactmatch switch must be false. A given order field component of all the elements
124      that name starts with the name specified by the user become a single knob.
125  </dd>
126
127<dt><b> initial <dt><b> 
128
129
130
131</dl>
132
133<h4>_  </h4>
134
135
136<!-- ############################################################ -->
137<!-- ############################################################ -->
138<!-- ############################################################ -->
139<!--
140<h3> PROGRAMMERS MANUAL </h3>
141
142<p> 
143The command is implemented pro_ptc_knob function in madxn.c and
144by subroutine xxxx in madx_ptc_xxx.f90.
145<p>
146Sopecified range is resolved with help of get_range command. Number of the element in the current sequence
147is resolved and passed as the parameter to the fortran routine. It allows to resolve uniquely the corresponding
148element in the PTC layout.
149<p>
150
151-->
152
153</div>
154
155</body>
156
157</html>
Note: See TracBrowser for help on using the repository browser.