root/doc/latex/classOMpmsm.tex @ 280

Revision 280, 6.7 kB (checked in by smidl, 16 years ago)

progress...

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