root/doc/latex/classOMpmsm.tex @ 157

Revision 145, 4.9 kB (checked in by smidl, 16 years ago)

Oprava dokumentace

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