-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpfd_8py.html
497 lines (468 loc) · 23.4 KB
/
pfd_8py.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<!-- HTML header for doxygen 1.8.16-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>The Brown Book: /home/kai/PythonPrograms/PooPyLab_Project/PooPyLab/utils/pfd.py File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">The Brown Book
</div>
<div id="projectbrief">Documentation for the PooPyLab project</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('pfd_8py.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pfd.py File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacepfd"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepfd.html">pfd</a></td></tr>
<tr class="memdesc:namespacepfd"><td class="mdescLeft"> </td><td class="mdescRight">Global functions for process flow diagram related operations. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a28cac22e9e2fd3f75b33eff26683bdd1"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a28cac22e9e2fd3f75b33eff26683bdd1">PooPyLab.utils.pfd._check_connection</a> (pfd=[])</td></tr>
<tr class="memdesc:a28cac22e9e2fd3f75b33eff26683bdd1"><td class="mdescLeft"> </td><td class="mdescRight">Check the validity of connections on the process flow diagram. <a href="pfd_8py.html#a28cac22e9e2fd3f75b33eff26683bdd1">More...</a><br /></td></tr>
<tr class="separator:a28cac22e9e2fd3f75b33eff26683bdd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16de22d65a189511aab84f1d979cc9f8"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a16de22d65a189511aab84f1d979cc9f8">PooPyLab.utils.pfd._id_upstream_type</a> (me, upds)</td></tr>
<tr class="memdesc:a16de22d65a189511aab84f1d979cc9f8"><td class="mdescLeft"> </td><td class="mdescRight">Identify the type of a discharger connected to the inlet. <a href="pfd_8py.html#a16de22d65a189511aab84f1d979cc9f8">More...</a><br /></td></tr>
<tr class="separator:a16de22d65a189511aab84f1d979cc9f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b6bbbe52a17fc0f9af5b0168f46d59a"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a6b6bbbe52a17fc0f9af5b0168f46d59a">PooPyLab.utils.pfd._check_WAS</a> (mywas)</td></tr>
<tr class="memdesc:a6b6bbbe52a17fc0f9af5b0168f46d59a"><td class="mdescLeft"> </td><td class="mdescRight">Check the validity of the WAS units in the pfd. <a href="pfd_8py.html#a6b6bbbe52a17fc0f9af5b0168f46d59a">More...</a><br /></td></tr>
<tr class="separator:a6b6bbbe52a17fc0f9af5b0168f46d59a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ceaf6244ef24f896a9ab58bd0a86339"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a0ceaf6244ef24f896a9ab58bd0a86339">PooPyLab.utils.pfd._check_sidestream_flows</a> (mysplitters)</td></tr>
<tr class="memdesc:a0ceaf6244ef24f896a9ab58bd0a86339"><td class="mdescLeft"> </td><td class="mdescRight">Check the validity of the sidestreams of all splitter types. <a href="pfd_8py.html#a0ceaf6244ef24f896a9ab58bd0a86339">More...</a><br /></td></tr>
<tr class="separator:a0ceaf6244ef24f896a9ab58bd0a86339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3deea3c5ae461de68d9e8c7781acf2f5"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a3deea3c5ae461de68d9e8c7781acf2f5">PooPyLab.utils.pfd._find_main_only_prefix</a> (cur, pms)</td></tr>
<tr class="memdesc:a3deea3c5ae461de68d9e8c7781acf2f5"><td class="mdescLeft"> </td><td class="mdescRight">Find the mainstream only loop in the PFD. <a href="pfd_8py.html#a3deea3c5ae461de68d9e8c7781acf2f5">More...</a><br /></td></tr>
<tr class="separator:a3deea3c5ae461de68d9e8c7781acf2f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ceec14a3193b891048db27c2e2cd162"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a8ceec14a3193b891048db27c2e2cd162">PooPyLab.utils.pfd._has_main_only_loops</a> (pfd)</td></tr>
<tr class="memdesc:a8ceec14a3193b891048db27c2e2cd162"><td class="mdescLeft"> </td><td class="mdescRight">Analyze a PFD and see whether it has a loop only via mainstream outlets. <a href="pfd_8py.html#a8ceec14a3193b891048db27c2e2cd162">More...</a><br /></td></tr>
<tr class="separator:a8ceec14a3193b891048db27c2e2cd162"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39d8aeda43a210d22ca0366b32aa919a"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#a39d8aeda43a210d22ca0366b32aa919a">PooPyLab.utils.pfd.get_all_units</a> (wwtp, type='ASMReactor')</td></tr>
<tr class="memdesc:a39d8aeda43a210d22ca0366b32aa919a"><td class="mdescLeft"> </td><td class="mdescRight">Return all the units of a specific type in a treatment plant PFD. <a href="pfd_8py.html#a39d8aeda43a210d22ca0366b32aa919a">More...</a><br /></td></tr>
<tr class="separator:a39d8aeda43a210d22ca0366b32aa919a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa12a29c03088cc81d947aa5dabcaf0eb"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#aa12a29c03088cc81d947aa5dabcaf0eb">PooPyLab.utils.pfd.check</a> (wwtp)</td></tr>
<tr class="memdesc:aa12a29c03088cc81d947aa5dabcaf0eb"><td class="mdescLeft"> </td><td class="mdescRight">Check the validity of the PFD against the rules. <a href="pfd_8py.html#aa12a29c03088cc81d947aa5dabcaf0eb">More...</a><br /></td></tr>
<tr class="separator:aa12a29c03088cc81d947aa5dabcaf0eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaef3bca0561511d17e25fbe21bf3ff69"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="pfd_8py.html#aaef3bca0561511d17e25fbe21bf3ff69">PooPyLab.utils.pfd.show</a> (wwtp=[])</td></tr>
<tr class="memdesc:aaef3bca0561511d17e25fbe21bf3ff69"><td class="mdescLeft"> </td><td class="mdescRight">Show the verbal description of the PFD. <a href="pfd_8py.html#aaef3bca0561511d17e25fbe21bf3ff69">More...</a><br /></td></tr>
<tr class="separator:aaef3bca0561511d17e25fbe21bf3ff69"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a28cac22e9e2fd3f75b33eff26683bdd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28cac22e9e2fd3f75b33eff26683bdd1">◆ </a></span>_check_connection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._check_connection </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>pfd</em> = <code>[]</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the validity of connections on the process flow diagram. </p>
<p>All units are connected for their main- and sidestream outlets other than the exceptions made in initializations. This function checks and count the loose ends found in the PFD.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pfd</td><td>Process Flow Diagram (list of all unit processes in the WWTP);</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd><div class="fragment"><div class="line"><span class="comment"># of loose ends (int)</span></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a16de22d65a189511aab84f1d979cc9f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16de22d65a189511aab84f1d979cc9f8">◆ </a></span>_id_upstream_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._id_upstream_type </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>me</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>upds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Identify the type of a discharger connected to the inlet. </p>
<p>This function identifies the type of an upstream discharger (upds) of (me)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">me</td><td>a process unit </td></tr>
<tr><td class="paramname">upds</td><td>an upstream discharger of "me"</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>strings such as {'VOID'|'INFLUENT'|'SPLITTER_MAIN'|'SPLITTER_SIDE'} </dd></dl>
</div>
</div>
<a id="a6b6bbbe52a17fc0f9af5b0168f46d59a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b6bbbe52a17fc0f9af5b0168f46d59a">◆ </a></span>_check_WAS()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._check_WAS </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>mywas</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the validity of the WAS units in the pfd. </p>
<dl class="section user"><dt>Rules</dt><dd>1) A WAS unit shall connect w/ a splitter's sidestream via ONE pipe; </dd></dl>
<dl class="section user"><dt></dt><dd>2) Only 0 or 1 WAS can connect to an SRT controlling splitter;</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mywas</td><td>the WAS unit under analysis</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>Whether the WAS connection is valid (bool), </dd></dl>
<dl class="section user"><dt></dt><dd>The SRT controlling splitter connected to this WAS unit </dd></dl>
</div>
</div>
<a id="a0ceaf6244ef24f896a9ab58bd0a86339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ceaf6244ef24f896a9ab58bd0a86339">◆ </a></span>_check_sidestream_flows()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._check_sidestream_flows </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>mysplitters</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the validity of the sidestreams of all splitter types. </p>
<dl class="section user"><dt>Rules</dt><dd>1) Sidestream flows shall be defined by user; </dd></dl>
<dl class="section user"><dt></dt><dd>2) SRT controlling splitters or final_clarifiers are exempted from 1); </dd></dl>
<dl class="section user"><dt></dt><dd>3) A final clarifier's sidestream flow is determined during runtime; </dd></dl>
<dl class="section user"><dt></dt><dd>4) The main loop shall update its side outlet or main outlet flows.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mysplitters</td><td>Splitters to be checked;</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd><div class="fragment"><div class="line">total <span class="comment"># of sidestreams with undefined flow rates (int)</span></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a3deea3c5ae461de68d9e8c7781acf2f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3deea3c5ae461de68d9e8c7781acf2f5">◆ </a></span>_find_main_only_prefix()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._find_main_only_prefix </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>pms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the mainstream only loop in the PFD. </p>
<dl class="section user"><dt>Rules</dt><dd>1) A recycle/recirculation (loop) shall be via a splitter sidestream;</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cur</td><td>current process unit; </td></tr>
<tr><td class="paramname">pms</td><td>list of mainstream units (prefixes) leading to "cur".</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>bool</dd></dl>
<dl class="section user"><dt>See</dt><dd><a class="el" href="pfd_8py.html#a8ceec14a3193b891048db27c2e2cd162" title="Analyze a PFD and see whether it has a loop only via mainstream outlets.">_has_main_only_loops()</a>. </dd></dl>
</div>
</div>
<a id="a8ceec14a3193b891048db27c2e2cd162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ceec14a3193b891048db27c2e2cd162">◆ </a></span>_has_main_only_loops()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd._has_main_only_loops </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>pfd</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Analyze a PFD and see whether it has a loop only via mainstream outlets. </p>
<dl class="section user"><dt>Rule</dt><dd>1) Loops with mainstreams only are not allowed in the PFD</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pfd</td><td>Process Flow Diagram (list of process units in the WWTP);</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>bool</dd></dl>
<dl class="section user"><dt>See</dt><dd><a class="el" href="pfd_8py.html#a3deea3c5ae461de68d9e8c7781acf2f5" title="Find the mainstream only loop in the PFD.">_find_main_only_prefix()</a>. </dd></dl>
</div>
</div>
<a id="a39d8aeda43a210d22ca0366b32aa919a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39d8aeda43a210d22ca0366b32aa919a">◆ </a></span>get_all_units()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd.get_all_units </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>wwtp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>type</em> = <code>'ASMReactor'</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return all the units of a specific type in a treatment plant PFD. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wwtp</td><td>a collection (list) of process units; </td></tr>
<tr><td class="paramname">type</td><td>type of process units of interest.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>a list of process units </dd></dl>
</div>
</div>
<a id="aa12a29c03088cc81d947aa5dabcaf0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa12a29c03088cc81d947aa5dabcaf0eb">◆ </a></span>check()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd.check </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>wwtp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the validity of the PFD against the rules. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wwtp</td><td>a collection (list) of process units;</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>bool</dd></dl>
<dl class="section user"><dt>See</dt><dd><div class="fragment"><div class="line">_check_connection();</div>
<div class="line">_check_WAS();</div>
<div class="line">_check_sidestream_flows();</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="aaef3bca0561511d17e25fbe21bf3ff69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaef3bca0561511d17e25fbe21bf3ff69">◆ </a></span>show()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def PooPyLab.utils.pfd.show </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>wwtp</em> = <code>[]</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Show the verbal description of the PFD. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wwtp</td><td>a collection (list) of process units;</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Return</dt><dd>None </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.16-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_07010fadfe1612aca43d0ba5cd3ad9cf.html">PooPyLab</a></li><li class="navelem"><a class="el" href="dir_3abde1ca51938acf95d6f00710a556a2.html">utils</a></li><li class="navelem"><a class="el" href="pfd_8py.html">pfd.py</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>