source: MML/trunk/mml/doc_html/mml/at/setcavity.html @ 4

Last change on this file since 4 was 4, checked in by zhangj, 10 years ago

Initial import--MML version from SOLEIL@2013
File size: 7.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of setcavity</title>
6  <meta name="keywords" content="setcavity">
7  <meta name="description" content="SETCAVITY - Set the RF cavity state">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../../index.html">Home</a> &gt;  <a href="../index.html">mml</a> &gt; <a href="index.html">at</a> &gt; setcavity.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../../index.html"><img alt="<" border="0" src="../../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for mml/at&nbsp;<img alt=">" border="0" src="../../right.png"></a></td></tr></table>-->
19
20<h1>setcavity
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
24<div class="box"><strong>SETCAVITY - Set the RF cavity state</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
27<div class="box"><strong>function ATCavityIndex = setcavity(InputString) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
30<div class="fragment"><pre class="comment">SETCAVITY - Set the RF cavity state
31  ATCavityIndex = setcavity(InputString)
32
33  INPUTS
34  1. 'On', 'Off', or PassMethod {Default: no change}
35
36  OUTPUTS
37  1. ATCavityIndex - AT Index of the RF cavities
38
39  NOTE
40  1. For more than one cavity, the InputString can have
41     more than one row.
42
43  See also <a href="getcavity.html" class="code" title="function [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = getcavity">getcavity</a> <a href="setradiation.html" class="code" title="function [PassMethod, ATIndex, FamName, PassMethodOld, ATIndexOld, FamNameOld] = setradiation(InputString)">setradiation</a>
44
45  Written by Greg Portmann</pre></div>
46
47<!-- crossreference -->
48<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
49This function calls:
50<ul style="list-style-image:url(../../matlabicon.gif)">
51</ul>
52This function is called by:
53<ul style="list-style-image:url(../../matlabicon.gif)">
54<li><a href="calccoupling.html" class="code" title="function [Tilt, Eta, Ratio, ENV, DP, DL] = calccoupling">calccoupling</a>   CALCCOUPLING - Calculates the coupling and tilt of the AT model</li><li><a href="getpvmodel.html" class="code" title="function [AM, tout, DataTime, ErrorFlag] = getpvmodel(varargin)">getpvmodel</a>   GETPVMODEL - Get the model value</li><li><a href="modelchro.html" class="code" title="function [Chro, Tune] = modelchro(varargin)">modelchro</a>        MODELCHRO - Returns the AT model chromaticity</li><li><a href="modeldisp.html" class="code" title="function [Dx, Dy, Sx, Sy] = modeldisp(varargin)">modeldisp</a>       MODELDISP - Returns the dispersion function of the model</li><li><a href="modeltune.html" class="code" title="function [FractionalTune, IntegerTune] = modeltune">modeltune</a> MODELTUNE - Returns the model tune (2x1 vector)</li></ul>
55<!-- crossreference -->
56
57
58<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
59<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function ATCavityIndex = setcavity(InputString)</a>
600002 <span class="comment">%SETCAVITY - Set the RF cavity state</span>
610003 <span class="comment">%  ATCavityIndex = setcavity(InputString)</span>
620004 <span class="comment">%</span>
630005 <span class="comment">%  INPUTS</span>
640006 <span class="comment">%  1. 'On', 'Off', or PassMethod {Default: no change}</span>
650007 <span class="comment">%</span>
660008 <span class="comment">%  OUTPUTS</span>
670009 <span class="comment">%  1. ATCavityIndex - AT Index of the RF cavities</span>
680010 <span class="comment">%</span>
690011 <span class="comment">%  NOTE</span>
700012 <span class="comment">%  1. For more than one cavity, the InputString can have</span>
710013 <span class="comment">%     more than one row.</span>
720014 <span class="comment">%</span>
730015 <span class="comment">%  See also getcavity setradiation</span>
740016 <span class="comment">%</span>
750017 <span class="comment">%  Written by Greg Portmann</span>
760018
770019 <span class="keyword">global</span> THERING
780020
790021 <span class="keyword">if</span> nargin == 0
800022     InputString = <span class="string">''</span>;
810023 <span class="keyword">end</span>
820024
830025 ATCavityIndex = findcells(THERING, <span class="string">'Frequency'</span>);
840026
850027 <span class="keyword">if</span> isempty(InputString)
860028     <span class="keyword">return</span>;
870029 <span class="keyword">end</span>
880030
890031 <span class="keyword">if</span> isempty(ATCavityIndex)
900032     <span class="comment">%fprintf('   No cavities were found in the lattice (setcavity).\');</span>
910033     <span class="keyword">return</span>
920034 <span class="keyword">end</span>
930035
940036
950037 ATCavityIndex =ATCavityIndex(:)';
960038 <span class="keyword">for</span> iCavity = 1:length(ATCavityIndex)
970039
980040     <span class="keyword">if</span> size(InputString,1) == 1
990041         CavityString = deblank(InputString);
1000042     <span class="keyword">elseif</span> size(InputString,1) == length(ATCavityIndex)
1010043         CavityString = deblank(InputString(iCavity,:));
1020044     <span class="keyword">else</span>
1030045         error(<span class="string">'Number of rows in the input string must be 1 row or equal to the number of cavities.'</span>);
1040046     <span class="keyword">end</span>       
1050047     
1060048     <span class="keyword">if</span> strcmpi(CavityString,<span class="string">'off'</span>)
1070049             <span class="keyword">if</span> THERING{ATCavityIndex(iCavity)}.Length == 0;
1080050                 THERING{ATCavityIndex(iCavity)}.PassMethod = <span class="string">'IdentityPass'</span>;
1090051             <span class="keyword">else</span>
1100052                 THERING{ATCavityIndex(iCavity)}.PassMethod = <span class="string">'DriftPass'</span>;
1110053             <span class="keyword">end</span>
1120054
1130055     <span class="keyword">elseif</span> strcmpi(CavityString,<span class="string">'on'</span>)
1140056
1150057             <span class="comment">%if THERING{ATCavityIndex(iCavity)}.Length == 0;</span>
1160058             <span class="comment">%    THERING{ATCavityIndex(iCavity)}.PassMethod = 'ThinCavityPass';</span>
1170059             <span class="comment">%else</span>
1180060                 THERING{ATCavityIndex(iCavity)}.PassMethod = <span class="string">'CavityPass'</span>;
1190061             <span class="comment">%end</span>
1200062             
1210063     <span class="keyword">else</span>
1220064         THERING{ATCavityIndex(iCavity)}.PassMethod = CavityString;
1230065     <span class="keyword">end</span>
1240066 <span class="keyword">end</span></pre></div>
125<hr><address>Generated on Mon 21-May-2007 15:29:18 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
126</body>
127</html>
Note: See TracBrowser for help on using the repository browser.