← 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/IdealTransformer.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/IdealTransformer.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="IdealTransformer">
25
 
  <refnamediv>
26
 
    <refname>IdealTransformer</refname>
27
 
    <refpurpose>Ideal Transformer</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/IdealTransformer.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_IdealTransformer">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="IdealTransformer">Ideal Transformer</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_IdealTransformer">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_IdealTransformer">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_IdealTransformer">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_IdealTransformer">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_IdealTransformer">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <link linkend="IdealTransformer">Modelica model</link>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Example_IdealTransformer">Example</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_IdealTransformer">
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_IdealTransformer">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      The ideal transformer is an ideal two-port resistive circuit element which is characterized by the following two equations:  v1 =  n * v2   i2 = -n * i1  where n is a real number called the turns ratio.
102
 
    </para>
103
 
    <para>
104
 
    </para>
105
 
  </refsection>
106
 
  <refsection id="Dialogbox_IdealTransformer">
107
 
    <title>Dialog box</title>
108
 
    <para>
109
 
      <inlinemediaobject>
110
 
        <imageobject>
111
 
          <imagedata fileref="../../../../images/gui/IdealTransformer_gui.gif" align="center" valign="middle"/>
112
 
        </imageobject>
113
 
      </inlinemediaobject>
114
 
    </para>
115
 
    <para>
116
 
      
117
 
    </para>
118
 
    <itemizedlist>
119
 
      <listitem>
120
 
        <para>
121
 
          <emphasis role="bold">N</emphasis>
122
 
        </para>
123
 
        <para> Turns ratio (N1/N2)</para>
124
 
        <para> Properties : Type 'vec' of size 1.</para>
125
 
      </listitem>
126
 
    </itemizedlist>
127
 
  </refsection>
128
 
  <refsection id="Defaultproperties_IdealTransformer">
129
 
    <title>Default properties</title>
130
 
    <itemizedlist>
131
 
      <listitem>
132
 
        <para>
133
 
          <emphasis role="bold">Inputs :</emphasis>
134
 
        </para>
135
 
        <itemizedlist>
136
 
          <listitem>
137
 
            <para>
138
 
              <emphasis role="bold">Modelica variable name :</emphasis> 'p1'
139
 
            </para>
140
 
            <para>
141
 
              Implicit <emphasis role="bold">variable.</emphasis>
142
 
              
143
 
              
144
 
            </para>
145
 
          </listitem>
146
 
          <listitem>
147
 
            <para>
148
 
              <emphasis role="bold">Modelica variable name :</emphasis> 'n1'
149
 
            </para>
150
 
            <para>
151
 
              Implicit <emphasis role="bold">variable.</emphasis>
152
 
              
153
 
              
154
 
            </para>
155
 
          </listitem>
156
 
          <listitem>
157
 
            <para>
158
 
              <emphasis role="bold">Modelica variable name :</emphasis> 'p2'
159
 
            </para>
160
 
            <para>
161
 
              Implicit <emphasis role="bold">variable.</emphasis>
162
 
              
163
 
              
164
 
            </para>
165
 
          </listitem>
166
 
          <listitem>
167
 
            <para>
168
 
              <emphasis role="bold">Modelica variable name :</emphasis> 'n2'
169
 
            </para>
170
 
            <para>
171
 
              Implicit <emphasis role="bold">variable.</emphasis>
172
 
              
173
 
              
174
 
            </para>
175
 
          </listitem>
176
 
        </itemizedlist>
177
 
      </listitem>
178
 
      <listitem>
179
 
        <para>
180
 
          <emphasis role="bold">Parameters :</emphasis>
181
 
        </para>
182
 
        <itemizedlist>
183
 
          <listitem>
184
 
            <para>
185
 
              <emphasis role="bold">Modelica parameter name :</emphasis> 'N'
186
 
            </para>
187
 
            <para>
188
 
              <emphasis role="bold">Default value :</emphasis> 1
189
 
            </para>
190
 
            <para>
191
 
              <emphasis role="bold">Is a state variable :</emphasis> no.
192
 
              
193
 
              
194
 
            </para>
195
 
          </listitem>
196
 
        </itemizedlist>
197
 
      </listitem>
198
 
      <listitem>
199
 
        <para>
200
 
          <emphasis role="bold">File name of the model :</emphasis> IdealTransformer
201
 
        </para>
202
 
      </listitem>
203
 
    </itemizedlist>
204
 
  </refsection>
205
 
  <refsection id="Interfacingfunction_IdealTransformer">
206
 
    <title>Interfacing function</title>
207
 
    <itemizedlist>
208
 
      <listitem>
209
 
        <para> SCI/modules/scicos_blocks/macros/Electrical/IdealTransformer.sci</para>
210
 
      </listitem>
211
 
    </itemizedlist>
212
 
  </refsection>
213
 
  <refsection id="Modelicamodel_IdealTransformer">
214
 
    <title>Modelica model</title>
215
 
    <itemizedlist>
216
 
      <listitem>
217
 
        <para> SCI/modules/scicos_blocks/macros/Electrical/IdealTransformer.mo</para>
218
 
      </listitem>
219
 
    </itemizedlist>
220
 
  </refsection>
221
 
  <refsection id="Example_IdealTransformer">
222
 
    <title>Example</title>
223
 
    <para>
224
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/electrical_pal/IdealTransformer_Example.xcos">
225
 
        <inlinemediaobject>
226
 
          <imageobject>
227
 
            <imagedata align="center" fileref="../../../examples/electrical_pal/IdealTransformer_Example.png" valign="middle"/>
228
 
          </imageobject>
229
 
        </inlinemediaobject>
230
 
      </link>
231
 
    </para>
232
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>IdealTransformer</refname>
 
