88ab9391c519501b5292584f272f683294ce1fed
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Electrical_pal / Inductor.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"
25         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
26         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
27         xml:id="Inductor" xml:lang="en_US">
28     <refnamediv>
29         <refname>Inductor</refname>
30         <refpurpose>Electrical inductor</refpurpose>
31     </refnamediv>
32     <refsection>
33         <title>Block Screenshot</title>
34         <inlinemediaobject>
35             <imageobject>
36                 <imagedata fileref="../../../../images/palettes/Inductor.png" align="center"/>
37             </imageobject>
38         </inlinemediaobject>
39     </refsection>
40     <refsection id="Contents_Inductor">
41         <title>Contents</title>
42         <itemizedlist>
43             <listitem>
44                 <xref linkend="Description_Inductor">Description</xref>
45             </listitem>
46             <listitem>
47                 <xref linkend="Dialogbox_Inductor">Parameters</xref>
48             </listitem>
49             <listitem>
50                 <xref linkend="Defaultproperties_Inductor">Default properties</xref>
51             </listitem>
52             <listitem>
53                 <xref linkend="Interfacingfunction_Inductor">Interfacing function</xref>
54             </listitem>
55             <listitem>
56                 <xref linkend="Inductor">Modelica model</xref>
57             </listitem>
58         </itemizedlist>
59     </refsection>
60
61     <refsection id="Description_Inductor">
62         <title>Description</title>
63         <para>
64             Inductor is an electrical component that can store energy in
65             electrical circuits.  The relationship between the voltage  across
66             the ports of an inductor of inductance  and the current  passing
67             through it is given by:
68         </para>
69         <latex align="center" alt="v = L.dI/dt"><![CDATA[$$
70         v = L \times \frac{\mathrm d I}{\mathrm d t}
71         $$]]></latex>
72         <para>
73             Inductors can also be used to differentiate between high-frequency and
74             low-frequency signals and this makes them useful in electronic
75             filters. An inductor shows a high impedance for high frequency
76             signals.
77         </para>
78     </refsection>
79     <refsection id="Dialogbox_Inductor">
80         <title>Parameters</title>
81         <inlinemediaobject>
82             <imageobject>
83                 <imagedata fileref="../../../../images/gui/Inductor_gui.gif" align="center" style="float:right"/>
84                 <!-- align => Javahelp, style => Online -->
85             </imageobject>
86         </inlinemediaobject>
87         <itemizedlist>
88             <listitem>
89                 <para>
90                     <emphasis role="bold">L (H)</emphasis>
91                 </para>
92                 <para> Inductance</para>
93                 <para> Properties : Type 'vec' of size 1.</para>
94             </listitem>
95         </itemizedlist>
96     </refsection>
97     <refsection id="Defaultproperties_Inductor">
98         <title>Default properties</title>
99         <itemizedlist>
100             <listitem>
101                 <para>
102                     <emphasis role="bold">Inputs :</emphasis>
103                 </para>
104                 <itemizedlist>
105                     <listitem>
106                         <para>
107                             <emphasis role="bold">Modelica variable name :</emphasis> 'p'
108                         </para>
109                         <para>
110                             Implicit <emphasis role="bold">variable.</emphasis>
111                         </para>
112                     </listitem>
113                 </itemizedlist>
114             </listitem>
115             <listitem>
116                 <para>
117                     <emphasis role="bold">Outputs :</emphasis>
118                 </para>
119                 <itemizedlist>
120                     <listitem>
121                         <para>
122                             <emphasis role="bold">Modelica variable name :</emphasis> 'n'
123                         </para>
124                         <para>
125                             Implicit <emphasis role="bold">variable.</emphasis>
126                         </para>
127                     </listitem>
128                 </itemizedlist>
129             </listitem>
130             <listitem>
131                 <para>
132                     <emphasis role="bold">Parameters :</emphasis>
133                 </para>
134                 <itemizedlist>
135                     <listitem>
136                         <para>
137                             <emphasis role="bold">Modelica parameter name :</emphasis> 'L'
138                         </para>
139                         <para>
140                             <emphasis role="bold">Default value :</emphasis> 0.00001
141                         </para>
142                         <para>
143                             <emphasis role="bold">Is a state variable :</emphasis> no.
144                         </para>
145                     </listitem>
146                 </itemizedlist>
147             </listitem>
148             <listitem>
149                 <para>
150                     <emphasis role="bold">File name of the model :</emphasis> Inductor
151                 </para>
152             </listitem>
153         </itemizedlist>
154         <para/>
155     </refsection>
156     <refsection id="Interfacingfunction_Inductor">
157         <title>Interfacing function</title>
158         <itemizedlist>
159             <listitem>
160                 <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.sci</para>
161             </listitem>
162         </itemizedlist>
163     </refsection>
164     <refsection id="Modelicamodel_Inductor">
165         <title>Modelica model</title>
166         <itemizedlist>
167             <listitem>
168                 <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.mo</para>
169             </listitem>
170         </itemizedlist>
171     </refsection>
172 </refentry>