source: MML/trunk/mml/at/doc_html/at/modelmcf.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.5 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 modelmcf</title>
6  <meta name="keywords" content="modelmcf">
7  <meta name="description" content="MODELMCF - Momentum compaction factor (MCF) of the 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; modelmcf.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>modelmcf
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>MODELMCF - Momentum compaction factor (MCF) of the 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 Alpha = modelmcf </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">MODELMCF - Momentum compaction factor (MCF) of the model
31  Alpha = modelmcf
32 
33 OUTPUTS
34 Alpha - Momentum compaction factor
35         Calls the AT function:  mcf(THERING)
36
37 See also getmcf, mcf</pre></div>
38
39<!-- crossreference -->
40<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
41This function calls:
42<ul style="list-style-image:url(../matlabicon.gif)">
43</ul>
44This function is called by:
45<ul style="list-style-image:url(../matlabicon.gif)">
46<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></ul>
47<!-- crossreference -->
48
49
50<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
51<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function Alpha = modelmcf</a>
520002 <span class="comment">%MODELMCF - Momentum compaction factor (MCF) of the model</span>
530003 <span class="comment">%  Alpha = modelmcf</span>
540004 <span class="comment">%</span>
550005 <span class="comment">% OUTPUTS</span>
560006 <span class="comment">% Alpha - Momentum compaction factor</span>
570007 <span class="comment">%         Calls the AT function:  mcf(THERING)</span>
580008 <span class="comment">%</span>
590009 <span class="comment">% See also getmcf, mcf</span>
600010
610011 <span class="comment">%</span>
620012 <span class="comment">%  Written by Gregory J. Portmann</span>
630013
640014 <span class="keyword">global</span> THERING
650015 <span class="keyword">if</span> ~isempty(THERING)
660016     <span class="comment">% Get from the model</span>
670017     Alpha = mcf(THERING);
680018 <span class="keyword">else</span>
690019     error(<span class="string">'Momentum compaction factor not available from the model'</span>);
700020 <span class="keyword">end</span></pre></div>
71<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>
72</body>
73</html>
Note: See TracBrowser for help on using the repository browser.