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

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/palettes/Thermohydraulics_pal/PerteDP.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:
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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="PerteDP">
25
 
  <refnamediv>
26
 
    <refname>PerteDP</refname>
27
 
    <refpurpose>Thermal-hydraulic pipe</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata align="center" fileref="../../../../images/palettes/PerteDP.png" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_PerteDP">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="PerteDP">Thermal-hydraulic pipe</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_PerteDP">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_PerteDP">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_PerteDP">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_PerteDP">Default
67
 
                properties
68
 
              </xref>
69
 
            </para>
70
 
          </listitem>
71
 
          <listitem>
72
 
            <para>
73
 
              <xref linkend="Interfacingfunction_PerteDP">Interfacing
74
 
                function
75
 
              </xref>
76
 
            </para>
77
 
          </listitem>
78
 
          <listitem>
79
 
            <para>
80
 
              <link linkend="PerteDP">Modelica model</link>
81
 
            </para>
82
 
          </listitem>
83
 
        </itemizedlist>
84
 
      </listitem>
85
 
    </itemizedlist>
86
 
  </refsection>
87
 
  <refsection id="Palette_PerteDP">
88
 
    <title>Palette</title>
89
 
    <itemizedlist>
90
 
      <listitem>
91
 
        <para>
92
 
          <link linkend="ThermoHydraulics_pal">Thermal-Hydraulics
93
 
            palette
94
 
          </link>
95
 
        </para>
96
 
      </listitem>
97
 
    </itemizedlist>
98
 
  </refsection>
99
 
  <refsection id="Description_PerteDP">
100
 
    <title>Description</title>
101
 
    <para>
102
 
      A <emphasis role="bold">PertDP</emphasis> block represents a
103
 
      hydraulic pipe with linear resistance losses. This component represents a
104
 
      hydraulic resistance and pressure loss is directly proportional to the
105
 
      flow rate. Conventionally, the flow direction is the positive when fluid
106
 
      flows from the black port to the white port. The pressure loss is
107
 
      obtained
108
 
    </para>
109
 
    <para>with</para>
110
 
    <para/>
111
 
    <para>
112
 
      <inlinemediaobject>
113
 
        <imageobject>
114
 
          <imagedata align="center" fileref="../../../../help/images/PerteDP_img2_eng.gif" valign="middle"/>
115
 
        </imageobject>
116
 
      </inlinemediaobject>
117
 
    </para>
118
 
    <para>. The key parameters of this block are the pipes' length, the pipe's
119
 
      diameter, inlet and outlet altitudes, and some other thermal-hydraulic
120
 
      coefficients.
121
 
    </para>
122
 
  </refsection>
123
 
  <refsection id="Dialogbox_PerteDP">
124
 
    <title>Dialog box</title>
125
 
    <para>
126
 
      <inlinemediaobject>
127
 
        <imageobject>
128
 
          <imagedata align="center" fileref="../../../../images/gui/PerteDP_gui.gif" valign="middle"/>
129
 
        </imageobject>
130
 
      </inlinemediaobject>
131
 
    </para>
132
 
    <para/>
133
 
    <itemizedlist>
134
 
      <listitem>
135
 
        <para>
136
 
          <emphasis role="bold">Longueur du tube : L (m)</emphasis>
137
 
        </para>
138
 
        <para>Length of pipe</para>
139
 
        <para>Properties : Type 'vec' of size -1.</para>
140
 
      </listitem>
141
 
      <listitem>
142
 
        <para>
143
 
          <emphasis role="bold">Diamètre interne du tube : D (m)</emphasis>
144
 
        </para>
145
 
        <para>Pipe diameter</para>
146
 
        <para>Properties : Type 'vec' of size -1.</para>
147
 
      </listitem>
148
 
      <listitem>
149
 
        <para>
150
 
          <emphasis role="bold">Coefficient de perte de charge-frottement(S.U)
151
 
            : lambda
152
 
          </emphasis>
153
 
        </para>
154
 
        <para>Coefficient of thermohydraluc resistance</para>
155
 
        <para>Properties : Type 'vec' of size -1.</para>
