source: MML/trunk/mml/at/doc_html/at/getharmonicnumber.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.7 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 getharmonicnumber</title>
6  <meta name="keywords" content="getharmonicnumber">
7  <meta name="description" content="GETHARMONICNUMBER - Returns the harmonic number from the AT model">
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">at</a> &gt; getharmonicnumber.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 at&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>getharmonicnumber
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>GETHARMONICNUMBER - Returns the harmonic number from the AT model</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 HarmNumber = getharmonicnumber </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">GETHARMONICNUMBER - Returns the harmonic number from the AT model
31  HarmonicNumber = getharmonicnumber
32
33  If there is not a cavity in the model, getharmonicnumber returns
34  HarmonicNumber = getfamilydata('HarmonicNumber');
35
36  Written by Greg Portmann</pre></div>
37
38<!-- crossreference -->
39<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
40This function calls:
41<ul style="list-style-image:url(../matlabicon.gif)">
42<li><a href="getcavity.html" class="code" title="function [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = getcavity">getcavity</a>   GETCAVITY - Returns the RF cavity state ('On' / 'Off')</li></ul>
43This function is called by:
44<ul style="list-style-image:url(../matlabicon.gif)">
45</ul>
46<!-- crossreference -->
47
48
49<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
50<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function HarmNumber = getharmonicnumber</a>
510002 <span class="comment">%GETHARMONICNUMBER - Returns the harmonic number from the AT model</span>
520003 <span class="comment">%  HarmonicNumber = getharmonicnumber</span>
530004 <span class="comment">%</span>
540005 <span class="comment">%  If there is not a cavity in the model, getharmonicnumber returns</span>
550006 <span class="comment">%  HarmonicNumber = getfamilydata('HarmonicNumber');</span>
560007 <span class="comment">%</span>
570008 <span class="comment">%  Written by Greg Portmann</span>
580009
590010
600011 [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = <a href="getcavity.html" class="code" title="function [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = getcavity">getcavity</a>;
610012
620013 <span class="keyword">if</span> isempty(HarmNumber)
630014     HarmNumber = getfamilydata(<span class="string">'HarmonicNumber'</span>);
640015
650016     <span class="keyword">if</span> isempty(HarmNumber)
660017         <span class="comment">% Machine   Energy   HarmonicNumber  RF Freq [MHz]</span>
670018         <span class="comment">% ALS        1.9        328          499.6403489</span>
680019         <span class="comment">% ALBA       3.0        448          499.65</span>
690020         <span class="comment">% ASP        3.0        360          499.666694585</span>
700021         <span class="comment">% CAMD       3.0         92          499.6541</span>
710022         <span class="comment">% CLS        3.0        285          500.004977352</span>
720023         <span class="comment">% Diamond    3.0        936          499.6540967</span>
730024         <span class="comment">% DSR        0.274       64          178.55</span>
740025         <span class="comment">% NSRRC      1.5        200          499.65</span>
750026         <span class="comment">% PLS        2.5        468          500.0008</span>
760027         <span class="comment">% Spear3     3.0        372          476.300005749</span>
770028         <span class="comment">% Soleil     2.7391     416          352.2</span>
780029         <span class="comment">% SPS        1.2         32          118.0006</span>
790030         <span class="comment">% SSRF       3.5        720          499.650966666</span>
800031         <span class="comment">% VUV        0.808        9           52.88</span>
810032         <span class="comment">% X-Ray      2.8         30           52.88</span>
820033
830034         <span class="keyword">if</span> isempty(HarmNumber)
840035             MachineName = getfamilydata(<span class="string">'Machine'</span>);
850036             <span class="keyword">if</span> strcmpi(MachineName, <span class="string">'ALS'</span>)
860037                 HarmNumber = 328;
870038            <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'ALBA'</span>)
880039                 HarmNumber = 448;
890040             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'ASP'</span>)
900041                 HarmNumber = 360;
910042             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'CAMD'</span>)
920043                 HarmNumber = 92;
930044             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'CLS'</span>)
940045                 HarmNumber = 285;
950046             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'Diamond'</span>)
960047                 HarmNumber = 936;
970048             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'DSR'</span>)
980049                 HarmNumber = 72;
990050             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'NSRRC'</span>)
1000051                 HarmNumber = 200;
1010052             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'PLS'</span>)
1020053                 HarmNumber = 468;
1030054             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'Spear3'</span>)
1040055                 HarmNumber = 372;
1050056             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'Soleil'</span>)
1060057                 HarmNumber = 416;
1070058             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'SPS'</span>)
1080059                 HarmNumber = 32;
1090060             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'SSRF'</span>)
1100061                 HarmNumber = 720;
1110062             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'VUV'</span>)
1120063                 HarmNumber = 9;
1130064             <span class="keyword">elseif</span> strcmpi(MachineName, <span class="string">'XRAY'</span>)
1140065                 HarmNumber = 30;
1150066             <span class="keyword">else</span>
1160067                 error(<span class="string">'Harmonic number unknown.  Either add an RF cavity to the AT model or add AD.HarmonicNumber to the Middle Layer.'</span>);
1170068             <span class="keyword">end</span>
1180069         <span class="keyword">end</span>
1190070     <span class="keyword">end</span>
1200071 <span class="keyword">end</span>
1210072</pre></div>
122<hr><address>Generated on Fri 18-May-2007 17:13:39 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
123</body>
124</html>
Note: See TracBrowser for help on using the repository browser.