/
fuel_bucket.html
868 lines (668 loc) · 76.8 KB
/
fuel_bucket.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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>fuel_bucket — Cortix 0.1.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for fuel_bucket</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/env python</span>
<span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># This file is part of the Cortix toolkit environment</span>
<span class="c1"># https://cortix.org</span>
<span class="c1">#</span>
<span class="c1"># All rights reserved, see COPYRIGHT for full restrictions.</span>
<span class="c1"># https://github.com/dpploy/cortix/blob/master/COPYRIGHT.txt</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the University of Massachusetts Lowell LICENSE:</span>
<span class="c1"># https://github.com/dpploy/cortix/blob/master/LICENSE.txt</span>
<span class="sd">'''</span>
<span class="sd">This FuelBucket class is a container for usage with other plant-level process modules.</span>
<span class="sd">It is meant to represent a fuel bucket of a metal fuel reactor.</span>
<span class="sd">----------</span>
<span class="sd">ATTENTION:</span>
<span class="sd">----------</span>
<span class="sd">This container uses Phase() for phases (cladding and fuel). Therefore user is</span>
<span class="sd">responsible to make the "history" of the phases consistent. See Phase() info.</span>
<span class="sd">Author: Valmor de Almeida dealmeidav@ornl.gov; vfda</span>
<span class="sd">'''</span>
<span class="c1">#*********************************************************************************</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">math</span>
<span class="kn">import</span> <span class="nn">pandas</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span>
<span class="c1">#*********************************************************************************</span>
<div class="viewcode-block" id="FuelBucket"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket">[docs]</a><span class="k">class</span> <span class="nc">FuelBucket</span><span class="p">():</span>
<span class="c1">#*********************************************************************************</span>
<span class="c1"># Construction</span>
<span class="c1">#*********************************************************************************</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">specs</span><span class="o">=</span><span class="n">pandas</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">()</span>
<span class="p">):</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">specs</span><span class="p">,</span> <span class="n">pandas</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">),</span> <span class="s1">'oops not pandas table.'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span> <span class="o">=</span> <span class="n">specs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__solid_phase</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__cladding_phase</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">return</span>
<span class="c1">#**********************************************************************************</span>
<span class="c1"># Public Member Functions</span>
<span class="c1">#**********************************************************************************</span>
<span class="c1"># Start: Pre-irradiation information</span>
<div class="viewcode-block" id="FuelBucket.get_name"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_name">[docs]</a> <span class="k">def</span> <span class="nf">get_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the name of the fuel bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> name: str</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Name'</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span></div>
<span class="n">name</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_slug_type"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_slug_type">[docs]</a> <span class="k">def</span> <span class="nf">get_slug_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the type of slugs being stored in the bucket (inner slug or</span>
<span class="sd"> outer slug).</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slug_type: str</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Slug type'</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span></div>
<span class="n">slug_type</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_slug_type</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_n_slugs"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_n_slugs">[docs]</a> <span class="k">def</span> <span class="nf">get_n_slugs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the number of fuel slugs in the bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> n_slugs: int</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_n_slugs</span><span class="p">()</span></div>
<span class="n">n_slugs</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_n_slugs</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_enrichment"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_enrichment">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_enrichment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the enrichment of the fuel slugs in the bucket, in %.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_enrichment: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fuel_enrichment</span><span class="p">()</span></div>
<span class="n">fuel_enrichment</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_enrichment</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fresh_u_mass"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fresh_u_mass">[docs]</a> <span class="k">def</span> <span class="nf">get_fresh_u_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of uranium in the bucket, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fresh_u_mass: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fresh_u_mass</span><span class="p">()</span></div>
<span class="n">fresh_u_mass</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fresh_u_mass</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fresh_u238_mass"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fresh_u238_mass">[docs]</a> <span class="k">def</span> <span class="nf">get_fresh_u238_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of uranium-238 in the bucket, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fresh_u238_mass: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fresh_u238_mass</span><span class="p">()</span></div>
<span class="n">fresh_u238_mass</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fresh_u238_mass</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fresh_u235_mass"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fresh_u235_mass">[docs]</a> <span class="k">def</span> <span class="nf">get_fresh_u235_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of uranium-235 in the bucket, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fresh_u235_mass: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__GetFreshU235UMass</span><span class="p">()</span></div>
<span class="n">fresh_u235_mass</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fresh_u235_mass</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_cladding_mass"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_cladding_mass">[docs]</a> <span class="k">def</span> <span class="nf">get_cladding_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total mass of cladding material in the bucket, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cladding_mass: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_mass</span><span class="p">()</span></div>
<span class="n">cladding_mass</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_cladding_mass</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="c1"># End: Pre-irradiation information</span>
<span class="c1">#------</span>
<div class="viewcode-block" id="FuelBucket.get_slug_length"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_slug_length">[docs]</a> <span class="k">def</span> <span class="nf">get_slug_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the length of each slug in the fuel bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slug_length: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_length</span><span class="p">()</span></div>
<div class="viewcode-block" id="FuelBucket.set_slug_length"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.set_slug_length">[docs]</a> <span class="k">def</span> <span class="nf">set_slug_length</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Sets the length of all slugs in the bucket to x. Used for chopping.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> x: float</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__set_slug_length</span><span class="p">(</span><span class="n">x</span><span class="p">)</span></div>
<span class="n">slug_length</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_slug_length</span><span class="p">,</span> <span class="n">set_slug_length</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_outer_slug_od"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_outer_slug_od">[docs]</a> <span class="k">def</span> <span class="nf">get_outer_slug_od</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the outer diameter of the outer section of fuel, in cm. A fuel</span>
<span class="sd"> slug consists of an outer section of fuel and an inner section of fuel,</span>
<span class="sd"> with cladding on the outside of the slug and between the inner and</span>
<span class="sd"> outer sections of fuel.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> outer_slug_od: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_od</span><span class="p">()</span></div>
<span class="n">outer_slug_od</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_outer_slug_od</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_outer_slug_id"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_outer_slug_id">[docs]</a> <span class="k">def</span> <span class="nf">get_outer_slug_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the inner diameter of the outer section of fuel, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> outer_slug_id: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_id</span><span class="p">()</span></div>
<span class="n">outer_slug_id</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_outer_slug_id</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_inner_slug_od"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_inner_slug_od">[docs]</a> <span class="k">def</span> <span class="nf">get_inner_slug_od</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the outer diameter of the inner section of fuel, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> inner_slug_od: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_od</span><span class="p">()</span></div>
<span class="n">inner_slug_od</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_inner_slug_od</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_inner_slug_id"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_inner_slug_id">[docs]</a> <span class="k">def</span> <span class="nf">get_inner_slug_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the inner diameter of the inner section of fuel, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> inner_slug_id: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_id</span><span class="p">()</span></div>
<span class="n">inner_slug_id</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_inner_slug_id</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_cladding_wall_thickness"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_cladding_wall_thickness">[docs]</a> <span class="k">def</span> <span class="nf">get_cladding_wall_thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the thickness of the cladding wall which is on the outside of</span>
<span class="sd"> every fuel slug, and in between both sections of fuel, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cladding_wall_thickness: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_wall_thickness</span><span class="p">()</span></div>
<span class="n">cladding_wall_thickness</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span>
<span class="n">get_cladding_wall_thickness</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_cladding_end_thickness"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_cladding_end_thickness">[docs]</a> <span class="k">def</span> <span class="nf">get_cladding_end_thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Gets the thickness of the hemispherical cladding end caps that are</span>
<span class="sd"> placed on the top and bottom of the fuel slug, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cladding_end_thickness: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_end_thickness</span><span class="p">()</span></div>
<span class="n">cladding_end_thickness</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_cladding_end_thickness</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_slug_fuel_volume"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_slug_fuel_volume">[docs]</a> <span class="k">def</span> <span class="nf">get_slug_fuel_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the volume of fuel present in a single fuel slug, in cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slug_fuel_volume: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_fuel_volume</span><span class="p">()</span></div>
<span class="n">slug_fuel_volume</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_slug_fuel_volume</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_volume"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_volume">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of fuel in the entire bucket, in cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_volume: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fuel_volume</span><span class="p">()</span></div>
<span class="n">fuel_volume</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_volume</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_slug_cladding_volume"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_slug_cladding_volume">[docs]</a> <span class="k">def</span> <span class="nf">get_slug_cladding_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the volume of cladding present in a single fuel slug, in cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slug_cladding_volume: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_cladding_volume</span><span class="p">()</span></div>
<span class="n">slug_cladding_volume</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_slug_cladding_volume</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_cladding_volume"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_cladding_volume">[docs]</a> <span class="k">def</span> <span class="nf">get_cladding_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of cladding in the bucket, in cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cladding_volume: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_volume</span><span class="p">()</span></div>
<span class="n">cladding_volume</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_cladding_volume</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_mass"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_mass">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total mass of fuel in the solid phase in the bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_mass: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetValue</span><span class="p">(</span><span class="s1">'mass'</span><span class="p">)</span> <span class="c1"># mass of the solid phase</span></div>
<span class="n">fuel_mass</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_mass</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_mass_unit"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_mass_unit">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_mass_unit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the unit that is used to measure the mass of fuel in the</span>
<span class="sd"> bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_mass_unit: str</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetQuantity</span><span class="p">(</span><span class="s1">'mass'</span><span class="p">)</span><span class="o">.</span><span class="n">unit</span> <span class="c1"># mass of the solid phase</span></div>
<span class="n">fuel_mass_unit</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_mass_unit</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_radioactivity"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_radioactivity">[docs]</a> <span class="k">def</span> <span class="nf">get_radioactivity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># radioactivity of the fuel bucket (fix me)</span>
<span class="sd">'''</span>
<span class="sd"> Returns the radioactivity of the fuel bucket, in units of curies.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> radioactivity: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetValue</span><span class="p">(</span><span class="s1">'radioactivity'</span><span class="p">)</span></div>
<span class="n">radioactivity</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_radioactivity</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_gamma_pwr"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_gamma_pwr">[docs]</a> <span class="k">def</span> <span class="nf">get_gamma_pwr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the amount of gamma radiation given off by the fuel bucket,</span>
<span class="sd"> in units of watts.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> gamma_pwr: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetValue</span><span class="p">(</span><span class="s1">'gamma'</span><span class="p">)</span> <span class="c1"># gamma pwr of the fuel bucket</span></div>
<span class="n">gamma_pwr</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_gamma_pwr</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_heat_pwr"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_heat_pwr">[docs]</a> <span class="k">def</span> <span class="nf">get_heat_pwr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of heat generated by the bucket, in units of</span>
<span class="sd"> watts.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> heat_pwr: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetValue</span><span class="p">(</span><span class="s1">'heat'</span><span class="p">)</span> <span class="c1"># heat pwr of the fuel bucket</span></div>
<span class="n">heat_pwr</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_heat_pwr</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_radioactivity"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_radioactivity">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_radioactivity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># radioactivity of the solid phase</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total radioactivity of the solid phase fuel, in units of</span>
<span class="sd"> curies.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_radioactivity: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="o">.</span><span class="n">GetValue</span><span class="p">(</span><span class="s1">'radioactivity'</span><span class="p">)</span></div>
<span class="n">fuel_radioactivity</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_radioactivity</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_fuel_phase"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_fuel_phase">[docs]</a> <span class="k">def</span> <span class="nf">get_fuel_phase</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the phase history of the fuel.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> fuel_phase: pandas.core.frame.DataFrame</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span></div>
<div class="viewcode-block" id="FuelBucket.set_fuel_phase"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.set_fuel_phase">[docs]</a> <span class="k">def</span> <span class="nf">set_fuel_phase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">phase</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Sets the current fuel phase to a specified phase value.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> phase: dataFrame</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">phase</span><span class="p">)</span></div>
<span class="n">fuel_phase</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_fuel_phase</span><span class="p">,</span> <span class="n">set_fuel_phase</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="FuelBucket.get_cladding_phase"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.get_cladding_phase">[docs]</a> <span class="k">def</span> <span class="nf">get_cladding_phase</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the phase history of the cladding.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cladding_phase: dataFrame</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__cladding_phase</span></div>
<div class="viewcode-block" id="FuelBucket.set_cladding_phase"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.set_cladding_phase">[docs]</a> <span class="k">def</span> <span class="nf">set_cladding_phase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">phase</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Set's the phase history to specific values.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> phase: dataFrame</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__cladding_phase</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">phase</span><span class="p">)</span></div>
<span class="n">cladding_phase</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_cladding_phase</span><span class="p">,</span> <span class="n">set_cladding_phase</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="c1">#**********************************************************************************</span>
<span class="c1"># Private helper functions (internal use: __)</span>
<span class="c1">#**********************************************************************************</span>
<span class="k">def</span> <span class="nf">__get_n_slugs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the number of fuel slugs in the bucket.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Number of slugs', 1]: int</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Number of slugs'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">__get_fuel_enrichment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the enrichment of the fuel in the bucket, in %.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Enrichment [U-235 wt%]', 1]: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Enrichment [U-235 wt%]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">__get_outer_slug_fresh_u_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the the mass of uranium present in the outer part of a fuel</span>
<span class="sd"> slug, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['U mass outer slug [kg]', 1]) * 1000: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'U mass outer slug [kg]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">1000.0</span> <span class="c1"># [g]</span>
<span class="k">def</span> <span class="nf">__get_inner_slug_fresh_u_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the mass of uranium present in the inner part of the fuel slug,</span>
<span class="sd"> in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['U mass inner slug [kg]', 1]) * 1000: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'U mass inner slug [kg]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">1000.0</span> <span class="c1"># [g]</span>
<span class="k">def</span> <span class="nf">__get_outer_slug_cladding_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the mass of cladding present in the outer part of the slug, in</span>
<span class="sd"> grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Cladding mass outer slug [kg]', 1]) * 1000: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Cladding mass outer slug [kg]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">1000.0</span> <span class="c1"># [g]</span>
<span class="k">def</span> <span class="nf">__get_inner_slug_cladding_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the mass of cladding present in the inner part of the slug, in</span>
<span class="sd"> grams.</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Cladding mass inner slug [kg]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">1000.0</span> <span class="c1"># [g]</span>
<span class="k">def</span> <span class="nf">__get_fresh_u_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of uranium present in the fuel bucket, in</span>
<span class="sd"> grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> n_slugs * (uMassOuterSlug + uMassInnerSlug): float</span>
<span class="sd"> '''</span>
<span class="n">n_slugs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_n_slugs</span><span class="p">()</span>
<span class="n">uMassOuterSlug</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_fresh_u_mass</span><span class="p">()</span>
<span class="n">uMassInnerSlug</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_fresh_u_mass</span><span class="p">()</span>
<span class="k">return</span> <span class="n">n_slugs</span> <span class="o">*</span> <span class="p">(</span><span class="n">uMassOuterSlug</span> <span class="o">+</span> <span class="n">uMassInnerSlug</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__get_fresh_u238_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total mass of uranium-238 present in the fuel bucket, in</span>
<span class="sd"> grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> totalUMass * (1.0 - fuelEnrichment / 100): float</span>
<span class="sd"> '''</span>
<span class="n">totalUMass</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fresh_u_mass</span><span class="p">()</span>
<span class="n">fuelEnrichment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fuel_enrichment</span><span class="p">()</span>
<span class="k">return</span> <span class="n">totalUMass</span> <span class="o">*</span> <span class="p">(</span><span class="mf">1.0</span> <span class="o">-</span> <span class="n">fuelEnrichment</span> <span class="o">/</span> <span class="mf">100.0</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__get_fresh_u235_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of uranium-235 present in the bucket in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> totalUmass * fuelEnrichment / 100: float</span>
<span class="sd"> '''</span>
<span class="n">totalUMass</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fresh_u_mass</span><span class="p">()</span>
<span class="n">fuelEnrichment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_fuel_enrichment</span><span class="p">()</span>
<span class="k">return</span> <span class="n">totalUMass</span> <span class="o">*</span> <span class="n">fuelEnrichment</span> <span class="o">/</span> <span class="mf">100.0</span>
<span class="k">def</span> <span class="nf">__get_cladding_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total amount of cladding present in the bucket, in grams.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> n_slugs * (cladMassOuterSlug + cladMassInnerSlug): float</span>
<span class="sd"> '''</span>
<span class="n">n_slugs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_n_slugs</span><span class="p">()</span>
<span class="n">cladMassOuterSlug</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_cladding_mass</span><span class="p">()</span>
<span class="n">cladMassInnerSlug</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_cladding_mass</span><span class="p">()</span>
<span class="k">return</span> <span class="n">n_slugs</span> <span class="o">*</span> <span class="p">(</span><span class="n">cladMassOuterSlug</span> <span class="o">+</span> <span class="n">cladMassInnerSlug</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__get_slug_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the length of a fuel slug, in cm. Does NOT include end caps.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Slug length [in]', 1]) * 2.54: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Slug length [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">2.54</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__set_slug_length</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Sets the length of a fuel slug to a specified value. Used for chopping.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> x: float</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Slug length [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">x</span> <span class="o">/</span> <span class="mf">2.54</span> <span class="c1"># in</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">__get_outer_slug_od</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the outer diameter of the outer fuel section of the slug in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Outer slug O.D. [in]', 1]) * 2.54: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Outer slug O.D. [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">2.54</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_outer_slug_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the inner diameter of the outer fuel section of the slug in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Outer slug I.D. [in]', 1]) * 2.54: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Outer slug I.D. [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">2.54</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_inner_slug_od</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the outer diameter of the inner fuel section of the slug in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Inner slug O.D. [in]', 1]) * 2.54: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Inner slug O.D. [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">2.54</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_inner_slug_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the inner diameter of the inner fuel section of the slug in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Inner slug I.D. [in]', 1]) * 2.54: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Inner slug I.D. [in]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mf">2.54</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_cladding_wall_thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the thickness of the cladding material used on the outside of</span>
<span class="sd"> the fuel slug and between the inner and outer fuel sections.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Cladding wall thickness [mm]', 1]) /10: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Cladding wall thickness [mm]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="mf">10.0</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_cladding_end_thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the thickness of the hemispherical end caps placed on either</span>
<span class="sd"> end of the cylindrical fuel slug, in cm.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__specs.loc['Cladding end cap thickness [mm]', 1]) / 10: float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s1">'Cladding end cap thickness [mm]'</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="mf">10.0</span> <span class="c1"># cm</span>
<span class="k">def</span> <span class="nf">__get_slug_fuel_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the volume of fuel contained within a single fuel slug, in</span>
<span class="sd"> cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> outerVolume + innerVolume: float</span>
<span class="sd"> '''</span>
<span class="n">slugLength</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_length</span><span class="p">()</span>
<span class="n">cladWallThickness</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_wall_thickness</span><span class="p">()</span>
<span class="n">cladEndThickness</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_cladding_end_thickness</span><span class="p">()</span>
<span class="n">fuelLength</span> <span class="o">=</span> <span class="n">slugLength</span> <span class="o">-</span> <span class="mf">2.0</span> <span class="o">*</span> <span class="n">cladEndThickness</span>
<span class="n">fuelOuterSlugOuterRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_od</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span> <span class="o">-</span> <span class="n">cladWallThickness</span>
<span class="n">fuelOuterSlugInnerRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_id</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span> <span class="o">+</span> <span class="n">cladWallThickness</span>
<span class="n">outerVolume</span> <span class="o">=</span> <span class="n">fuelLength</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> \
<span class="p">(</span><span class="n">fuelOuterSlugOuterRadius</span><span class="o">**</span><span class="mi">2</span> <span class="o">-</span> <span class="n">fuelOuterSlugInnerRadius</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="n">fuelInnerSlugOuterRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_od</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span> <span class="o">-</span> <span class="n">cladWallThickness</span>
<span class="n">fuelInnerSlugInnerRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_id</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span> <span class="o">+</span> <span class="n">cladWallThickness</span>
<span class="n">innerVolume</span> <span class="o">=</span> <span class="n">fuelLength</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> \
<span class="p">(</span><span class="n">fuelInnerSlugOuterRadius</span><span class="o">**</span><span class="mi">2</span> <span class="o">-</span> <span class="n">fuelInnerSlugInnerRadius</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="k">return</span> <span class="n">outerVolume</span> <span class="o">+</span> <span class="n">innerVolume</span>
<span class="k">def</span> <span class="nf">__get_slug_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of a single fuel slug, in cm^3. Does not</span>
<span class="sd"> include the end caps.</span>
<span class="sd"> '''</span>
<span class="n">slugLength</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_length</span><span class="p">()</span>
<span class="n">outerSlugOuterRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_od</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span>
<span class="n">outerSlugInnerRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_outer_slug_id</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span>
<span class="n">outerVolume</span> <span class="o">=</span> <span class="n">slugLength</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> \
<span class="p">(</span><span class="n">outerSlugOuterRadius</span><span class="o">**</span><span class="mi">2</span> <span class="o">-</span> <span class="n">outerSlugInnerRadius</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="n">innerSlugOuterRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_od</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span>
<span class="n">innerSlugInnerRadius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_inner_slug_id</span><span class="p">()</span> <span class="o">/</span> <span class="mf">2.0</span>
<span class="n">innerVolume</span> <span class="o">=</span> <span class="n">slugLength</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> \
<span class="p">(</span><span class="n">innerSlugOuterRadius</span><span class="o">**</span><span class="mi">2</span> <span class="o">-</span> <span class="n">innerSlugInnerRadius</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="k">return</span> <span class="n">outerVolume</span> <span class="o">+</span> <span class="n">innerVolume</span>
<span class="k">def</span> <span class="nf">__get_slug_cladding_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of cladding in a single fuel slug. Does not</span>
<span class="sd"> include the end caps. Given in units of cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> self.__get_slug_volume() - self.__get_slug_fuel_volume(): float</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_volume</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_fuel_volume</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__get_fuel_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of fuel in the bucket, in cm^3.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slugFuelVolume * nFuelSlugs: float</span>
<span class="sd"> '''</span>
<span class="n">slugFuelVolume</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_fuel_volume</span><span class="p">()</span>
<span class="n">nFuelSlugs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_n_slugs</span><span class="p">()</span>
<span class="k">return</span> <span class="n">slugFuelVolume</span> <span class="o">*</span> <span class="n">nFuelSlugs</span>
<span class="k">def</span> <span class="nf">__get_cladding_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Returns the total volume of cladding material in the bucket, in cm^3.</span>
<span class="sd"> Does not include end caps.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> slugCladdingVolume * nFuelSlugs</span>
<span class="sd"> '''</span>
<span class="n">slugCladdingVolume</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_slug_cladding_volume</span><span class="p">()</span>
<span class="n">nFuelSlugs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_n_slugs</span><span class="p">()</span>
<span class="k">return</span> <span class="n">slugCladdingVolume</span> <span class="o">*</span> <span class="n">nFuelSlugs</span>
<div class="viewcode-block" id="FuelBucket.__str__"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Converts to string.</span>
<span class="sd"> '''</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">FuelBucket():</span><span class="se">\n\t</span><span class="s1">*******</span><span class="se">\n\t</span><span class="s1"> specs:</span><span class="se">\n\t</span><span class="s1">*******</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">t</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\t</span><span class="s1">************</span><span class="se">\n\t</span><span class="s1"> fuel_phase:</span><span class="se">\n\t</span><span class="s1">**********</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">u</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\t</span><span class="s1">***************</span><span class="se">\n\t</span><span class="s1"> cladding_phase:</span><span class="se">\n\t</span><span class="s1">*****************</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">stu</span> <span class="o">=</span> <span class="n">s</span> <span class="o">+</span> <span class="n">t</span> <span class="o">+</span> <span class="n">u</span>
<span class="k">return</span> <span class="n">stu</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__cladding_phase</span><span class="p">)</span></div>
<div class="viewcode-block" id="FuelBucket.__repr__"><a class="viewcode-back" href="../support_rst/nuclear_rst/fuel_bucket.html#fuel_bucket.FuelBucket.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Converts to string.</span>
<span class="sd"> '''</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">FuelBucket():</span><span class="se">\n\t</span><span class="s1">*******</span><span class="se">\n\t</span><span class="s1"> specs:</span><span class="se">\n\t</span><span class="s1">*******</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">t</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\t</span><span class="s1">************</span><span class="se">\n\t</span><span class="s1"> fuel_phase:</span><span class="se">\n\t</span><span class="s1">**********</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">u</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\t</span><span class="s1">****************</span><span class="se">\n\t</span><span class="s1"> cladding_phase:</span><span class="se">\n\t</span><span class="s1">****************</span><span class="se">\n\t</span><span class="s1"> </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">stu</span> <span class="o">=</span> <span class="n">s</span> <span class="o">+</span> <span class="n">t</span> <span class="o">+</span> <span class="n">u</span>
<span class="k">return</span> <span class="n">stu</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__specs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__fuel_phase</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__cladding_phase</span><span class="p">)</span></div></div>
<span class="c1">#======================= end class FuelBucket ===================================</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><!--Edit this file for customizing the side bar of the front page-->
<a href="https://github.com/dpploy/cortix"><img src="https://cortix.org/logo.jpg" alt="Cortix" style="border:none;"></a>
<h3>About Cortix</h3>
<p>
Cortix is a Python library for network modeling and HPC simulation.
</p>
<p>
Cortix Group <br>
c/o <a href="https://www.uml.edu/innovation-hub">UMass Innovation Hub</a> <br>
110 Canal St., 3rd Floor <br>
Lower, MA 01852
</p>
<p>
<a href="https://www.uml.edu/Engineering/Chemical/faculty/de-Almeida-Valmor.aspx">Prof. V. F. de Almeida, Ph.D.</a></br>
Group Leader <br>
<a href="https://www.uml.edu/Engineering/Chemical">Dept. of Chemical Engineering (Nuclear Program)</a></br>
<a href="https://www.uml.edu/">UMass Lowell</a><br>
</p>
<!---->
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../install.html">Install</a></li>
<li><a href="../contents.html">On-line Documentation</a></li>
<li><a href="https://dpploy.github.io/cortix/Cortix.pdf">PDF Documentation</a></li>
<li><a href="../license.html">License</a></li>
</ul>
<h3>Cortix Links</h3>
<ul>
<li><a href="https://mybinder.org/v2/gh/dpploy/cortix-nb/master">Run examples: Binder</a></li>
<li><a href="https://nbviewer.jupyter.org/github/dpploy/cortix-nb/tree/master/">View examples: NBViewer</a></li>
<li><a href="https://github.com/dpploy/cortix-nb">Examples repo: GitHub</a></li>
<li><a href="https://pypi.org/project/cortix/">PyPI install</a></li>
<li><a href="https://github.com/dpploy/cortix">GitHub repo</a></li>
<li><a href="https://github.com/dpploy/cortix/issues">Issue Tracker</a></li>
</ul>
<h3>HPC Resources</h3>
<ul>
<li><a href="https://hpc.inl.gov/SitePages/Home.aspx">Idaho National Laboratory HPC</a></li>
<li><a href="http://wiki.umassrc.org/wiki/index.php/Main_Page">UMass Green HPC Cluster </a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2019, University of Massachusetts Lowell.
</div>
<a href="https://github.com/dpploy/cortix" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>
</body>
</html>