root/doc/html/classIMpmsm2o.html @ 234

Revision 234, 17.7 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: IMpmsm2o Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>IMpmsm2o Class Reference<br>
28<small>
29[<a class="el" href="group__PMSM.html">PMSM</a>]</small>
30</h1><!-- doxytag: class="IMpmsm2o" --><!-- doxytag: inherits="diffbifn" -->State evolution model for a PMSM drive and its derivative with respect to <img class="formulaInl" alt="$x$" src="form_28.png">. 
31<a href="#_details">More...</a>
32<p>
33<code>#include &lt;<a class="el" href="pmsm_8h-source.html">pmsm.h</a>&gt;</code>
34<p>
35<div class="dynheader">
36Inheritance diagram for IMpmsm2o:</div>
37<div class="dynsection">
38<p><center><img src="classIMpmsm2o__inherit__graph.png" border="0" usemap="#IMpmsm2o__inherit__map" alt="Inheritance graph"></center>
39<map name="IMpmsm2o__inherit__map">
40<area shape="rect" href="classdiffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="19,84,83,111"><area shape="rect" href="classfnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="31,7,71,33"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
43Collaboration diagram for IMpmsm2o:</div>
44<div class="dynsection">
45<p><center><img src="classIMpmsm2o__coll__graph.png" border="0" usemap="#IMpmsm2o__coll__map" alt="Collaboration graph"></center>
46<map name="IMpmsm2o__coll__map">
47<area shape="rect" href="classdiffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="24,119,88,145"><area shape="rect" href="classfnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="5,7,45,33"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="69,7,107,33"></map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
51<a href="classIMpmsm2o-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
52<tr><td></td></tr>
53<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="abdefc0467678a05abf12f5c77eaf49d"></a><!-- doxytag: member="IMpmsm2o::set_parameters" ref="abdefc0467678a05abf12f5c77eaf49d" args="(double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm2o.html#abdefc0467678a05abf12f5c77eaf49d">set_parameters</a> (double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set mechanical and electrical variables. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86e04b5118e567ea7a2540059f553f41"></a><!-- doxytag: member="IMpmsm2o::eval" ref="86e04b5118e567ea7a2540059f553f41" args="(const vec &amp;x0, const vec &amp;u0)" -->
59vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm2o.html#86e04b5118e567ea7a2540059f553f41">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm2o.html#0a3e125df1e53821e08accbd4960d713">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .  <a href="#0a3e125df1e53821e08accbd4960d713"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm2o.html#27f9d89bce832056f747d985df77a726">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .  <a href="#27f9d89bce832056f747d985df77a726"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad7673e16aa1a046b131b24c731c4632"></a><!-- doxytag: member="IMpmsm2o::eval" ref="ad7673e16aa1a046b131b24c731c4632" args="(const vec &amp;cond)" -->
69vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#ad7673e16aa1a046b131b24c731c4632">eval</a> (const vec &amp;cond)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png"> (VS: Do we really need common eval? ). <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="436de7a7301ea9eac7d6081b893bbf57"></a><!-- doxytag: member="IMpmsm2o::_dimx" ref="436de7a7301ea9eac7d6081b893bbf57" args="() const " -->
73int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#436de7a7301ea9eac7d6081b893bbf57">_dimx</a> () const </td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc8779acbff170611aff0ee70cee3879"></a><!-- doxytag: member="IMpmsm2o::_dimu" ref="fc8779acbff170611aff0ee70cee3879" args="() const " -->
77int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#fc8779acbff170611aff0ee70cee3879">_dimu</a> () const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d28babf615a7240c34ee57779250f602"></a><!-- doxytag: member="IMpmsm2o::condition" ref="d28babf615a7240c34ee57779250f602" args="(const vec &amp;val)" -->
81virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#d28babf615a7240c34ee57779250f602">condition</a> (const vec &amp;val)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8891973d0ca48ce38e1886df45ca298"></a><!-- doxytag: member="IMpmsm2o::_dimy" ref="a8891973d0ca48ce38e1886df45ca298" args="() const " -->
85int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#a8891973d0ca48ce38e1886df45ca298">_dimy</a> () const </td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6514cda776819b65fd9e41a1a6a798c"></a><!-- doxytag: member="IMpmsm2o::Rs" ref="a6514cda776819b65fd9e41a1a6a798c" args="" -->
90double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Rs</b></td></tr>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bef34361d7602b1a75c5b9f701bce40f"></a><!-- doxytag: member="IMpmsm2o::Ls" ref="bef34361d7602b1a75c5b9f701bce40f" args="" -->
93double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Ls</b></td></tr>
94
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="399e2df590d6425a01e47c6deaa7e838"></a><!-- doxytag: member="IMpmsm2o::dt" ref="399e2df590d6425a01e47c6deaa7e838" args="" -->
96double&nbsp;</td><td class="memItemRight" valign="bottom"><b>dt</b></td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99af79af69627fae52ec8fa8e167f775"></a><!-- doxytag: member="IMpmsm2o::Ypm" ref="99af79af69627fae52ec8fa8e167f775" args="" -->
99double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Ypm</b></td></tr>
100
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="993cf4903bce863c6b7fb2355411db4a"></a><!-- doxytag: member="IMpmsm2o::kp" ref="993cf4903bce863c6b7fb2355411db4a" args="" -->
102double&nbsp;</td><td class="memItemRight" valign="bottom"><b>kp</b></td></tr>
103
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8644abe49171d006cbf9bff2844816a3"></a><!-- doxytag: member="IMpmsm2o::p" ref="8644abe49171d006cbf9bff2844816a3" args="" -->
105double&nbsp;</td><td class="memItemRight" valign="bottom"><b>p</b></td></tr>
106
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01a151f4ec2818e39537bebcbb8b152d"></a><!-- doxytag: member="IMpmsm2o::J" ref="01a151f4ec2818e39537bebcbb8b152d" args="" -->
108double&nbsp;</td><td class="memItemRight" valign="bottom"><b>J</b></td></tr>
109
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38253f515b9b35ab3a536f4871287025"></a><!-- doxytag: member="IMpmsm2o::Mz" ref="38253f515b9b35ab3a536f4871287025" args="" -->
111double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Mz</b></td></tr>
112
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf96b86250c3cbd465ba5ee62474b75"></a><!-- doxytag: member="IMpmsm2o::rvx" ref="bcf96b86250c3cbd465ba5ee62474b75" args="" -->
114<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#bcf96b86250c3cbd465ba5ee62474b75">rvx</a></td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c41c74c7942dba51ef0b0bfed963447d"></a><!-- doxytag: member="IMpmsm2o::rvu" ref="c41c74c7942dba51ef0b0bfed963447d" args="" -->
118<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#c41c74c7942dba51ef0b0bfed963447d">rvu</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6918bc0a9dad656b4cddc028137eb78"></a><!-- doxytag: member="IMpmsm2o::dimx" ref="f6918bc0a9dad656b4cddc028137eb78" args="" -->
122int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#f6918bc0a9dad656b4cddc028137eb78">dimx</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e07ce491e973f03d763e37624d0fe79"></a><!-- doxytag: member="IMpmsm2o::dimu" ref="2e07ce491e973f03d763e37624d0fe79" args="" -->
126int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#2e07ce491e973f03d763e37624d0fe79">dimu</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22d51d10a7901331167f64f80d1af8e9"></a><!-- doxytag: member="IMpmsm2o::dimy" ref="22d51d10a7901331167f64f80d1af8e9" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#22d51d10a7901331167f64f80d1af8e9">dimy</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
133</table>
134<hr><a name="_details"></a><h2>Detailed Description</h2>
135State evolution model for a PMSM drive and its derivative with respect to <img class="formulaInl" alt="$x$" src="form_28.png">. <hr><h2>Member Function Documentation</h2>
136<a class="anchor" name="0a3e125df1e53821e08accbd4960d713"></a><!-- doxytag: member="IMpmsm2o::dfdx_cond" ref="0a3e125df1e53821e08accbd4960d713" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
137<div class="memitem">
138<div class="memproto">
139      <table class="memname">
140        <tr>
141          <td class="memname">void IMpmsm2o::dfdx_cond           </td>
142          <td>(</td>
143          <td class="paramtype">const vec &amp;&nbsp;</td>
144          <td class="paramname"> <em>x0</em>, </td>
145        </tr>
146        <tr>
147          <td class="paramkey"></td>
148          <td></td>
149          <td class="paramtype">const vec &amp;&nbsp;</td>
150          <td class="paramname"> <em>u0</em>, </td>
151        </tr>
152        <tr>
153          <td class="paramkey"></td>
154          <td></td>
155          <td class="paramtype">mat &amp;&nbsp;</td>
156          <td class="paramname"> <em>A</em>, </td>
157        </tr>
158        <tr>
159          <td class="paramkey"></td>
160          <td></td>
161          <td class="paramtype">bool&nbsp;</td>
162          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
163        </tr>
164        <tr>
165          <td></td>
166          <td>)</td>
167          <td></td><td></td><td><code> [inline, virtual]</code></td>
168        </tr>
169      </table>
170</div>
171<div class="memdoc">
172
173<p>
174Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
175<p>
176<dl compact><dt><b>Parameters:</b></dt><dd>
177  <table border="0" cellspacing="2" cellpadding="0">
178    <tr><td valign="top"></td><td valign="top"><em>full</em>&nbsp;</td><td>denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. </td></tr>
179    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_28.png">, </td></tr>
180    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
181    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
182  </table>
183</dl>
184
185<p>Reimplemented from <a class="el" href="classdiffbifn.html#6d217a02d4fa13931258d4bebdd0feb4">diffbifn</a>.</p>
186
187</div>
188</div><p>
189<a class="anchor" name="27f9d89bce832056f747d985df77a726"></a><!-- doxytag: member="IMpmsm2o::dfdu_cond" ref="27f9d89bce832056f747d985df77a726" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
190<div class="memitem">
191<div class="memproto">
192      <table class="memname">
193        <tr>
194          <td class="memname">void IMpmsm2o::dfdu_cond           </td>
195          <td>(</td>
196          <td class="paramtype">const vec &amp;&nbsp;</td>
197          <td class="paramname"> <em>x0</em>, </td>
198        </tr>
199        <tr>
200          <td class="paramkey"></td>
201          <td></td>
202          <td class="paramtype">const vec &amp;&nbsp;</td>
203          <td class="paramname"> <em>u0</em>, </td>
204        </tr>
205        <tr>
206          <td class="paramkey"></td>
207          <td></td>
208          <td class="paramtype">mat &amp;&nbsp;</td>
209          <td class="paramname"> <em>A</em>, </td>
210        </tr>
211        <tr>
212          <td class="paramkey"></td>
213          <td></td>
214          <td class="paramtype">bool&nbsp;</td>
215          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
216        </tr>
217        <tr>
218          <td></td>
219          <td>)</td>
220          <td></td><td></td><td><code> [inline, virtual]</code></td>
221        </tr>
222      </table>
223</div>
224<div class="memdoc">
225
226<p>
227Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
228<p>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230  <table border="0" cellspacing="2" cellpadding="0">
231    <tr><td valign="top"></td><td valign="top"><em>full</em>&nbsp;</td><td>denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. </td></tr>
232    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_28.png">, </td></tr>
233    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
234    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
235  </table>
236</dl>
237
238<p>Reimplemented from <a class="el" href="classdiffbifn.html#1978bafd7909d15c139a08c495c24aa0">diffbifn</a>.</p>
239
240</div>
241</div><p>
242<hr>The documentation for this class was generated from the following file:<ul>
243<li>work/git/mixpp/pmsm/<a class="el" href="pmsm_8h-source.html">pmsm.h</a></ul>
244</div>
245<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:51:14 2009 for mixpp by&nbsp;
246<a href="http://www.doxygen.org/index.html">
247<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
248</body>
249</html>
Note: See TracBrowser for help on using the browser.