root/doc/latex/classOMpmsm.tex @ 240

Revision 234, 6.8 kB (checked in by smidl, 15 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classOMpmsm}{
2\section{OMpmsm Class Reference}
3\label{classOMpmsm}\index{OMpmsm@{OMpmsm}}
4}
5Observation model for PMSM drive and its derivative with respect to $x$. 
6
7
8{\tt \#include $<$pmsm.h$>$}
9
10Inheritance diagram for OMpmsm:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=51pt]{classOMpmsm__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for OMpmsm:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=60pt]{classOMpmsm__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}{
28vec \hyperlink{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}{eval} (const vec \&x0, const vec \&u0)}
29\label{classOMpmsm_8e32392c9c635584606287b8c0e8c9da}
30
31\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
32void \hyperlink{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
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 
34\hypertarget{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{
35vec \hyperlink{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{eval} (const vec \&cond)}
36\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}
37
38\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
39virtual void \hyperlink{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
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 
41\hypertarget{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{
42int \hyperlink{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{\_\-dimx} () const }
43\label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}
44
45\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
46\hypertarget{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{
47int \hyperlink{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{\_\-dimu} () const }
48\label{classdiffbifn_fc8779acbff170611aff0ee70cee3879}
49
50\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
51\hypertarget{classfnc_d28babf615a7240c34ee57779250f602}{
52virtual void \hyperlink{classfnc_d28babf615a7240c34ee57779250f602}{condition} (const vec \&val)}
53\label{classfnc_d28babf615a7240c34ee57779250f602}
54
55\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
56\hypertarget{classfnc_a8891973d0ca48ce38e1886df45ca298}{
57int \hyperlink{classfnc_a8891973d0ca48ce38e1886df45ca298}{\_\-dimy} () const }
58\label{classfnc_a8891973d0ca48ce38e1886df45ca298}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
61\subsection*{Protected Attributes}
62\begin{CompactItemize}
63\item 
64\hypertarget{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{
65\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{rvx}}
66\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}
67
68\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
69\hypertarget{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{
70\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{rvu}}
71\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}
72
73\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
74\hypertarget{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{
75int \hyperlink{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{dimx}}
76\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}
77
78\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
79\hypertarget{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{
80int \hyperlink{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{dimu}}
81\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}
82
83\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
84\hypertarget{classfnc_22d51d10a7901331167f64f80d1af8e9}{
85int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}}
86\label{classfnc_22d51d10a7901331167f64f80d1af8e9}
87
88\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
89
90
91\subsection{Detailed Description}
92Observation model for PMSM drive and its derivative with respect to $x$.
93
94\subsection{Member Function Documentation}
95\hypertarget{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}{
96\index{OMpmsm@{OMpmsm}!dfdx\_\-cond@{dfdx\_\-cond}}
97\index{dfdx\_\-cond@{dfdx\_\-cond}!OMpmsm@{OMpmsm}}
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}
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}
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}
108\end{Desc}
109
110
111Reimplemented from \hyperlink{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{diffbifn}.\hypertarget{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{
112\index{OMpmsm@{OMpmsm}!dfdu\_\-cond@{dfdu\_\-cond}}
113\index{dfdu\_\-cond@{dfdu\_\-cond}!OMpmsm@{OMpmsm}}
114\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void 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{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}
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}
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}
124\end{Desc}
125
126
127Reimplemented in \hyperlink{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}{bilinfn}, \hyperlink{classIMk1_2b85f0984da3fe55849bb7b28f66e50c}{IMk1}, \hyperlink{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}{IMpmsm}, and \hyperlink{classIMpmsm2o_27f9d89bce832056f747d985df77a726}{IMpmsm2o}.
128
129The documentation for this class was generated from the following file:\begin{CompactItemize}
130\item 
131work/git/mixpp/pmsm/pmsm.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.