156
 
      </listitem>
157
 
      <listitem>
158
 
        <para>
159
 
          <emphasis role="bold">Altitude entrée tuyauterie : z1 (m)</emphasis>
160
 
        </para>
161
 
        <para>Altitude of the first port (z1)</para>
162
 
        <para>Properties : Type 'vec' of size -1.</para>
163
 
      </listitem>
164
 
      <listitem>
165
 
        <para>
166
 
          <emphasis role="bold">Altitude sortie tuyauterie : z2 (m)</emphasis>
167
 
        </para>
168
 
        <para>Altitude of the second port (z2)</para>
169
 
        <para>Properties : Type 'vec' of size -1.</para>
170
 
      </listitem>
171
 
      <listitem>
172
 
        <para>
173
 
          <emphasis role="bold">Si 0, masse volumique imposée fu fluide :
174
 
            p_rho (kg/m3)
175
 
          </emphasis>
176
 
        </para>
177
 
        <para>Fluid density</para>
178
 
        <para>Properties : Type 'vec' of size -1.</para>
179
 
      </listitem>
180
 
    </itemizedlist>
181
 
  </refsection>
182
 
  <refsection id="Defaultproperties_PerteDP">
183
 
    <title>Default properties</title>
184
 
    <itemizedlist>
185
 
      <listitem>
186
 
        <para>
187
 
          <emphasis role="bold">Inputs :</emphasis>
188
 
        </para>
189
 
        <itemizedlist>
190
 
          <listitem>
191
 
            <para>
192
 
              <emphasis role="bold">Modelica variable name :</emphasis>
193
 
              'C1'
194
 
            </para>
195
 
            <para>
196
 
              Implicit <emphasis role="bold">variable.</emphasis>
197
 
            </para>
198
 
          </listitem>
199
 
        </itemizedlist>
200
 
      </listitem>
201
 
      <listitem>
202
 
        <para>
203
 
          <emphasis role="bold">Outputs :</emphasis>
204
 
        </para>
205
 
        <itemizedlist>
206
 
          <listitem>
207
 
            <para>
208
 
              <emphasis role="bold">Modelica variable name :</emphasis>
209
 
              'C2'
210
 
            </para>
211
 
            <para>
212
 
              Implicit <emphasis role="bold">variable.</emphasis>
213
 
            </para>
214
 
          </listitem>
215
 
        </itemizedlist>
216
 
      </listitem>
217
 
      <listitem>
218
 
        <para>
219
 
          <emphasis role="bold">Parameters :</emphasis>
220
 
        </para>
221
 
        <itemizedlist>
222
 
          <listitem>
223
 
            <para>
224
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
225
 
              'L'
226
 
            </para>
227
 
            <para>
228
 
              <emphasis role="bold">Default value :</emphasis> 10
229
 
            </para>
230
 
            <para>
231
 
              <emphasis role="bold">Is a state variable :</emphasis>
232
 
              no.
233
 
            </para>
234
 
          </listitem>
235
 
          <listitem>
236
 
            <para>
237
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
238
 
              'D'
239
 
            </para>
240
 
            <para>
241
 
              <emphasis role="bold">Default value :</emphasis> 0.2
242
 
            </para>
243
 
            <para>
244
 
              <emphasis role="bold">Is a state variable :</emphasis>
245
 
              no.
246
 
            </para>
247
 
          </listitem>
248
 
          <listitem>
249
 
            <para>
250
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
251
 
              'lambda'
252
 
            </para>
253
 
            <para>
254
 
              <emphasis role="bold">Default value :</emphasis> 0.03
255
 
            </para>
256
 
            <para>
257
 
              <emphasis role="bold">Is a state variable :</emphasis>
258
 
              no.
259
 
            </para>
260
 
          </listitem>
261
 
          <listitem>
262
 
            <para>
263
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
264
 
              'z1'
265
 
            </para>
266
 
            <para>
267
 
              <emphasis role="bold">Default value :</emphasis> 0
268
 
            </para>
269
 
            <para>
270
 
              <emphasis role="bold">Is a state variable :</emphasis>
271
 
              no.
272
 
            </para>
