← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/palettes/Electrical_pal/Inductor.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/palettes/Electrical_pal/Inductor.xml
22
22
 * See the file ./license.txt
23
23
 -->
24
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" version="5.0-subset Scilab" xml:id="Inductor">
25
 
  <refnamediv>
26
 
    <refname>Inductor</refname>
27
 
    <refpurpose>Electrical inductor</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/Inductor.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_Inductor">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="Inductor">Electrical inductor</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_Inductor">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_Inductor">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_Inductor">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_Inductor">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_Inductor">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <link linkend="Inductor">Modelica model</link>
77
 
            </para>
78
 
          </listitem>
79
 
        </itemizedlist>
80
 
      </listitem>
81
 
    </itemizedlist>
82
 
  </refsection>
83
 
  <refsection id="Palette_Inductor">
84
 
    <title>Palette</title>
85
 
    <itemizedlist>
86
 
      <listitem>
87
 
        <para>
88
 
          <link linkend="Electrical_pal">Electrical.cosf - Electrical toolbox</link>
89
 
        </para>
90
 
      </listitem>
91
 
    </itemizedlist>
92
 
  </refsection>
93
 
  <refsection id="Description_Inductor">
94
 
    <title>Description</title>
95
 
    <para>
96
 
Inductor is an electrical component that can store energy in
97
 
electrical circuits.  The relationship between the voltage  across
98
 
the ports of an inductor of inductance  and the current  passing
99
 
through it is given by:
100
 
</para>
101
 
    <para>
102
 
</para>
103
 
    <para>
104
 
      <inlinemediaobject>
105
 
        <imageobject>
106
 
          <imagedata fileref="../../../images/Inductor_img5_eng.gif" align="center" valign="middle"/>
107
 
        </imageobject>
108
 
      </inlinemediaobject>
109
 
    </para>
110
 
    <para>
111
 
Inductors can also be used to differentiate between high-frequency and
112
 
low-frequency signals and this makes them useful in electronic
113
 
filters. An inductor shows a high impedance for high frequency
114
 
signals.
115
 
 
116
 
</para>
117
 
  </refsection>
118
 
  <refsection id="Dialogbox_Inductor">
119
 
    <title>Dialog box</title>
120
 
    <para>
121
 
      <inlinemediaobject>
122
 
        <imageobject>
123
 
          <imagedata fileref="../../../../images/gui/Inductor_gui.gif" align="center" valign="middle"/>
124
 
        </imageobject>
125
 
      </inlinemediaobject>
126
 
    </para>
127
 
    <para>
128
 
 
129
 
</para>
130
 
    <itemizedlist>
131
 
      <listitem>
132
 
        <para>
133
 
          <emphasis role="bold">L (H)</emphasis>
134
 
        </para>
135
 
        <para> Inductance</para>
136
 
        <para> Properties : Type 'vec' of size 1.</para>
137
 
      </listitem>
138
 
    </itemizedlist>
139
 
  </refsection>
140
 
  <refsection id="Defaultproperties_Inductor">
141
 
    <title>Default properties</title>
142
 
    <itemizedlist>
143
 
      <listitem>
144
 
        <para>
145
 
          <emphasis role="bold">Inputs :</emphasis>
146
 
        </para>
147
 
        <itemizedlist>
148
 
          <listitem>
149
 
            <para><emphasis role="bold">Modelica variable name :</emphasis> 'p'
150
 
</para>
151
 
            <para>
152
 
Implicit <emphasis role="bold">variable.</emphasis>
153
 
 
154
 
 
155
 
</para>
156
 
          </listitem>
157
 
        </itemizedlist>
158
 
      </listitem>
159
 
      <listitem>
160
 
        <para>
161
 
          <emphasis role="bold">Outputs :</emphasis>
162
 
        </para>
163
 
        <itemizedlist>
164
 
          <listitem>
165
 
            <para><emphasis role="bold">Modelica variable name :</emphasis> 'n'
166
 
</para>
167
 
            <para>
168
 
Implicit <emphasis role="bold">variable.</emphasis>
169
 
 
170
 
 
171
 
</para>
172
 
          </listitem>
173
 
        </itemizedlist>
174
 
      </listitem>
175
 
      <listitem>
176
 
        <para>
177
 
          <emphasis role="bold">Parameters :</emphasis>
178
 
        </para>
179
 
        <itemizedlist>
180
 
          <listitem>
181
 
            <para><emphasis role="bold">Modelica parameter name :</emphasis> 'L'
182
 
</para>
183
 
            <para><emphasis role="bold">Default value :</emphasis> 0.00001
184
 
</para>
185
 
            <para><emphasis role="bold">Is a state variable :</emphasis> no.
186
 
 
187
 
 
188
 
</para>
189
 
          </listitem>
190
 
        </itemizedlist>
191
 
      </listitem>
192
 
      <listitem>
193
 
        <para><emphasis role="bold">File name of the model :</emphasis> Inductor</para>
194
 
      </listitem>
195
 
    </itemizedlist>
196
 
  </refsection>
197
 
  <refsection id="Interfacingfunction_Inductor">
198
 
    <title>Interfacing function</title>
199
 
    <itemizedlist>
200
 
      <listitem>
201
 
        <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.sci</para>
202
 
      </listitem>
203
 
    </itemizedlist>
204
 
  </refsection>
205
 
  <refsection id="Modelicamodel_Inductor">
206
 
    <title>Modelica model</title>
207
 
    <itemizedlist>
208
 
      <listitem>
209
 
        <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.mo</para>
210
 
      </listitem>
211
 
    </itemizedlist>
212
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>Inductor</refname>
 
