source: MML/trunk/at/doc_html/at/simulator/element/drift.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: 3.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 drift</title>
6  <meta name="keywords" content="drift">
7  <meta name="description" content="DRIFT('FAMILYNAME',Length [m],'METHOD')">
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; <a href="#">simulator</a> &gt; <a href="index.html">element</a> &gt; drift.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/simulator/element&nbsp;<img alt=">" border="0" src="../../../right.png"></a></td></tr></table>-->
19
20<h1>drift
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>DRIFT('FAMILYNAME',Length [m],'METHOD')</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 z = drift(fname,L,method) </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">DRIFT('FAMILYNAME',Length [m],'METHOD')
31    creates a new family in the FAMLIST - a structure with fields
32        FamName            family name
33        Length            length[m]
34        PassMethod        name of the function on disk to use for tracking
35 returns assigned address in the FAMLIST that is uniquely identifies
36 the family</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</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 z = drift(fname,L,method)</a>
510002 <span class="comment">%DRIFT('FAMILYNAME',Length [m],'METHOD')</span>
520003 <span class="comment">%    creates a new family in the FAMLIST - a structure with fields</span>
530004 <span class="comment">%        FamName            family name</span>
540005 <span class="comment">%        Length            length[m]</span>
550006 <span class="comment">%        PassMethod        name of the function on disk to use for tracking</span>
560007 <span class="comment">% returns assigned address in the FAMLIST that is uniquely identifies</span>
570008 <span class="comment">% the family</span>
580009
590010 ElemData.FamName = fname;  <span class="comment">% add check for identical family names</span>
600011 ElemData.Length = L;
610012 ElemData.PassMethod=method;
620013
630014 <span class="keyword">global</span> FAMLIST
640015 z = length(FAMLIST)+1; <span class="comment">% number of declare families including this one</span>
650016 FAMLIST{z}.FamName = fname;
660017 FAMLIST{z}.NumKids = 0;
670018 FAMLIST{z}.KidsList= [];
680019 FAMLIST{z}.ElemData= ElemData;
690020
700021</pre></div>
71<hr><address>Generated on Mon 21-May-2007 15:26:45 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
72</body>
73</html>
Note: See TracBrowser for help on using the repository browser.