273
 
          </listitem>
274
 
          <listitem>
275
 
            <para>
276
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
277
 
              'z2'
278
 
            </para>
279
 
            <para>
280
 
              <emphasis role="bold">Default value :</emphasis> 0
281
 
            </para>
282
 
            <para>
283
 
              <emphasis role="bold">Is a state variable :</emphasis>
284
 
              no.
285
 
            </para>
286
 
          </listitem>
287
 
          <listitem>
288
 
            <para>
289
 
              <emphasis role="bold">Modelica parameter name :</emphasis>
290
 
              'p_rho'
291
 
            </para>
292
 
            <para>
293
 
              <emphasis role="bold">Default value :</emphasis> 0
294
 
            </para>
295
 
            <para>
296
 
              <emphasis role="bold">Is a state variable :</emphasis>
297
 
              no.
298
 
            </para>
299
 
          </listitem>
300
 
        </itemizedlist>
301
 
      </listitem>
302
 
      <listitem>
303
 
        <para>
304
 
          <emphasis role="bold">File name of the model :</emphasis>
305
 
          PerteDP
306
 
        </para>
307
 
      </listitem>
308
 
    </itemizedlist>
309
 
  </refsection>
310
 
  <refsection id="Interfacingfunction_PerteDP">
311
 
    <title>Interfacing function</title>
312
 
    <itemizedlist>
313
 
      <listitem>
314
 
        <para>SCI/modules/scicos_blocks/macros/Hydraulics/PerteDP.sci</para>
315
 
      </listitem>
316
 
    </itemizedlist>
317
 
  </refsection>
318
 
  <refsection id="Modelicamodel_PerteDP">
319
 
    <title>Modelica model</title>
320
 
    <itemizedlist>
321
 
      <listitem>
322
 
        <para>SCI/modules/scicos_blocks/macros/Hydraulics/PerteDP.mo</para>
323
 
      </listitem>
324
 
    </itemizedlist>
325
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>PerteDP</refname>
 
27
        <refpurpose>Thermal-hydraulic pipe</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata align="center" fileref="../../../../images/palettes/PerteDP.png" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_PerteDP">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="PerteDP">Thermal-hydraulic pipe</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_PerteDP">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_PerteDP">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_PerteDP">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_PerteDP">Default
 
67
                                properties
 
68
                            </xref>
 
69
                        </para>
 
70
                    </listitem>
 
71
                    <listitem>
 
72
                        <para>
 
73
                            <xref linkend="Interfacingfunction_PerteDP">Interfacing
 
74
                                function
 
75
                            </xref>
 
76
                        </para>
 
77
                    </listitem>
 
78
                    <listitem>
 
79
                        <para>
 
80
                            <link linkend="PerteDP">Modelica model</link>
 
81
                        </para>
 
82
                    </listitem>
 
83
                </itemizedlist>
 
84
            </listitem>
 
85
        </itemizedlist>
 
86
    </refsection>
 
87
    <refsection id="Palette_PerteDP">
 
88
        <title>Palette</title>
 
89
        <itemizedlist>
 
90
            <listitem>
 
91
                <para>
 
92
                    <link linkend="ThermoHydraulics_pal">Thermal-Hydraulics
 
93
                        palette
 
94
                    </link>
 
95
                </para>
 
96
            </listitem>
 
97
        </itemizedlist>
 
98
    </refsection>
 
99
    <refsection id="Description_PerteDP">
 
100
        <title>Description</title>
 
101
        <para>
 
102
            A <emphasis role="bold">PertDP</emphasis> block represents a
 
103
            hydraulic pipe with linear resistance losses. This component represents a
 
104
            hydraulic resistance and pressure loss is directly proportional to the
 
105
            flow rate. Conventionally, the flow direction is the positive when fluid
 
106
            flows from the black port to the white port. The pressure loss is
 
107
            obtained
 
108
        </para>
 
109
        <para>with</para>
 
110
        <para/>
 
111
        <para>
 
112
            <inlinemediaobject>
 
113
                <imageobject>
 
114
                    <imagedata align="center" fileref="../../../../help/images/PerteDP_img2_eng.gif" valign="middle"/>
 