27
        <refpurpose>Electrical inductor</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/Inductor.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_Inductor">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="Inductor">Electrical inductor</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_Inductor">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_Inductor">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_Inductor">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_Inductor">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_Inductor">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <link linkend="Inductor">Modelica model</link>
 
77
                        </para>
 
78
                    </listitem>
 
79
                </itemizedlist>
 
80
            </listitem>
 
81
        </itemizedlist>
 
82
    </refsection>
 
83
    <refsection id="Palette_Inductor">
 
84
        <title>Palette</title>
 
85
        <itemizedlist>
 
86
            <listitem>
 
87
                <para>
 
88
                    <link linkend="Electrical_pal">Electrical.cosf - Electrical toolbox</link>
 
89
                </para>
 
90
            </listitem>
 
91
        </itemizedlist>
 
92
    </refsection>
 
93
    <refsection id="Description_Inductor">
 
94
        <title>Description</title>
 
95
        <para>
 
96
            Inductor is an electrical component that can store energy in
 
97
            electrical circuits.  The relationship between the voltage  across
 
98
            the ports of an inductor of inductance  and the current  passing
 
99
            through it is given by:
 
100
        </para>
 
101
        <para>
 
102
        </para>
 
103
        <para>
 
104
            <inlinemediaobject>
 
105
                <imageobject>
 
106
                    <imagedata fileref="../../../images/Inductor_img5_eng.gif" align="center" valign="middle"/>
 
107
                </imageobject>
 
108
            </inlinemediaobject>
 
109
        </para>
 
110
        <para>
 
111
            Inductors can also be used to differentiate between high-frequency and
 
112
            low-frequency signals and this makes them useful in electronic
 
113
            filters. An inductor shows a high impedance for high frequency
 
114
            signals.
 
115
            
 
116
        </para>
 
117
    </refsection>
 
118
    <refsection id="Dialogbox_Inductor">
 
119
        <title>Dialog box</title>
 
120
        <para>
 
121
            <inlinemediaobject>
 
122
                <imageobject>
 
123
                    <imagedata fileref="../../../../images/gui/Inductor_gui.gif" align="center" valign="middle"/>
 
124
                </imageobject>
 
125
            </inlinemediaobject>
 
126
        </para>
 
127
        <para>
 
128
            
 
129
        </para>
 
130
        <itemizedlist>
 
131
            <listitem>
 
132
                <para>
 
133
                    <emphasis role="bold">L (H)</emphasis>
 
134
                </para>
 
135
                <para> Inductance</para>
 
136
                <para> Properties : Type 'vec' of size 1.</para>
 
137
            </listitem>
 
138
        </itemizedlist>
 
139
    </refsection>
 
140
    <refsection id="Defaultproperties_Inductor">
 
141
        <title>Default properties</title>
 
142
        <itemizedlist>
 
143
            <listitem>
 
144
                <para>
 
145
                    <emphasis role="bold">Inputs :</emphasis>
 
146
                </para>
 
147
                <itemizedlist>
 
148
                    <listitem>
 
149
                        <para>
 
150
                            <emphasis role="bold">Modelica variable name :</emphasis> 'p'
 
151
                        </para>
 
152
                        <para>
 
153
                            Implicit <emphasis role="bold">variable.</emphasis>
 
154
                            
 
155
                            
 
156
                        </para>
 
157
                    </listitem>
 
158
                </itemizedlist>
 
159
            </listitem>
 
160
            <listitem>
 
161
                <para>
 
162
                    <emphasis role="bold">Outputs :</emphasis>
 
163
                </para>
 
164
                <itemizedlist>
 
165
                    <listitem>
 
166
                        <para>
 
167
                            <emphasis role="bold">Modelica variable name :</emphasis> 'n'
 
168
                        </para>
 
169
                        <para>
 
170
                            Implicit <emphasis role="bold">variable.</emphasis>
 
171
                            
 
172
                            
 
173
                        </para>
 
174
                    </listitem>
 
175
                </itemizedlist>
 
176
            </listitem>
 
177
            <listitem>
 
178
                <para>
 
179
                    <emphasis role="bold">Parameters :</emphasis>
 
180
                </para>
 
181
                <itemizedlist>
 
182
                    <listitem>
 
183
                        <para>
 
184
                            <emphasis role="bold">Modelica parameter name :</emphasis> 'L'
 
185
                        </para>
 
186
                        <para>
 
187
                            <emphasis role="bold">Default value :</emphasis> 0.00001
 
188
                        </para>
 
189
                        <para>
 
190
                            <emphasis role="bold">Is a state variable :</emphasis> no.
 
191
                            
 
192
                            
 
193
                        </para>
 
194
                    </listitem>
 
195
                </itemizedlist>
 
196
            </listitem>
 
197
            <listitem>
 
198
                <para>
 
199
                    <emphasis role="bold">File name of the model :</emphasis> Inductor
 
200
                </para>
 
201
            </listitem>
 
202
        </itemizedlist>
 
203
    </refsection>
 
204
    <refsection id="Interfacingfunction_Inductor">
 
205
        <title>Interfacing function</title>
 
206
        <itemizedlist>
 
207
            <listitem>
 
208
                <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.sci</para>
 
209
            </listitem>
 
210
        </itemizedlist>
 
211
    </refsection>
 
212
    <refsection id="Modelicamodel_Inductor">
 
213
        <title>Modelica model</title>
 
214
        <itemizedlist>
 
215
            <listitem>
 
216
                <para> SCI/modules/scicos_blocks/macros/Electrical/Inductor.mo</para>
 
217
            </listitem>
 
218
        </itemizedlist>
 
219
    </refsection>
213
220
</refentry>