root/doc/html/classOMpmsm.html @ 261

Revision 261, 15.5 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: OMpmsm 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>OMpmsm Class Reference<br>
30<small>
31[<a class="el" href="group__PMSM.html">PMSM</a>]</small>
32</h1><!-- doxytag: class="OMpmsm" --><!-- doxytag: inherits="bdm::diffbifn" -->Observation model for 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 OMpmsm:</div>
39<div class="dynsection">
40<p><center><img src="classOMpmsm__inherit__graph.png" border="0" usemap="#OMpmsm__inherit__map" alt="Inheritance graph"></center>
41<map name="OMpmsm__inherit__map">
42<area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="12,161,111,188"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
43<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
44<div class="dynheader">
45Collaboration diagram for OMpmsm:</div>
46<div class="dynsection">
47<p><center><img src="classOMpmsm__coll__graph.png" border="0" usemap="#OMpmsm__coll__map" alt="Collaboration graph"></center>
48<map name="OMpmsm__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="classOMpmsm-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="8e32392c9c635584606287b8c0e8c9da"></a><!-- doxytag: member="OMpmsm::eval" ref="8e32392c9c635584606287b8c0e8c9da" args="(const vec &amp;x0, const vec &amp;u0)" -->
57vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOMpmsm.html#8e32392c9c635584606287b8c0e8c9da">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOMpmsm.html#b75b5fd55b2ac5ed74b5b953af122821">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
61
62<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="#b75b5fd55b2ac5ed74b5b953af122821"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188f31066bd72e1bf0ddacd1eb0e6af3"></a><!-- doxytag: member="OMpmsm::eval" ref="188f31066bd72e1bf0ddacd1eb0e6af3" args="(const vec &amp;cond)" -->
64vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
65
66<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>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">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="#6ea1dc7a482601b29c5ba36a52d20d07"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="OMpmsm::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
71int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="OMpmsm::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
75int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</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="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="OMpmsm::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
79virtual 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>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="OMpmsm::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
83int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_dimy</a> () const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
86<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="OMpmsm::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
88RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#5f56547d8e9378b669d3cc19d7831cbb">rvx</a></td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="OMpmsm::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
92RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a8e3e861d5ec2a7ae9524e6338e58320">rvu</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="OMpmsm::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
96int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="OMpmsm::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
100int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="OMpmsm::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
107</table>
108<hr><a name="_details"></a><h2>Detailed Description</h2>
109Observation model for PMSM drive and its derivative with respect to <img class="formulaInl" alt="$x$" src="form_28.png">. <hr><h2>Member Function Documentation</h2>
110<a class="anchor" name="b75b5fd55b2ac5ed74b5b953af122821"></a><!-- doxytag: member="OMpmsm::dfdx_cond" ref="b75b5fd55b2ac5ed74b5b953af122821" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
111<div class="memitem">
112<div class="memproto">
113      <table class="memname">
114        <tr>
115          <td class="memname">void OMpmsm::dfdx_cond           </td>
116          <td>(</td>
117          <td class="paramtype">const vec &amp;&nbsp;</td>
118          <td class="paramname"> <em>x0</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">const vec &amp;&nbsp;</td>
124          <td class="paramname"> <em>u0</em>, </td>
125        </tr>
126        <tr>
127          <td class="paramkey"></td>
128          <td></td>
129          <td class="paramtype">mat &amp;&nbsp;</td>
130          <td class="paramname"> <em>A</em>, </td>
131        </tr>
132        <tr>
133          <td class="paramkey"></td>
134          <td></td>
135          <td class="paramtype">bool&nbsp;</td>
136          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
137        </tr>
138        <tr>
139          <td></td>
140          <td>)</td>
141          <td></td><td></td><td><code> [inline, virtual]</code></td>
142        </tr>
143      </table>
144</div>
145<div class="memdoc">
146
147<p>
148Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
149<p>
150<dl compact><dt><b>Parameters:</b></dt><dd>
151  <table border="0" cellspacing="2" cellpadding="0">
152    <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>
153    <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>
154    <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>
155    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
156  </table>
157</dl>
158
159<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
160
161</div>
162</div><p>
163<a class="anchor" name="6ea1dc7a482601b29c5ba36a52d20d07"></a><!-- doxytag: member="OMpmsm::dfdu_cond" ref="6ea1dc7a482601b29c5ba36a52d20d07" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
164<div class="memitem">
165<div class="memproto">
166      <table class="memname">
167        <tr>
168          <td class="memname">virtual void bdm::diffbifn::dfdu_cond           </td>
169          <td>(</td>
170          <td class="paramtype">const vec &amp;&nbsp;</td>
171          <td class="paramname"> <em>x0</em>, </td>
172        </tr>
173        <tr>
174          <td class="paramkey"></td>
175          <td></td>
176          <td class="paramtype">const vec &amp;&nbsp;</td>
177          <td class="paramname"> <em>u0</em>, </td>
178        </tr>
179        <tr>
180          <td class="paramkey"></td>
181          <td></td>
182          <td class="paramtype">mat &amp;&nbsp;</td>
183          <td class="paramname"> <em>A</em>, </td>
184        </tr>
185        <tr>
186          <td class="paramkey"></td>
187          <td></td>
188          <td class="paramtype">bool&nbsp;</td>
189          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
190        </tr>
191        <tr>
192          <td></td>
193          <td>)</td>
194          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
195        </tr>
196      </table>
197</div>
198<div class="memdoc">
199
200<p>
201Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
202<p>
203<dl compact><dt><b>Parameters:</b></dt><dd>
204  <table border="0" cellspacing="2" cellpadding="0">
205    <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>
206    <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>
207    <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>
208    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
209  </table>
210</dl>
211
212<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>, <a class="el" href="classIMk1.html#2b85f0984da3fe55849bb7b28f66e50c">IMk1</a>, <a class="el" href="classIMpmsm.html#c3f8dad22ae9855c04a1d593b45c99b5">IMpmsm</a>, <a class="el" href="classIMpmsm2o.html#27f9d89bce832056f747d985df77a726">IMpmsm2o</a>, and <a class="el" href="classIMpmsmStat.html#ff740ee20100ae2a2d03a2538638f8e8">IMpmsmStat</a>.</p>
213
214</div>
215</div><p>
216<hr>The documentation for this class was generated from the following file:<ul>
217<li><a class="el" href="pmsm_8h-source.html">pmsm.h</a></ul>
218</div>
219<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 12:16:59 2009 for mixpp by&nbsp;
220<a href="http://www.doxygen.org/index.html">
221<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
222</body>
223</html>
Note: See TracBrowser for help on using the browser.