115
                </imageobject>
 
116
            </inlinemediaobject>
 
117
        </para>
 
118
        <para>. The key parameters of this block are the pipes' length, the pipe's
 
119
            diameter, inlet and outlet altitudes, and some other thermal-hydraulic
 
120
            coefficients.
 
121
        </para>
 
122
    </refsection>
 
123
    <refsection id="Dialogbox_PerteDP">
 
124
        <title>Dialog box</title>
 
125
        <para>
 
126
            <inlinemediaobject>
 
127
                <imageobject>
 
128
                    <imagedata align="center" fileref="../../../../images/gui/PerteDP_gui.gif" valign="middle"/>
 
129
                </imageobject>
 
130
            </inlinemediaobject>
 
131
        </para>
 
132
        <para/>
 
133
        <itemizedlist>
 
134
            <listitem>
 
135
                <para>
 
136
                    <emphasis role="bold">Longueur du tube : L (m)</emphasis>
 
137
                </para>
 
138
                <para>Length of pipe</para>
 
139
                <para>Properties : Type 'vec' of size -1.</para>
 
140
            </listitem>
 
141
            <listitem>
 
142
                <para>
 
143
                    <emphasis role="bold">Diamètre interne du tube : D (m)</emphasis>
 
144
                </para>
 
145
                <para>Pipe diameter</para>
 
146
                <para>Properties : Type 'vec' of size -1.</para>
 
147
            </listitem>
 
148
            <listitem>
 
149
                <para>
 
150
                    <emphasis role="bold">Coefficient de perte de charge-frottement(S.U)
 
151
                        : lambda
 
152
                    </emphasis>
 
153
                </para>
 
154
                <para>Coefficient of thermohydraluc resistance</para>
 
155
                <para>Properties : Type 'vec' of size -1.</para>
 
156
            </listitem>
 
157
            <listitem>
 
158
                <para>
 
159
                    <emphasis role="bold">Altitude entrée tuyauterie : z1 (m)</emphasis>
 
160
                </para>
 
161
                <para>Altitude of the first port (z1)</para>
 
162
                <para>Properties : Type 'vec' of size -1.</para>
 
163
            </listitem>
 
164
            <listitem>
 
165
                <para>
 
166
                    <emphasis role="bold">Altitude sortie tuyauterie : z2 (m)</emphasis>
 
167
                </para>
 
168
                <para>Altitude of the second port (z2)</para>
 
169
                <para>Properties : Type 'vec' of size -1.</para>
 
170
            </listitem>
 
171
            <listitem>
 
172
                <para>
 
173
                    <emphasis role="bold">Si 0, masse volumique imposée fu fluide :
 
174
                        p_rho (kg/m3)
 
175
                    </emphasis>
 
176
                </para>
 
177
                <para>Fluid density</para>
 
178
                <para>Properties : Type 'vec' of size -1.</para>
 
179
            </listitem>
 
180
        </itemizedlist>
 
181
    </refsection>
 
182
    <refsection id="Defaultproperties_PerteDP">
 
183
        <title>Default properties</title>
 
184
        <itemizedlist>
 
185
            <listitem>
 
186
                <para>
 
187
                    <emphasis role="bold">Inputs :</emphasis>
 
188
                </para>
 
189
                <itemizedlist>
 
190
                    <listitem>
 
191
                        <para>
 
192
                            <emphasis role="bold">Modelica variable name :</emphasis>
 
193
                            'C1'
 
194
                        </para>
 
195
                        <para>
 
196
                            Implicit <emphasis role="bold">variable.</emphasis>
 
197
                        </para>
 
198
                    </listitem>
 
199
                </itemizedlist>
 
200
            </listitem>
 
201
            <listitem>
 
202
                <para>
 
203
                    <emphasis role="bold">Outputs :</emphasis>
 
204
                </para>
 
205
                <itemizedlist>
 
206
                    <listitem>
 
207
                        <para>
 
208
                            <emphasis role="bold">Modelica variable name :</emphasis>
 
209
                            'C2'
 
210
                        </para>
 
