root/doc/latex/classIMpmsm.tex @ 248

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

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classIMpmsm}{
2\section{IMpmsm Class Reference}
3\label{classIMpmsm}\index{IMpmsm@{IMpmsm}}
4}
5State evolution model for a PMSM drive and its derivative with respect to $x$. 
6
7
8{\tt \#include $<$pmsm.h$>$}
9
10Inheritance diagram for IMpmsm:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=400pt]{classIMpmsm__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for IMpmsm:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=60pt]{classIMpmsm__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classIMpmsm_42818f3426d99fecb7e97be8ffe2e228}{
28void \hyperlink{classIMpmsm_42818f3426d99fecb7e97be8ffe2e228}{set\_\-parameters} (double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)}
29\label{classIMpmsm_42818f3426d99fecb7e97be8ffe2e228}
30
31\begin{CompactList}\small\item\em Set mechanical and electrical variables. \item\end{CompactList}\item 
32\hypertarget{classIMpmsm_45785869d978dda42828a072ec2caebe}{
33vec \hyperlink{classIMpmsm_45785869d978dda42828a072ec2caebe}{eval} (const vec \&x0, const vec \&u0)}
34\label{classIMpmsm_45785869d978dda42828a072ec2caebe}
35
36\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
37void \hyperlink{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
38\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 
39void \hyperlink{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}{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_ad7673e16aa1a046b131b24c731c4632}{
42vec \hyperlink{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{eval} (const vec \&cond)}
43\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}
44
45\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
46\hypertarget{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{
47int \hyperlink{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{\_\-dimx} () const }
48\label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}
49
50\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
51\hypertarget{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{
52int \hyperlink{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{\_\-dimu} () const }
53\label{classdiffbifn_fc8779acbff170611aff0ee70cee3879}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classfnc_d28babf615a7240c34ee57779250f602}{
57virtual void \hyperlink{classfnc_d28babf615a7240c34ee57779250f602}{condition} (const vec \&val)}
58\label{classfnc_d28babf615a7240c34ee57779250f602}
59
60\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
61\hypertarget{classfnc_a8891973d0ca48ce38e1886df45ca298}{
62int \hyperlink{classfnc_a8891973d0ca48ce38e1886df45ca298}{\_\-dimy} () const }
63\label{classfnc_a8891973d0ca48ce38e1886df45ca298}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
66\subsection*{Protected Attributes}
67\begin{CompactItemize}
68\item 
69\hypertarget{classIMpmsm_5908138b6c11f32971542423978a25d3}{
70double \textbf{Rs}}
71\label{classIMpmsm_5908138b6c11f32971542423978a25d3}
72
73\item 
74\hypertarget{classIMpmsm_829e309d689b7e148d761d36b1b62fb7}{
75double \textbf{Ls}}
76\label{classIMpmsm_829e309d689b7e148d761d36b1b62fb7}
77
78\item 
79\hypertarget{classIMpmsm_ec462f3df7355cc72843c945d887b9d3}{
80double \textbf{dt}}
81\label{classIMpmsm_ec462f3df7355cc72843c945d887b9d3}
82
83\item 
84\hypertarget{classIMpmsm_a1b973c18d381e7ec717165aa306b613}{
85double \textbf{Ypm}}
86\label{classIMpmsm_a1b973c18d381e7ec717165aa306b613}
87
88\item 
89\hypertarget{classIMpmsm_03f1857fb1910c7b06dac4ce50482516}{
90double \textbf{kp}}
91\label{classIMpmsm_03f1857fb1910c7b06dac4ce50482516}
92
93\item 
94\hypertarget{classIMpmsm_0eddf56a8feb6b837ee3c36c0ac6b781}{
95double \textbf{p}}
96\label{classIMpmsm_0eddf56a8feb6b837ee3c36c0ac6b781}
97
98\item 
99\hypertarget{classIMpmsm_83e4149bb70b022f3a19208f14eac0e3}{
100double \textbf{J}}
101\label{classIMpmsm_83e4149bb70b022f3a19208f14eac0e3}
102
103\item 
104\hypertarget{classIMpmsm_0aa4f9ee2b9babdc05f62ba275a9575f}{
105double \textbf{Mz}}
106\label{classIMpmsm_0aa4f9ee2b9babdc05f62ba275a9575f}
107
108\item 
109\hypertarget{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{
110\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{rvx}}
111\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}
112
113\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
114\hypertarget{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{
115\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{rvu}}
116\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}
117
118\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
119\hypertarget{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{
120int \hyperlink{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{dimx}}
121\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}
122
123\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
124\hypertarget{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{
125int \hyperlink{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{dimu}}
126\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}
127
128\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
129\hypertarget{classfnc_22d51d10a7901331167f64f80d1af8e9}{
130int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}}
131\label{classfnc_22d51d10a7901331167f64f80d1af8e9}
132
133\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
134
135
136\subsection{Detailed Description}
137State evolution model for a PMSM drive and its derivative with respect to $x$.
138
139\subsection{Member Function Documentation}
140\hypertarget{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}{
141\index{IMpmsm@{IMpmsm}!dfdx\_\-cond@{dfdx\_\-cond}}
142\index{dfdx\_\-cond@{dfdx\_\-cond}!IMpmsm@{IMpmsm}}
143\subsubsection[dfdx\_\-cond]{\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  \mbox{[}inline, virtual\mbox{]}}}}
144\label{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}
145
146
147Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
148
149\begin{Desc}
150\item[Parameters:]
151\begin{description}
152\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}
153\end{Desc}
154
155
156Reimplemented from \hyperlink{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{diffbifn}.\hypertarget{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}{
157\index{IMpmsm@{IMpmsm}!dfdu\_\-cond@{dfdu\_\-cond}}
158\index{dfdu\_\-cond@{dfdu\_\-cond}!IMpmsm@{IMpmsm}}
159\subsubsection[dfdu\_\-cond]{\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  \mbox{[}inline, virtual\mbox{]}}}}
160\label{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}
161
162
163Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
164
165\begin{Desc}
166\item[Parameters:]
167\begin{description}
168\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}
169\end{Desc}
170
171
172Reimplemented from \hyperlink{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{diffbifn}.
173
174The documentation for this class was generated from the following file:\begin{CompactItemize}
175\item 
176work/git/mixpp/pmsm/pmsm.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.