root/doc/latex/classOMpmsm.tex @ 255

Revision 255, 7.1 kB (checked in by smidl, 16 years ago)

doc

  • Property svn:eol-style set to native
RevLine 
[172]1\hypertarget{classOMpmsm}{
[33]2\section{OMpmsm Class Reference}
3\label{classOMpmsm}\index{OMpmsm@{OMpmsm}}
[172]4}
[145]5Observation model for PMSM drive and its derivative with respect to $x$
[33]6
7
8{\tt \#include $<$pmsm.h$>$}
9
10Inheritance diagram for OMpmsm:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
[255]14\includegraphics[width=59pt]{classOMpmsm__inherit__graph}
[33]15\end{center}
16\end{figure}
17Collaboration diagram for OMpmsm:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
[255]21\includegraphics[width=88pt]{classOMpmsm__coll__graph}
[33]22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
[172]27\hypertarget{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}{
28vec \hyperlink{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}{eval} (const vec \&x0, const vec \&u0)}
29\label{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}
[33]30
[91]31\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
[172]32void \hyperlink{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
[33]33\begin{CompactList}\small\item\em Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} . \item\end{CompactList}\item 
[255]34\hypertarget{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{
35vec \hyperlink{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{eval} (const vec \&cond)}
36\label{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}
[33]37
[91]38\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
[255]39virtual void \hyperlink{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
[33]40\begin{CompactList}\small\item\em Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} . \item\end{CompactList}\item 
[255]41\hypertarget{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{
42int \hyperlink{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{\_\-dimx} () const }
43\label{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}
[33]44
45\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
[255]46\hypertarget{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{
47int \hyperlink{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{\_\-dimu} () const }
48\label{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}
[33]49
50\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
[255]51\hypertarget{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{
52virtual void \hyperlink{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{condition} (const vec \&val)}
53\label{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}
[224]54
55\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
[255]56\hypertarget{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{
57int \hyperlink{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{\_\-dimy} () const }
58\label{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}
[33]59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
61\subsection*{Protected Attributes}
62\begin{CompactItemize}
63\item 
[255]64\hypertarget{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{
65RV \hyperlink{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{rvx}}
66\label{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}
[33]67
68\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
[255]69\hypertarget{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{
70RV \hyperlink{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{rvu}}
71\label{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}
[33]72
73\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
[255]74\hypertarget{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{
75int \hyperlink{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{dimx}}
76\label{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}
[33]77
78\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
[255]79\hypertarget{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{
80int \hyperlink{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{dimu}}
81\label{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}
[33]82
83\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
[255]84\hypertarget{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{
85int \hyperlink{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{dimy}}
86\label{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}
[33]87
88\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
89
90
91\subsection{Detailed Description}
[145]92Observation model for PMSM drive and its derivative with respect to $x$.
[33]93
94\subsection{Member Function Documentation}
[172]95\hypertarget{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}{
[91]96\index{OMpmsm@{OMpmsm}!dfdx\_\-cond@{dfdx\_\-cond}}
97\index{dfdx\_\-cond@{dfdx\_\-cond}!OMpmsm@{OMpmsm}}
[172]98\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void OMpmsm::dfdx\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
99\label{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}
[33]100
101
102Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
103
104\begin{Desc}
105\item[Parameters:]
106\begin{description}
[91]107\item[{\em full}]denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. \item[{\em x0}]numeric value of $x$, \item[{\em u0}]numeric value of $u$ \item[{\em A}]a place where the result will be stored. \end{description}
[33]108\end{Desc}
109
110
[255]111Reimplemented from \hyperlink{classbdm_1_1diffbifn_651184f808a35f236dbfea21aca1b6ac}{bdm::diffbifn}.\hypertarget{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}{
[172]112\index{OMpmsm@{OMpmsm}!dfdu\_\-cond@{dfdu\_\-cond}}
[91]113\index{dfdu\_\-cond@{dfdu\_\-cond}!OMpmsm@{OMpmsm}}
[255]114\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void bdm::diffbifn::dfdu\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
115\label{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}
[33]116
117
118Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
119
120\begin{Desc}
121\item[Parameters:]
122\begin{description}
[91]123\item[{\em full}]denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. \item[{\em x0}]numeric value of $x$, \item[{\em u0}]numeric value of $u$ \item[{\em A}]a place where the result will be stored. \end{description}
[33]124\end{Desc}
125
126
[255]127Reimplemented in \hyperlink{classbdm_1_1bilinfn_9cfe2f1c115ba7c3c75849a10a4f2c08}{bdm::bilinfn}, \hyperlink{classIMk1_2b85f0984da3fe55849bb7b28f66e50c}{IMk1}, \hyperlink{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}{IMpmsm}, \hyperlink{classIMpmsm2o_27f9d89bce832056f747d985df77a726}{IMpmsm2o}, and \hyperlink{classIMpmsmStat_ff740ee20100ae2a2d03a2538638f8e8}{IMpmsmStat}.
[33]128
129The documentation for this class was generated from the following file:\begin{CompactItemize}
130\item 
[145]131work/git/mixpp/pmsm/pmsm.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.