27
        <refpurpose>Ideal Transformer</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/IdealTransformer.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_IdealTransformer">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="IdealTransformer">Ideal Transformer</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_IdealTransformer">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_IdealTransformer">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_IdealTransformer">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_IdealTransformer">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_IdealTransformer">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <link linkend="IdealTransformer">Modelica model</link>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Example_IdealTransformer">Example</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_IdealTransformer">
 
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_IdealTransformer">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            The ideal transformer is an ideal two-port resistive circuit element which is characterized by the following two equations:  v1 =  n * v2   i2 = -n * i1  where n is a real number called the turns ratio.
 
102
        </para>
 
103
        <para>
 
104
        </para>
 
105
    </refsection>
 
106
    <refsection id="Dialogbox_IdealTransformer">
 
107
        <title>Dialog box</title>
 
108
        <para>
 
109
            <inlinemediaobject>
 
110
                <imageobject>
 
111
                    <imagedata fileref="../../../../images/gui/IdealTransformer_gui.gif" align="center" valign="middle"/>
 
112
                </imageobject>
 
113
            </inlinemediaobject>
 
114
        </para>
 
115
        <para>
 
116
            
 
117
        </para>
 
118
        <itemizedlist>
 
119
            <listitem>
 
120
                <para>
 
121
                    <emphasis role="bold">N</emphasis>
 
122
                </para>
 
123
                <para> Turns ratio (N1/N2)</para>
 
124
                <para> Properties : Type 'vec' of size 1.</para>
 
125
            </listitem>
 
126
        </itemizedlist>
 
127
    </refsection>
 
128
    <refsection id="Defaultproperties_IdealTransformer">
 
129
        <title>Default properties</title>
 
130
        <itemizedlist>
 
131
            <listitem>
 
132
                <para>
 
133
                    <emphasis role="bold">Inputs :</emphasis>
 
134
                </para>
 
135
                <itemizedlist>
 
136
                    <listitem>
 
137
                        <para>
 
138
                            <emphasis role="bold">Modelica variable name :</emphasis> 'p1'
 
139
                        </para>
 
140
                        <para>
 
141
                            Implicit <emphasis role="bold">variable.</emphasis>
 
142
                            
 
143
                            
 
144
                        </para>
 
145
                    </listitem>
 
146
                    <listitem>
 
147
                        <para>
 
148
                            <emphasis role="bold">Modelica variable name :</emphasis> 'n1'
 
149
                        </para>
 
150
                        <para>
 
151
                            Implicit <emphasis role="bold">variable.</emphasis>
 
152
                            
 
153
                            
 
154
                        </para>
 
155
                    </listitem>
 
156
                    <listitem>
 
157
                        <para>
 
158
                            <emphasis role="bold">Modelica variable name :</emphasis> 'p2'
 
159
                        </para>
 
160
                        <para>
 
161
                            Implicit <emphasis role="bold">variable.</emphasis>
 
162
                            
 
163
                            
 
164
                        </para>
 
165
                    </listitem>
 
166
                    <listitem>
 
167
                        <para>
 
168
                            <emphasis role="bold">Modelica variable name :</emphasis> 'n2'
 
169
                        </para>
 
170
                        <para>
 
171
                            Implicit <emphasis role="bold">variable.</emphasis>
 
172
                            
 
173
                            
 
174
                        </para>
 
175
                    </listitem>
 
176
                </itemizedlist>
 
177
            </listitem>
 
178
            <listitem>
 
179
                <para>
 
180
                    <emphasis role="bold">Parameters :</emphasis>
 
181
                </para>
 
182
                <itemizedlist>
 
183
                    <listitem>
 
184
                        <para>
 
185
                            <emphasis role="bold">Modelica parameter name :</emphasis> 'N'
 
186
                        </para>
 
187
                        <para>
 
188
                            <emphasis role="bold">Default value :</emphasis> 1
 
189
                        </para>
 
190
                        <para>
 
191
                            <emphasis role="bold">Is a state variable :</emphasis> no.
 
192
                            
 
193
                            
 
194
                        </para>
 
195
                    </listitem>
 
196
                </itemizedlist>
 
197
            </listitem>
 
198
            <listitem>
 
199
                <para>
 
200
                    <emphasis role="bold">File name of the model :</emphasis> IdealTransformer
 
201
                </para>
 
202
            </listitem>
 
203
        </itemizedlist>
 
204
    </refsection>
 
205
    <refsection id="Interfacingfunction_IdealTransformer">
 
206
        <title>Interfacing function</title>
 
207
        <itemizedlist>
 
208
            <listitem>
 
209
                <para> SCI/modules/scicos_blocks/macros/Electrical/IdealTransformer.sci</para>
 
210
            </listitem>
 
211
        </itemizedlist>
 
212
    </refsection>
 
213
    <refsection id="Modelicamodel_IdealTransformer">
 
214
        <title>Modelica model</title>
 
215
        <itemizedlist>
 
216
            <listitem>
 
217
                <para> SCI/modules/scicos_blocks/macros/Electrical/IdealTransformer.mo</para>
 
218
            </listitem>
 
219
        </itemizedlist>
 
220
    </refsection>
 
221
    <refsection id="Example_IdealTransformer">
 
222
        <title>Example</title>
 
223
        <para>
 
224
            <link type="scilab" linkend="scilab.xcos/xcos/examples/electrical_pal/IdealTransformer_Example.xcos">
 
225
                <inlinemediaobject>
 
226
                    <imageobject>
 
227
                        <imagedata align="center" fileref="../../../examples/electrical_pal/IdealTransformer_Example.png" valign="middle"/>
 
228
                    </imageobject>
 
229
                </inlinemediaobject>
 
230
            </link>
 
231
        </para>
 
232
    </refsection>
233
233
</refentry>