root/doc/latex/classIMpmsm.tex @ 97

Revision 91, 5.7 kB (checked in by smidl, 17 years ago)

drobnosti a dokumentace

  • Property svn:eol-style set to native
Line 
1\section{IMpmsm Class Reference}
2\label{classIMpmsm}\index{IMpmsm@{IMpmsm}}
3State evolution model for a PMSM drive and its derivative with respect to \$x\$
4
5
6{\tt \#include $<$pmsm.h$>$}
7
8Inheritance diagram for IMpmsm:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=58pt]{classIMpmsm__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for IMpmsm:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=60pt]{classIMpmsm__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25void {\bf set\_\-parameters} (double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)\label{classIMpmsm_42818f3426d99fecb7e97be8ffe2e228}
26
27\begin{CompactList}\small\item\em Set mechanical and electrical variables. \item\end{CompactList}\item 
28vec {\bf eval} (const vec \&x0, const vec \&u0)\label{classIMpmsm_45785869d978dda42828a072ec2caebe}
29
30\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
31void {\bf dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
32\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 
33void {\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 
35vec {\bf eval} (const vec \&cond)\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}
36
37\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
38int {\bf \_\-dimx} () const \label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}
39
40\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
41int {\bf \_\-dimu} () const \label{classdiffbifn_fc8779acbff170611aff0ee70cee3879}
42
43\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
44int {\bf \_\-dimy} () const \label{classfnc_a8891973d0ca48ce38e1886df45ca298}
45
46\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
47\subsection*{Protected Attributes}
48\begin{CompactItemize}
49\item 
50double \textbf{Rs}\label{classIMpmsm_5908138b6c11f32971542423978a25d3}
51
52\item 
53double \textbf{Ls}\label{classIMpmsm_829e309d689b7e148d761d36b1b62fb7}
54
55\item 
56double \textbf{dt}\label{classIMpmsm_ec462f3df7355cc72843c945d887b9d3}
57
58\item 
59double \textbf{Ypm}\label{classIMpmsm_a1b973c18d381e7ec717165aa306b613}
60
61\item 
62double \textbf{kp}\label{classIMpmsm_03f1857fb1910c7b06dac4ce50482516}
63
64\item 
65double \textbf{p}\label{classIMpmsm_0eddf56a8feb6b837ee3c36c0ac6b781}
66
67\item 
68double \textbf{J}\label{classIMpmsm_83e4149bb70b022f3a19208f14eac0e3}
69
70\item 
71double \textbf{Mz}\label{classIMpmsm_0aa4f9ee2b9babdc05f62ba275a9575f}
72
73\item 
74{\bf RV} {\bf rvx}\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}
75
76\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
77{\bf RV} {\bf rvu}\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}
78
79\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
80int {\bf dimx}\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}
81
82\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
83int {\bf dimu}\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}
84
85\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
86int {\bf dimy}\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}
92State evolution model for a PMSM drive and its derivative with respect to \$x\$.
93
94\subsection{Member Function Documentation}
95\index{IMpmsm@{IMpmsm}!dfdx\_\-cond@{dfdx\_\-cond}}
96\index{dfdx\_\-cond@{dfdx\_\-cond}!IMpmsm@{IMpmsm}}
97\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void IMpmsm::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{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}
98
99
100Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
101
102\begin{Desc}
103\item[Parameters:]
104\begin{description}
105\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}
106\end{Desc}
107
108
109Reimplemented from {\bf diffbifn} \doxyref{}{p.}{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}.\index{IMpmsm@{IMpmsm}!dfdu\_\-cond@{dfdu\_\-cond}}
110\index{dfdu\_\-cond@{dfdu\_\-cond}!IMpmsm@{IMpmsm}}
111\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void IMpmsm::dfdu\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}
112
113
114Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
115
116\begin{Desc}
117\item[Parameters:]
118\begin{description}
119\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}
120\end{Desc}
121
122
123Reimplemented from {\bf diffbifn} \doxyref{}{p.}{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}.
124
125The documentation for this class was generated from the following file:\begin{CompactItemize}
126\item 
127work/mixpp/pmsm/pmsm.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.