root/doc/latex/classIMpmsm.tex @ 280

Revision 280, 8.1 kB (checked in by smidl, 16 years ago)

progress...

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