211
                        <para>
 
212
                            Implicit <emphasis role="bold">variable.</emphasis>
 
213
                        </para>
 
214
                    </listitem>
 
215
                </itemizedlist>
 
216
            </listitem>
 
217
            <listitem>
 
218
                <para>
 
219
                    <emphasis role="bold">Parameters :</emphasis>
 
220
                </para>
 
221
                <itemizedlist>
 
222
                    <listitem>
 
223
                        <para>
 
224
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
225
                            'L'
 
226
                        </para>
 
227
                        <para>
 
228
                            <emphasis role="bold">Default value :</emphasis> 10
 
229
                        </para>
 
230
                        <para>
 
231
                            <emphasis role="bold">Is a state variable :</emphasis>
 
232
                            no.
 
233
                        </para>
 
234
                    </listitem>
 
235
                    <listitem>
 
236
                        <para>
 
237
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
238
                            'D'
 
239
                        </para>
 
240
                        <para>
 
241
                            <emphasis role="bold">Default value :</emphasis> 0.2
 
242
                        </para>
 
243
                        <para>
 
244
                            <emphasis role="bold">Is a state variable :</emphasis>
 
245
                            no.
 
246
                        </para>
 
247
                    </listitem>
 
248
                    <listitem>
 
249
                        <para>
 
250
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
251
                            'lambda'
 
252
                        </para>
 
253
                        <para>
 
254
                            <emphasis role="bold">Default value :</emphasis> 0.03
 
255
                        </para>
 
256
                        <para>
 
257
                            <emphasis role="bold">Is a state variable :</emphasis>
 
258
                            no.
 
259
                        </para>
 
260
                    </listitem>
 
261
                    <listitem>
 
262
                        <para>
 
263
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
264
                            'z1'
 
265
                        </para>
 
266
                        <para>
 
267
                            <emphasis role="bold">Default value :</emphasis> 0
 
268
                        </para>
 
269
                        <para>
 
270
                            <emphasis role="bold">Is a state variable :</emphasis>
 
271
                            no.
 
272
                        </para>
 
273
                    </listitem>
 
274
                    <listitem>
 
275
                        <para>
 
276
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
277
                            'z2'
 
278
                        </para>
 
279
                        <para>
 
280
                            <emphasis role="bold">Default value :</emphasis> 0
 
281
                        </para>
 
282
                        <para>
 
283
                            <emphasis role="bold">Is a state variable :</emphasis>
 
284
                            no.
 
285
                        </para>
 
286
                    </listitem>
 
287
                    <listitem>
 
288
                        <para>
 
289
                            <emphasis role="bold">Modelica parameter name :</emphasis>
 
290
                            'p_rho'
 
291
                        </para>
 
292
                        <para>
 
293
                            <emphasis role="bold">Default value :</emphasis> 0
 
294
                        </para>
 
295
                        <para>
 
296
                            <emphasis role="bold">Is a state variable :</emphasis>
 
297
                            no.
 
298
                        </para>
 
299
                    </listitem>
 
300
                </itemizedlist>
 
301
            </listitem>
 
302
            <listitem>
 
303
                <para>
 
304
                    <emphasis role="bold">File name of the model :</emphasis>
 
305
                    PerteDP
 
306
                </para>
 
307
            </listitem>
 
308
        </itemizedlist>
 
309
    </refsection>
 
310
    <refsection id="Interfacingfunction_PerteDP">
 
311
        <title>Interfacing function</title>
 
312
        <itemizedlist>
 
313
            <listitem>
 
314
                <para>SCI/modules/scicos_blocks/macros/Hydraulics/PerteDP.sci</para>
 
315
            </listitem>
 
316
        </itemizedlist>
 
317
    </refsection>
 
318
    <refsection id="Modelicamodel_PerteDP">
 
319
        <title>Modelica model</title>
 
320
        <itemizedlist>
 
321
            <listitem>
 
322
                <para>SCI/modules/scicos_blocks/macros/Hydraulics/PerteDP.mo</para>
 
323
            </listitem>
 
324
        </itemizedlist>
 
325
    </refsection>
326
326
</refentry>