a00258ad4da96c6ef4e72ff28906212e6deb1e35
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Electrical_pal / PNP.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="PNP">
25     <refnamediv>
26         <refname>PNP</refname>
27         <refpurpose>PNP transistor</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/PNP.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_PNP">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="PNP">PNP transistor</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_PNP">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_PNP">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_PNP">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_PNP">Default properties</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Interfacingfunction_PNP">Interfacing function</xref>
72                         </para>
73                     </listitem>
74                     <listitem>
75                         <para>
76                             <link linkend="PNP">Modelica model</link>
77                         </para>
78                     </listitem>
79                     <listitem>
80                         <para>
81                             <xref linkend="Seealso_PNP">See also</xref>
82                         </para>
83                     </listitem>
84                 </itemizedlist>
85             </listitem>
86         </itemizedlist>
87     </refsection>
88     <refsection id="Palette_PNP">
89         <title>Palette</title>
90         <itemizedlist>
91             <listitem>
92                 <para>
93                     <link linkend="Electrical_pal">Electrical.cosf - Electrical toolbox</link>
94                 </para>
95             </listitem>
96         </itemizedlist>
97     </refsection>
98     <refsection id="Description_PNP">
99         <title>Description</title>
100         <para>
101             This model is a simple model of a bipolar PNP junction transistor according to Ebers-Moll.  
102         </para>
103         <para>
104         </para>
105     </refsection>
106     <refsection id="Dialogbox_PNP">
107         <title>Dialog box</title>
108         <para>
109             <inlinemediaobject>
110                 <imageobject>
111                     <imagedata fileref="../../../../images/gui/PNP_gui.gif" align="center" valign="middle"/>
112                 </imageobject>
113             </inlinemediaobject>
114         </para>
115         <para>
116         </para>
117         <para>
118         </para>
119         <informaltable border="1" cellpadding="3">
120             <tr>
121                 <td align="left">Parameter</td>
122                 <td align="left">Default value</td>
123                 <td align="left">Description</td>
124             </tr>
125             <tr>
126                 <td align="left">Bf</td>
127                 <td align="left">50</td>
128                 <td align="left">Forward beta</td>
129             </tr>
130             <tr>
131                 <td align="left">Br</td>
132                 <td align="left">0.1</td>
133                 <td align="left">Reverse beta</td>
134             </tr>
135             <tr>
136                 <td align="left">Is</td>
137                 <td align="left">1.e-16</td>
138                 <td align="left">Transport saturation current [A]</td>
139             </tr>
140             <tr>
141                 <td align="left">Vak</td>
142                 <td align="left">0.02</td>
143                 <td align="left">Early voltage (inverse), 1/Volt [1/V]</td>
144             </tr>
145             <tr>
146                 <td align="left">Tauf</td>
147                 <td align="left">0.12e-9</td>
148                 <td align="left">Ideal forward transit time [s]</td>
149             </tr>
150             <tr>
151                 <td align="left">Taur</td>
152                 <td align="left">5e-9</td>
153                 <td align="left">Ideal reverse transit time [s]</td>
154             </tr>
155             <tr>
156                 <td align="left">Ccs</td>
157                 <td align="left">1e-12</td>
158                 <td align="left">Collector-substrat(ground) cap. [F]</td>
159             </tr>
160             <tr>
161                 <td align="left">Cje</td>
162                 <td align="left">0.4e-12</td>
163                 <td align="left">Base-emitter zero bias depletion cap. [F]</td>
164             </tr>
165             <tr>
166                 <td align="left">Cjc</td>
167                 <td align="left">0.5e-12</td>
168                 <td align="left">Base-coll. zero bias depletion cap. [F]</td>
169             </tr>
170             <tr>
171                 <td align="left">Phie</td>
172                 <td align="left">0.8</td>
173                 <td align="left">Base-emitter diffusion voltage [V]</td>
174             </tr>
175             <tr>
176                 <td align="left">Me</td>
177                 <td align="left">0.4</td>
178                 <td align="left">Base-emitter gradation exponent</td>
179             </tr>
180             <tr>
181                 <td align="left">Phic</td>
182                 <td align="left">0.8</td>
183                 <td align="left">Base-collector diffusion voltage [V]</td>
184             </tr>
185             <tr>
186                 <td align="left">Mc</td>
187                 <td align="left">0.333</td>
188                 <td align="left">Base-collector gradation exponent</td>
189             </tr>
190             <tr>
191                 <td align="left">Gbc</td>
192                 <td align="left">1e-15</td>
193                 <td align="left">Base-collector conductance [S]</td>
194             </tr>
195             <tr>
196                 <td align="left">Gbe</td>
197                 <td align="left">1e-15</td>
198                 <td align="left">Base-emitter conductance [S]</td>
199             </tr>
200             <tr>
201                 <td align="left">Vt</td>
202                 <td align="left">0.02585</td>
203                 <td align="left">Voltage equivalent of temperature [V]</td>
204             </tr>
205             <tr>
206                 <td align="left">EMin</td>
207                 <td align="left">-100</td>
208                 <td align="left">if x &lt; EMin, the exp(x) function is linearized</td>
209             </tr>
210             <tr>
211                 <td align="left">EMax</td>
212                 <td align="left">40</td>
213                 <td align="left">if x &gt; EMax, the exp(x) function is linearized</td>
214             </tr>
215         </informaltable>
216     </refsection>
217     <refsection id="Defaultproperties_PNP">
218         <title>Default properties</title>
219         <itemizedlist>
220             <listitem>
221                 <para>
222                     <emphasis role="bold">Inputs :</emphasis>
223                 </para>
224                 <itemizedlist>
225                     <listitem>
226                         <para>
227                             <emphasis role="bold">Modelica variable name :</emphasis> 'B'
228                         </para>
229                         <para>
230                             Implicit <emphasis role="bold">variable.</emphasis>
231                             
232                             
233                         </para>
234                     </listitem>
235                 </itemizedlist>
236             </listitem>
237             <listitem>
238                 <para>
239                     <emphasis role="bold">Outputs :</emphasis>
240                 </para>
241                 <itemizedlist>
242                     <listitem>
243                         <para>
244                             <emphasis role="bold">Modelica variable name :</emphasis> 'C'
245                         </para>
246                         <para>
247                             Implicit <emphasis role="bold">variable.</emphasis>
248                             
249                             
250                         </para>
251                     </listitem>
252                     <listitem>
253                         <para>
254                             <emphasis role="bold">Modelica variable name :</emphasis> 'E'
255                         </para>
256                         <para>
257                             Implicit <emphasis role="bold">variable.</emphasis>
258                             
259                             
260                         </para>
261                     </listitem>
262                 </itemizedlist>
263             </listitem>
264             <listitem>
265                 <para>
266                     <emphasis role="bold">Parameters :</emphasis>
267                 </para>
268                 <itemizedlist>
269                     <listitem>
270                         <para>
271                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Bf'
272                         </para>
273                         <para>
274                             <emphasis role="bold">Default value :</emphasis> 50
275                         </para>
276                         <para>
277                             <emphasis role="bold">Is a state variable :</emphasis> no.
278                             
279                             
280                         </para>
281                     </listitem>
282                     <listitem>
283                         <para>
284                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Br'
285                         </para>
286                         <para>
287                             <emphasis role="bold">Default value :</emphasis> 0.1
288                         </para>
289                         <para>
290                             <emphasis role="bold">Is a state variable :</emphasis> no.
291                             
292                             
293                         </para>
294                     </listitem>
295                     <listitem>
296                         <para>
297                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Is'
298                         </para>
299                         <para>
300                             <emphasis role="bold">Default value :</emphasis> 0
301                         </para>
302                         <para>
303                             <emphasis role="bold">Is a state variable :</emphasis> no.
304                             
305                             
306                         </para>
307                     </listitem>
308                     <listitem>
309                         <para>
310                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Vak'
311                         </para>
312                         <para>
313                             <emphasis role="bold">Default value :</emphasis> 0.02
314                         </para>
315                         <para>
316                             <emphasis role="bold">Is a state variable :</emphasis> no.
317                             
318                             
319                         </para>
320                     </listitem>
321                     <listitem>
322                         <para>
323                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Tauf'
324                         </para>
325                         <para>
326                             <emphasis role="bold">Default value :</emphasis> 1.200E-10
327                         </para>
328                         <para>
329                             <emphasis role="bold">Is a state variable :</emphasis> no.
330                             
331                             
332                         </para>
333                     </listitem>
334                     <listitem>
335                         <para>
336                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Taur'
337                         </para>
338                         <para>
339                             <emphasis role="bold">Default value :</emphasis> 5.000E-09
340                         </para>
341                         <para>
342                             <emphasis role="bold">Is a state variable :</emphasis> no.
343                             
344                             
345                         </para>
346                     </listitem>
347                     <listitem>
348                         <para>
349                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Ccs'
350                         </para>
351                         <para>
352                             <emphasis role="bold">Default value :</emphasis> 1.000E-12
353                         </para>
354                         <para>
355                             <emphasis role="bold">Is a state variable :</emphasis> no.
356                             
357                             
358                         </para>
359                     </listitem>
360                     <listitem>
361                         <para>
362                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Cje'
363                         </para>
364                         <para>
365                             <emphasis role="bold">Default value :</emphasis> 4.000E-13
366                         </para>
367                         <para>
368                             <emphasis role="bold">Is a state variable :</emphasis> no.
369                             
370                             
371                         </para>
372                     </listitem>
373                     <listitem>
374                         <para>
375                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Cjc'
376                         </para>
377                         <para>
378                             <emphasis role="bold">Default value :</emphasis> 5.000E-13
379                         </para>
380                         <para>
381                             <emphasis role="bold">Is a state variable :</emphasis> no.
382                             
383                             
384                         </para>
385                     </listitem>
386                     <listitem>
387                         <para>
388                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Phie'
389                         </para>
390                         <para>
391                             <emphasis role="bold">Default value :</emphasis> 0.8
392                         </para>
393                         <para>
394                             <emphasis role="bold">Is a state variable :</emphasis> no.
395                             
396                             
397                         </para>
398                     </listitem>
399                     <listitem>
400                         <para>
401                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Me'
402                         </para>
403                         <para>
404                             <emphasis role="bold">Default value :</emphasis> 0.4
405                         </para>
406                         <para>
407                             <emphasis role="bold">Is a state variable :</emphasis> no.
408                             
409                             
410                         </para>
411                     </listitem>
412                     <listitem>
413                         <para>
414                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Phic'
415                         </para>
416                         <para>
417                             <emphasis role="bold">Default value :</emphasis> 0.8
418                         </para>
419                         <para>
420                             <emphasis role="bold">Is a state variable :</emphasis> no.
421                             
422                             
423                         </para>
424                     </listitem>
425                     <listitem>
426                         <para>
427                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Mc'
428                         </para>
429                         <para>
430                             <emphasis role="bold">Default value :</emphasis> 0.333
431                         </para>
432                         <para>
433                             <emphasis role="bold">Is a state variable :</emphasis> no.
434                             
435                             
436                         </para>
437                     </listitem>
438                     <listitem>
439                         <para>
440                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Gbc'
441                         </para>
442                         <para>
443                             <emphasis role="bold">Default value :</emphasis> 1.000E-15
444                         </para>
445                         <para>
446                             <emphasis role="bold">Is a state variable :</emphasis> no.
447                             
448                             
449                         </para>
450                     </listitem>
451                     <listitem>
452                         <para>
453                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Gbe'
454                         </para>
455                         <para>
456                             <emphasis role="bold">Default value :</emphasis> 1.000E-15
457                         </para>
458                         <para>
459                             <emphasis role="bold">Is a state variable :</emphasis> no.
460                             
461                             
462                         </para>
463                     </listitem>
464                     <listitem>
465                         <para>
466                             <emphasis role="bold">Modelica parameter name :</emphasis> 'Vt'
467                         </para>
468                         <para>
469                             <emphasis role="bold">Default value :</emphasis> 0.02585
470                         </para>
471                         <para>
472                             <emphasis role="bold">Is a state variable :</emphasis> no.
473                             
474                             
475                         </para>
476                     </listitem>
477                     <listitem>
478                         <para>
479                             <emphasis role="bold">Modelica parameter name :</emphasis> 'EMinMax'
480                         </para>
481                         <para>
482                             <emphasis role="bold">Default value :</emphasis> 40
483                         </para>
484                         <para>
485                             <emphasis role="bold">Is a state variable :</emphasis> no.
486                             
487                             
488                         </para>
489                     </listitem>
490                 </itemizedlist>
491             </listitem>
492             <listitem>
493                 <para>
494                     <emphasis role="bold">File name of the model :</emphasis> PNP
495                 </para>
496             </listitem>
497         </itemizedlist>
498     </refsection>
499     <refsection id="Interfacingfunction_PNP">
500         <title>Interfacing function</title>
501         <itemizedlist>
502             <listitem>
503                 <para> SCI/modules/scicos_blocks/macros/Electrical/PNP.sci</para>
504             </listitem>
505         </itemizedlist>
506     </refsection>
507     <refsection id="Modelicamodel_PNP">
508         <title>Modelica model</title>
509         <itemizedlist>
510             <listitem>
511                 <para> SCI/modules/scicos_blocks/macros/Electrical/PNP.mo</para>
512             </listitem>
513         </itemizedlist>
514     </refsection>
515     <refsection id="Seealso_PNP">
516         <title>See also</title>
517         <itemizedlist>
518             <listitem>
519                 <para>
520                     <link linkend="NPN">NPN - NPN transistor</link>
521                 </para>
522             </listitem>
523         </itemizedlist>
524     </refsection>
525 </refentry>