root/doc/html/classIMpmsm.html @ 255

Revision 255, 18.3 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 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>IMpmsm Class Reference<br>
28<small>
29[<a class="el" href="group__PMSM.html">PMSM</a>]</small>
30</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">. 
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 IMpmsm:</div>
37<div class="dynsection">
38<p><center><img src="classIMpmsm__inherit__graph.png" border="0" usemap="#IMpmsm__inherit__map" alt="Inheritance graph"></center>
39<map name="IMpmsm__inherit__map">
40<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_1base.html" title="Root class of BDM objects." alt="" coords="155,7,243,33"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
43Collaboration diagram for IMpmsm:</div>
44<div class="dynsection">
45<p><center><img src="classIMpmsm__coll__graph.png" border="0" usemap="#IMpmsm__coll__map" alt="Collaboration graph"></center>
46<map name="IMpmsm__coll__map">
47<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_1base.html" title="Root class of BDM objects." alt="" coords="57,7,145,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="107,87,181,113"></map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
51<a href="classIMpmsm-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="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)" -->
55void&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>
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="45785869d978dda42828a072ec2caebe"></a><!-- doxytag: member="IMpmsm::eval" ref="45785869d978dda42828a072ec2caebe" args="(const vec &amp;x0, const vec &amp;u0)" -->
59vec&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>
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="classIMpmsm.html#b4378b5d3bf64c683e4cf5c5f1cd56f1">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="#b4378b5d3bf64c683e4cf5c5f1cd56f1"></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="classIMpmsm.html#c3f8dad22ae9855c04a1d593b45c99b5">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="#c3f8dad22ae9855c04a1d593b45c99b5"></a><br></td></tr>
68<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)" -->
69vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">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="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="IMpmsm::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
73int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_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="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="IMpmsm::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
77int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_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="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="IMpmsm::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
81virtual 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>
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="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="IMpmsm::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
85int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_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="5908138b6c11f32971542423978a25d3"></a><!-- doxytag: member="IMpmsm::Rs" ref="5908138b6c11f32971542423978a25d3" 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="829e309d689b7e148d761d36b1b62fb7"></a><!-- doxytag: member="IMpmsm::Ls" ref="829e309d689b7e148d761d36b1b62fb7" 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="ec462f3df7355cc72843c945d887b9d3"></a><!-- doxytag: member="IMpmsm::dt" ref="ec462f3df7355cc72843c945d887b9d3" 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="a1b973c18d381e7ec717165aa306b613"></a><!-- doxytag: member="IMpmsm::Ypm" ref="a1b973c18d381e7ec717165aa306b613" 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="03f1857fb1910c7b06dac4ce50482516"></a><!-- doxytag: member="IMpmsm::kp" ref="03f1857fb1910c7b06dac4ce50482516" 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="0eddf56a8feb6b837ee3c36c0ac6b781"></a><!-- doxytag: member="IMpmsm::p" ref="0eddf56a8feb6b837ee3c36c0ac6b781" 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="83e4149bb70b022f3a19208f14eac0e3"></a><!-- doxytag: member="IMpmsm::J" ref="83e4149bb70b022f3a19208f14eac0e3" 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="0aa4f9ee2b9babdc05f62ba275a9575f"></a><!-- doxytag: member="IMpmsm::Mz" ref="0aa4f9ee2b9babdc05f62ba275a9575f" 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="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="IMpmsm::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
114RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#5f56547d8e9378b669d3cc19d7831cbb">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="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="IMpmsm::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
118RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a8e3e861d5ec2a7ae9524e6338e58320">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="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="IMpmsm::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
122int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">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="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="IMpmsm::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
126int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">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="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="IMpmsm::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">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="b4378b5d3bf64c683e4cf5c5f1cd56f1"></a><!-- doxytag: member="IMpmsm::dfdx_cond" ref="b4378b5d3bf64c683e4cf5c5f1cd56f1" 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 IMpmsm::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="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
186
187<p>Reimplemented in <a class="el" href="classIMpmsmStat.html#29a9c09fd328e89748d9be0801e84831">IMpmsmStat</a>.</p>
188
189</div>
190</div><p>
191<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)" -->
192<div class="memitem">
193<div class="memproto">
194      <table class="memname">
195        <tr>
196          <td class="memname">void IMpmsm::dfdu_cond           </td>
197          <td>(</td>
198          <td class="paramtype">const vec &amp;&nbsp;</td>
199          <td class="paramname"> <em>x0</em>, </td>
200        </tr>
201        <tr>
202          <td class="paramkey"></td>
203          <td></td>
204          <td class="paramtype">const vec &amp;&nbsp;</td>
205          <td class="paramname"> <em>u0</em>, </td>
206        </tr>
207        <tr>
208          <td class="paramkey"></td>
209          <td></td>
210          <td class="paramtype">mat &amp;&nbsp;</td>
211          <td class="paramname"> <em>A</em>, </td>
212        </tr>
213        <tr>
214          <td class="paramkey"></td>
215          <td></td>
216          <td class="paramtype">bool&nbsp;</td>
217          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
218        </tr>
219        <tr>
220          <td></td>
221          <td>)</td>
222          <td></td><td></td><td><code> [inline, virtual]</code></td>
223        </tr>
224      </table>
225</div>
226<div class="memdoc">
227
228<p>
229Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
230<p>
231<dl compact><dt><b>Parameters:</b></dt><dd>
232  <table border="0" cellspacing="2" cellpadding="0">
233    <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>
234    <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>
235    <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>
236    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
237  </table>
238</dl>
239
240<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
241
242<p>Reimplemented in <a class="el" href="classIMpmsmStat.html#ff740ee20100ae2a2d03a2538638f8e8">IMpmsmStat</a>.</p>
243
244</div>
245</div><p>
246<hr>The documentation for this class was generated from the following file:<ul>
247<li>work/git/mixpp/pmsm/<a class="el" href="pmsm_8h-source.html">pmsm.h</a></ul>
248</div>
249<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:30:26 2009 for mixpp by&nbsp;
250<a href="http://www.doxygen.org/index.html">
251<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
252</body>
253</html>
Note: See TracBrowser for help on using the browser.