root/doc/latex/classIMpmsm2o.tex @ 246

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

doc

Line 
1\hypertarget{classIMpmsm2o}{
2\section{IMpmsm2o Class Reference}
3\label{classIMpmsm2o}\index{IMpmsm2o@{IMpmsm2o}}
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 IMpmsm2o:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=56pt]{classIMpmsm2o__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for IMpmsm2o:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=60pt]{classIMpmsm2o__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classIMpmsm2o_abdefc0467678a05abf12f5c77eaf49d}{
28void \hyperlink{classIMpmsm2o_abdefc0467678a05abf12f5c77eaf49d}{set\_\-parameters} (double Rs0, double Ls0, double dt0, double Ypm0, double kp0, double p0, double J0, double Mz0)}
29\label{classIMpmsm2o_abdefc0467678a05abf12f5c77eaf49d}
30
31\begin{CompactList}\small\item\em Set mechanical and electrical variables. \item\end{CompactList}\item 
32\hypertarget{classIMpmsm2o_86e04b5118e567ea7a2540059f553f41}{
33vec \hyperlink{classIMpmsm2o_86e04b5118e567ea7a2540059f553f41}{eval} (const vec \&x0, const vec \&u0)}
34\label{classIMpmsm2o_86e04b5118e567ea7a2540059f553f41}
35
36\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
37void \hyperlink{classIMpmsm2o_0a3e125df1e53821e08accbd4960d713}{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{classIMpmsm2o_27f9d89bce832056f747d985df77a726}{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{classIMpmsm2o_a6514cda776819b65fd9e41a1a6a798c}{
70double \textbf{Rs}}
71\label{classIMpmsm2o_a6514cda776819b65fd9e41a1a6a798c}
72
73\item 
74\hypertarget{classIMpmsm2o_bef34361d7602b1a75c5b9f701bce40f}{
75double \textbf{Ls}}
76\label{classIMpmsm2o_bef34361d7602b1a75c5b9f701bce40f}
77
78\item 
79\hypertarget{classIMpmsm2o_399e2df590d6425a01e47c6deaa7e838}{
80double \textbf{dt}}
81\label{classIMpmsm2o_399e2df590d6425a01e47c6deaa7e838}
82
83\item 
84\hypertarget{classIMpmsm2o_99af79af69627fae52ec8fa8e167f775}{
85double \textbf{Ypm}}
86\label{classIMpmsm2o_99af79af69627fae52ec8fa8e167f775}
87
88\item 
89\hypertarget{classIMpmsm2o_993cf4903bce863c6b7fb2355411db4a}{
90double \textbf{kp}}
91\label{classIMpmsm2o_993cf4903bce863c6b7fb2355411db4a}
92
93\item 
94\hypertarget{classIMpmsm2o_8644abe49171d006cbf9bff2844816a3}{
95double \textbf{p}}
96\label{classIMpmsm2o_8644abe49171d006cbf9bff2844816a3}
97
98\item 
99\hypertarget{classIMpmsm2o_01a151f4ec2818e39537bebcbb8b152d}{
100double \textbf{J}}
101\label{classIMpmsm2o_01a151f4ec2818e39537bebcbb8b152d}
102
103\item 
104\hypertarget{classIMpmsm2o_38253f515b9b35ab3a536f4871287025}{
105double \textbf{Mz}}
106\label{classIMpmsm2o_38253f515b9b35ab3a536f4871287025}
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{classIMpmsm2o_0a3e125df1e53821e08accbd4960d713}{
141\index{IMpmsm2o@{IMpmsm2o}!dfdx\_\-cond@{dfdx\_\-cond}}
142\index{dfdx\_\-cond@{dfdx\_\-cond}!IMpmsm2o@{IMpmsm2o}}
143\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void IMpmsm2o::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{classIMpmsm2o_0a3e125df1e53821e08accbd4960d713}
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{classIMpmsm2o_27f9d89bce832056f747d985df77a726}{
157\index{IMpmsm2o@{IMpmsm2o}!dfdu\_\-cond@{dfdu\_\-cond}}
158\index{dfdu\_\-cond@{dfdu\_\-cond}!IMpmsm2o@{IMpmsm2o}}
159\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void IMpmsm2o::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{classIMpmsm2o_27f9d89bce832056f747d985df77a726}
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.