source: MML/trunk/mml/at/doc_html/at/cavityoff.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: 4.1 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 cavityoff</title>
6  <meta name="keywords" content="cavityoff">
7  <meta name="description" content="CAVITYOFF - Turns all cavities off">
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; cavityoff.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>cavityoff
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>CAVITYOFF - Turns all cavities off</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 varargout = cavityoff(varargin) </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">CAVITYOFF - Turns all cavities off
31  Sets PassMethod to DriftPass or IdentityPass depending
32  on the value of 'Length' field
33
34  See also CAVITYON, RADIATIONON, <a href="radiationoff.html" class="code" title="function varargout = radiationoff(varargin)">RADIATIONOFF</a></pre></div>
35
36<!-- crossreference -->
37<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
38This function calls:
39<ul style="list-style-image:url(../matlabicon.gif)">
40</ul>
41This function is called by:
42<ul style="list-style-image:url(../matlabicon.gif)">
43</ul>
44<!-- crossreference -->
45
46
47<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
48<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function varargout = cavityoff(varargin)</a>
490002 <span class="comment">%CAVITYOFF - Turns all cavities off</span>
500003 <span class="comment">%  Sets PassMethod to DriftPass or IdentityPass depending</span>
510004 <span class="comment">%  on the value of 'Length' field</span>
520005 <span class="comment">%</span>
530006 <span class="comment">%  See also CAVITYON, RADIATIONON, RADIATIONOFF</span>
540007
550008
560009 <span class="keyword">if</span> ~evalin(<span class="string">'base'</span>,<span class="string">'exist(''THERING'')'</span>) | ~evalin(<span class="string">'base'</span>,<span class="string">'isglobal(THERING)'</span>);
570010    error(<span class="string">'Global variable THERING could not be found'</span>);
580011 <span class="keyword">end</span>
590012
600013 <span class="keyword">global</span> THERING
610014
620015 localcavindex = findcells(THERING,<span class="string">'Frequency'</span>);
630016
640017 <span class="keyword">if</span> isempty(localcavindex)
650018    error(<span class="string">'No cavities were found in the lattice'</span>);
660019 <span class="keyword">end</span>
670020
680021
690022 <span class="keyword">for</span> ii = localcavindex
700023    <span class="keyword">if</span> THERING{ii}.Length == 0;
710024       THERING{ii}.PassMethod = <span class="string">'IdentityPass'</span>;
720025    <span class="keyword">else</span>
730026       THERING{ii}.PassMethod = <span class="string">'DriftPass'</span>;
740027    <span class="keyword">end</span>
750028 <span class="keyword">end</span>
760029
770030 disp(strcat(<span class="string">'Cavities located at index  ['</span>,num2str(localcavindex),  <span class="string">']  were turned OFF'</span>))     
780031 clear ii localcavindex</pre></div>
79<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>
80</body>
81</html>
Note: See TracBrowser for help on using the repository browser.