root/doc/html/classIMpmsm.html @ 261

Revision 261, 18.4 kB (checked in by smidl, 15 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: IMpmsm 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><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27</div>
28<div class="contents">
29<h1>IMpmsm Class Reference<br>
30<small>
31[<a class="el" href="group__PMSM.html">PMSM</a>]</small>
32</h1><!-- doxytag: class="IMpmsm" --><!-- doxytag: inherits="bdm::diffbifn" -->State evolution model for a PMSM drive and its derivative with respect to <img class="formulaInl" alt="$x$" src="form_28.png">. 
33<a href="#_details">More...</a>
34<p>
35<code>#include &lt;<a class="el" href="pmsm_8h-source.html">pmsm.h</a>&gt;</code>
36<p>
37<div class="dynheader">
38Inheritance diagram for IMpmsm:</div>
39<div class="dynsection">
40<p><center><img src="classIMpmsm__inherit__graph.png" border="0" usemap="#IMpmsm__inherit__map" alt="Inheritance graph"></center>
41<map name="IMpmsm__inherit__map">
42<area shape="rect" href="classIMpmsmStat.html" title="State evolution model for a PMSM drive and its derivative with respect to , equation..." alt="" coords="392,316,496,343"><area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="149,161,248,188"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="160,84,237,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="143,7,255,33"></map>
43<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
44<div class="dynheader">
45Collaboration diagram for IMpmsm:</div>
46<div class="dynsection">
47<p><center><img src="classIMpmsm__coll__graph.png" border="0" usemap="#IMpmsm__coll__map" alt="Collaboration graph"></center>
48<map name="IMpmsm__coll__map">
49<area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="29,199,128,225"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="5,87,83,113"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="45,7,157,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="107,87,181,113"></map>
50<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
51
52<p>
53<a href="classIMpmsm-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
54<tr><td></td></tr>
55<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42818f3426d99fecb7e97be8ffe2e228"></a><!-- doxytag: member="IMpmsm::set_parameters" ref="42818f3426d99fecb7e97be8ffe2e228" args="(double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)" -->
57void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm.html#42818f3426d99fecb7e97be8ffe2e228">set_parameters</a> (double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set mechanical and electrical variables. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45785869d978dda42828a072ec2caebe"></a><!-- doxytag: member="IMpmsm::eval" ref="45785869d978dda42828a072ec2caebe" args="(const vec &amp;x0, const vec &amp;u0)" -->
61vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm.html#45785869d978dda42828a072ec2caebe">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm.html#b4378b5d3bf64c683e4cf5c5f1cd56f1">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
65
66<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="#b4378b5d3bf64c683e4cf5c5f1cd56f1"></a><br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIMpmsm.html#c3f8dad22ae9855c04a1d593b45c99b5">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
68
69<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="#c3f8dad22ae9855c04a1d593b45c99b5"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188f31066bd72e1bf0ddacd1eb0e6af3"></a><!-- doxytag: member="IMpmsm::eval" ref="188f31066bd72e1bf0ddacd1eb0e6af3" args="(const vec &amp;cond)" -->
71vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
72
73<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>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="IMpmsm::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
75int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="IMpmsm::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
79int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="IMpmsm::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
83virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#0786e40fade2663a70d654c1dda5d73e">condition</a> (const vec &amp;val)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="IMpmsm::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
87int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_dimy</a> () const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
90<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5908138b6c11f32971542423978a25d3"></a><!-- doxytag: member="IMpmsm::Rs" ref="5908138b6c11f32971542423978a25d3" args="" -->
92double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Rs</b></td></tr>
93
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="829e309d689b7e148d761d36b1b62fb7"></a><!-- doxytag: member="IMpmsm::Ls" ref="829e309d689b7e148d761d36b1b62fb7" args="" -->
95double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Ls</b></td></tr>
96
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec462f3df7355cc72843c945d887b9d3"></a><!-- doxytag: member="IMpmsm::dt" ref="ec462f3df7355cc72843c945d887b9d3" args="" -->
98double&nbsp;</td><td class="memItemRight" valign="bottom"><b>dt</b></td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1b973c18d381e7ec717165aa306b613"></a><!-- doxytag: member="IMpmsm::Ypm" ref="a1b973c18d381e7ec717165aa306b613" args="" -->
101double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Ypm</b></td></tr>
102
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03f1857fb1910c7b06dac4ce50482516"></a><!-- doxytag: member="IMpmsm::kp" ref="03f1857fb1910c7b06dac4ce50482516" args="" -->
104double&nbsp;</td><td class="memItemRight" valign="bottom"><b>kp</b></td></tr>
105
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0eddf56a8feb6b837ee3c36c0ac6b781"></a><!-- doxytag: member="IMpmsm::p" ref="0eddf56a8feb6b837ee3c36c0ac6b781" args="" -->
107double&nbsp;</td><td class="memItemRight" valign="bottom"><b>p</b></td></tr>
108
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83e4149bb70b022f3a19208f14eac0e3"></a><!-- doxytag: member="IMpmsm::J" ref="83e4149bb70b022f3a19208f14eac0e3" args="" -->
110double&nbsp;</td><td class="memItemRight" valign="bottom"><b>J</b></td></tr>
111
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aa4f9ee2b9babdc05f62ba275a9575f"></a><!-- doxytag: member="IMpmsm::Mz" ref="0aa4f9ee2b9babdc05f62ba275a9575f" args="" -->
113double&nbsp;</td><td class="memItemRight" valign="bottom"><b>Mz</b></td></tr>
114
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="IMpmsm::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
116RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#5f56547d8e9378b669d3cc19d7831cbb">rvx</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="IMpmsm::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
120RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a8e3e861d5ec2a7ae9524e6338e58320">rvu</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="IMpmsm::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
124int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="IMpmsm::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
128int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="IMpmsm::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
135</table>
136<hr><a name="_details"></a><h2>Detailed Description</h2>
137State 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>
138<a class="anchor" name="b4378b5d3bf64c683e4cf5c5f1cd56f1"></a><!-- doxytag: member="IMpmsm::dfdx_cond" ref="b4378b5d3bf64c683e4cf5c5f1cd56f1" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
139<div class="memitem">
140<div class="memproto">
141      <table class="memname">
142        <tr>
143          <td class="memname">void IMpmsm::dfdx_cond           </td>
144          <td>(</td>
145          <td class="paramtype">const vec &amp;&nbsp;</td>
146          <td class="paramname"> <em>x0</em>, </td>
147        </tr>
148        <tr>
149          <td class="paramkey"></td>
150          <td></td>
151          <td class="paramtype">const vec &amp;&nbsp;</td>
152          <td class="paramname"> <em>u0</em>, </td>
153        </tr>
154        <tr>
155          <td class="paramkey"></td>
156          <td></td>
157          <td class="paramtype">mat &amp;&nbsp;</td>
158          <td class="paramname"> <em>A</em>, </td>
159        </tr>
160        <tr>
161          <td class="paramkey"></td>
162          <td></td>
163          <td class="paramtype">bool&nbsp;</td>
164          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
165        </tr>
166        <tr>
167          <td></td>
168          <td>)</td>
169          <td></td><td></td><td><code> [inline, virtual]</code></td>
170        </tr>
171      </table>
172</div>
173<div class="memdoc">
174
175<p>
176Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
177<p>
178<dl compact><dt><b>Parameters:</b></dt><dd>
179  <table border="0" cellspacing="2" cellpadding="0">
180    <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>
181    <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>
182    <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>
183    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
184  </table>
185</dl>
186
187<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
188
189<p>Reimplemented in <a class="el" href="classIMpmsmStat.html#29a9c09fd328e89748d9be0801e84831">IMpmsmStat</a>.</p>
190
191</div>
192</div><p>
193<a class="anchor" name="c3f8dad22ae9855c04a1d593b45c99b5"></a><!-- doxytag: member="IMpmsm::dfdu_cond" ref="c3f8dad22ae9855c04a1d593b45c99b5" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
194<div class="memitem">
195<div class="memproto">
196      <table class="memname">
197        <tr>
198          <td class="memname">void IMpmsm::dfdu_cond           </td>
199          <td>(</td>
200          <td class="paramtype">const vec &amp;&nbsp;</td>
201          <td class="paramname"> <em>x0</em>, </td>
202        </tr>
203        <tr>
204          <td class="paramkey"></td>
205          <td></td>
206          <td class="paramtype">const vec &amp;&nbsp;</td>
207          <td class="paramname"> <em>u0</em>, </td>
208        </tr>
209        <tr>
210          <td class="paramkey"></td>
211          <td></td>
212          <td class="paramtype">mat &amp;&nbsp;</td>
213          <td class="paramname"> <em>A</em>, </td>
214        </tr>
215        <tr>
216          <td class="paramkey"></td>
217          <td></td>
218          <td class="paramtype">bool&nbsp;</td>
219          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
220        </tr>
221        <tr>
222          <td></td>
223          <td>)</td>
224          <td></td><td></td><td><code> [inline, virtual]</code></td>
225        </tr>
226      </table>
227</div>
228<div class="memdoc">
229
230<p>
231Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
232<p>
233<dl compact><dt><b>Parameters:</b></dt><dd>
234  <table border="0" cellspacing="2" cellpadding="0">
235    <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>
236    <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>
237    <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>
238    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
239  </table>
240</dl>
241
242<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
243
244<p>Reimplemented in <a class="el" href="classIMpmsmStat.html#ff740ee20100ae2a2d03a2538638f8e8">IMpmsmStat</a>.</p>
245
246</div>
247</div><p>
248<hr>The documentation for this class was generated from the following file:<ul>
249<li><a class="el" href="pmsm_8h-source.html">pmsm.h</a></ul>
250</div>
251<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 12:16:59 2009 for mixpp by&nbsp;
252<a href="http://www.doxygen.org/index.html">
253<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
254</body>
255</html>
Note: See TracBrowser for help on using the browser.