Latest updates to documentation.

This commit is contained in:
Paul Romano 2012-08-20 22:18:48 -04:00
parent 3b0a50e6fc
commit e21e92ccc5
57 changed files with 1174 additions and 395 deletions

View file

@ -1,327 +0,0 @@
%!PS-Adobe-3.0 EPSF-3.0
%%BoundingBox: 0 0 540 198
%%Pages: 0
%%Creator: Sun Microsystems, Inc.
%%Title: none
%%CreationDate: none
%%LanguageLevel: 2
%%EndComments
%%BeginProlog
%%BeginResource: procset SDRes-Prolog 1.0 0
/b4_inc_state save def
/dict_count countdictstack def
/op_count count 1 sub def
userdict begin
0 setgray 0 setlinecap 1 setlinewidth 0 setlinejoin 10 setmiterlimit[] 0 setdash newpath
/languagelevel where {pop languagelevel 1 ne {false setstrokeadjust false setoverprint} if} if
/bdef {bind def} bind def
/c {setrgbcolor} bdef
/l {neg lineto} bdef
/rl {neg rlineto} bdef
/lc {setlinecap} bdef
/lj {setlinejoin} bdef
/lw {setlinewidth} bdef
/ml {setmiterlimit} bdef
/ld {setdash} bdef
/m {neg moveto} bdef
/ct {6 2 roll neg 6 2 roll neg 6 2 roll neg curveto} bdef
/r {rotate} bdef
/t {neg translate} bdef
/s {scale} bdef
/sw {show} bdef
/gs {gsave} bdef
/gr {grestore} bdef
/f {findfont dup length dict begin
{1 index /FID ne {def} {pop pop} ifelse} forall /Encoding ISOLatin1Encoding def
currentdict end /NFont exch definefont pop /NFont findfont} bdef
/p {closepath} bdef
/sf {scalefont setfont} bdef
/ef {eofill}bdef
/pc {closepath stroke}bdef
/ps {stroke}bdef
/pum {matrix currentmatrix}bdef
/pom {setmatrix}bdef
/bs {/aString exch def /nXOfs exch def /nWidth exch def currentpoint nXOfs 0 rmoveto pum nWidth aString stringwidth pop div 1 scale aString show pom moveto} bdef
%%EndResource
%%EndProlog
%%BeginSetup
%%EndSetup
%%Page: 1 1
%%BeginPageSetup
%%EndPageSetup
pum
0.02834 0.02833 s
0 -6988 t
/tm matrix currentmatrix def
tm setmatrix
-999 -2904 t
1 1 s
0.601 0.800 1.000 c 10525 4809 m 8620 4809 l 8620 2905 l 12430 2905 l
12430 4809 l 10525 4809 l p ef
0 lw 1 lj 0.003 0.003 0.003 c 10525 4809 m 8620 4809 l 8620 2905 l 12430 2905 l
12430 4809 l 10525 4809 l pc
pum
9442 4077 t
0.105 0.105 0.105 c 62 -463 m 156 -463 l 274 -148 l 393 -463 l 486 -463 l
486 0 l 425 0 l 425 -407 l 305 -89 l 242 -89 l 123 -407 l 123 0 l
62 0 l 62 -463 l p ef
764 -175 m 718 -175 686 -170 668 -159 ct 650 -149 641 -131 641 -105 ct 641 -85 648 -69 661 -57 ct
675 -45 693 -39 716 -39 ct 747 -39 773 -50 792 -73 ct 811 -95 820 -125 820 -162 ct
820 -175 l 764 -175 l p
877 -198 m 877 0 l 820 0 l 820 -53 l 807 -32 791 -16 772 -6 ct 752 4 729 9 700 9 ct
665 9 637 -1 616 -21 ct 595 -41 584 -68 584 -101 ct 584 -140 597 -170 623 -190 ct
650 -210 689 -220 740 -220 ct 820 -220 l 820 -225 l 820 -251 812 -272 795 -286 ct
777 -300 753 -308 722 -308 ct 702 -308 683 -305 664 -300 ct 645 -296 627 -289 610 -279 ct
610 -332 l 630 -340 651 -346 670 -350 ct 690 -354 709 -356 728 -356 ct 778 -356 815 -343 840 -317 ct
865 -291 877 -251 877 -198 ct p ef
1217 -337 m 1217 -283 l 1201 -292 1184 -298 1167 -302 ct 1150 -306 1132 -308 1113 -308 ct
1085 -308 1063 -304 1049 -295 ct 1035 -286 1028 -273 1028 -256 ct 1028 -243 1033 -232 1043 -225 ct
1053 -217 1074 -210 1104 -203 ct 1124 -199 l 1164 -190 1193 -178 1210 -162 ct
1227 -146 1236 -124 1236 -96 ct 1236 -64 1223 -38 1198 -19 ct 1172 0 1137 9 1092 9 ct
1074 9 1054 7 1034 4 ct 1014 0 993 -5 970 -13 ct 970 -72 l 992 -61 1012 -53 1033 -47 ct
1053 -42 1073 -39 1094 -39 ct 1120 -39 1141 -43 1156 -53 ct 1170 -62 1177 -75 1177 -92 ct
1177 -107 1172 -119 1162 -127 ct 1151 -136 1128 -144 1093 -151 ct 1073 -156 l
1038 -163 1012 -175 996 -190 ct 981 -206 973 -227 973 -254 ct 973 -286 984 -312 1008 -329 ct
1031 -347 1064 -356 1106 -356 ct 1127 -356 1147 -354 1166 -351 ct 1184 -348 1202 -344 1217 -337 ct
p ef
1382 -447 m 1382 -347 l 1500 -347 l 1500 -303 l 1382 -303 l 1382 -114 l
1382 -86 1386 -68 1394 -60 ct 1402 -52 1417 -48 1441 -48 ct 1500 -48 l 1500 0 l
1441 0 l 1397 0 1367 -8 1350 -25 ct 1333 -41 1325 -71 1325 -114 ct 1325 -303 l
1283 -303 l 1283 -347 l 1325 -347 l 1325 -447 l 1382 -447 l p ef
1873 -188 m 1873 -160 l 1611 -160 l 1613 -121 1625 -91 1646 -70 ct 1667 -50 1697 -39 1735 -39 ct
1757 -39 1778 -42 1798 -47 ct 1819 -53 1839 -61 1860 -72 ct 1860 -18 l 1839 -9 1818 -2 1797 2 ct
1775 7 1753 9 1731 9 ct 1676 9 1632 -7 1600 -39 ct 1567 -72 1551 -115 1551 -170 ct
1551 -227 1566 -272 1597 -306 ct 1628 -339 1669 -356 1721 -356 ct 1768 -356 1805 -341 1832 -311 ct
1859 -281 1873 -240 1873 -188 ct p
1816 -204 m 1815 -236 1807 -261 1790 -280 ct 1773 -298 1750 -308 1722 -308 ct
1690 -308 1665 -299 1645 -281 ct 1626 -263 1615 -237 1612 -204 ct 1816 -204 l
p ef
2166 -294 m 2160 -298 2153 -301 2145 -302 ct 2138 -304 2129 -305 2120 -305 ct
2088 -305 2063 -295 2046 -274 ct 2029 -253 2020 -222 2020 -183 ct 2020 0 l 1963 0 l
1963 -348 l 2020 -348 l 2020 -294 l 2032 -315 2048 -330 2067 -341 ct 2086 -351 2109 -356 2137 -356 ct
2141 -356 2145 -356 2150 -355 ct 2155 -355 2160 -354 2166 -353 ct 2166 -294 l
p ef
pom
1.000 1.000 0.402 c 2905 9889 m 1000 9889 l 1000 7985 l 4810 7985 l
4810 9889 l 2905 9889 l p ef
0.003 0.003 0.003 c 2905 9889 m 1000 9889 l 1000 7985 l 4810 7985 l 4810 9889 l
2905 9889 l pc
pum
2037 9157 t
0.105 0.105 0.105 c 340 -448 m 340 -387 l 316 -399 294 -407 273 -413 ct
251 -418 231 -421 211 -421 ct 177 -421 151 -414 133 -401 ct 114 -388 105 -369 105 -345 ct
105 -324 111 -309 123 -298 ct 136 -288 159 -279 193 -273 ct 231 -265 l 278 -256 312 -241 334 -218 ct
357 -196 368 -166 368 -128 ct 368 -83 353 -49 323 -26 ct 293 -3 248 9 190 9 ct
168 9 145 7 120 2 ct 96 -3 70 -11 44 -20 ct 44 -85 l 69 -71 94 -60 118 -53 ct
143 -46 167 -42 190 -42 ct 226 -42 254 -49 273 -63 ct 293 -77 302 -97 302 -123 ct
302 -146 295 -164 281 -177 ct 267 -189 245 -199 213 -206 ct 175 -213 l 128 -222 94 -237 73 -257 ct
52 -277 42 -304 42 -340 ct 42 -381 56 -413 85 -437 ct 114 -460 154 -472 204 -472 ct
226 -472 248 -470 271 -466 ct 293 -462 316 -456 340 -448 ct p ef
462 -483 m 519 -483 l 519 0 l 462 0 l 462 -483 l p ef
798 -175 m 752 -175 720 -170 702 -159 ct 684 -149 675 -131 675 -105 ct 675 -85 682 -69 695 -57 ct
709 -45 727 -39 750 -39 ct 781 -39 807 -50 826 -73 ct 845 -95 854 -125 854 -162 ct
854 -175 l 798 -175 l p
911 -198 m 911 0 l 854 0 l 854 -53 l 841 -32 825 -16 806 -6 ct 786 4 763 9 734 9 ct
699 9 671 -1 650 -21 ct 629 -41 618 -68 618 -101 ct 618 -140 631 -170 657 -190 ct
684 -210 723 -220 774 -220 ct 854 -220 l 854 -225 l 854 -251 846 -272 829 -286 ct
811 -300 787 -308 756 -308 ct 736 -308 717 -305 698 -300 ct 679 -296 661 -289 644 -279 ct
644 -332 l 664 -340 685 -346 704 -350 ct 724 -354 743 -356 762 -356 ct 812 -356 849 -343 874 -317 ct
899 -291 911 -251 911 -198 ct p ef
988 -348 m 1048 -348 l 1157 -56 l 1265 -348 l 1326 -348 l 1196 0 l
1118 0 l 988 -348 l p ef
1703 -188 m 1703 -160 l 1441 -160 l 1443 -121 1455 -91 1476 -70 ct 1497 -50 1527 -39 1565 -39 ct
1587 -39 1608 -42 1628 -47 ct 1649 -53 1669 -61 1690 -72 ct 1690 -18 l 1669 -9 1648 -2 1627 2 ct
1605 7 1583 9 1561 9 ct 1506 9 1462 -7 1430 -39 ct 1397 -72 1381 -115 1381 -170 ct
1381 -227 1396 -272 1427 -306 ct 1458 -339 1499 -356 1551 -356 ct 1598 -356 1635 -341 1662 -311 ct
1689 -281 1703 -240 1703 -188 ct p
1646 -204 m 1645 -236 1637 -261 1620 -280 ct 1603 -298 1580 -308 1552 -308 ct
1520 -308 1495 -299 1475 -281 ct 1456 -263 1445 -237 1442 -204 ct 1646 -204 l
p ef
pom
1.000 1.000 0.402 c 7985 9890 m 6080 9890 l 6080 7986 l 9890 7986 l
9890 9890 l 7985 9890 l p ef
0.003 0.003 0.003 c 7985 9890 m 6080 9890 l 6080 7986 l 9890 7986 l 9890 9890 l
7985 9890 l pc
pum
7117 9158 t
0.105 0.105 0.105 c 340 -448 m 340 -387 l 316 -399 294 -407 273 -413 ct
251 -418 231 -421 211 -421 ct 177 -421 151 -414 133 -401 ct 114 -388 105 -369 105 -345 ct
105 -324 111 -309 123 -298 ct 136 -288 159 -279 193 -273 ct 231 -265 l 278 -256 312 -241 334 -218 ct
357 -196 368 -166 368 -128 ct 368 -83 353 -49 323 -26 ct 293 -3 248 9 190 9 ct
168 9 145 7 120 2 ct 96 -3 70 -11 44 -20 ct 44 -85 l 69 -71 94 -60 118 -53 ct
143 -46 167 -42 190 -42 ct 226 -42 254 -49 273 -63 ct 293 -77 302 -97 302 -123 ct
302 -146 295 -164 281 -177 ct 267 -189 245 -199 213 -206 ct 175 -213 l 128 -222 94 -237 73 -257 ct
52 -277 42 -304 42 -340 ct 42 -381 56 -413 85 -437 ct 114 -460 154 -472 204 -472 ct
226 -472 248 -470 271 -466 ct 293 -462 316 -456 340 -448 ct p ef
462 -483 m 519 -483 l 519 0 l 462 0 l 462 -483 l p ef
798 -175 m 752 -175 720 -170 702 -159 ct 684 -149 675 -131 675 -105 ct 675 -85 682 -69 695 -57 ct
709 -45 727 -39 750 -39 ct 781 -39 807 -50 826 -73 ct 845 -95 854 -125 854 -162 ct
854 -175 l 798 -175 l p
911 -198 m 911 0 l 854 0 l 854 -53 l 841 -32 825 -16 806 -6 ct 786 4 763 9 734 9 ct
699 9 671 -1 650 -21 ct 629 -41 618 -68 618 -101 ct 618 -140 631 -170 657 -190 ct
684 -210 723 -220 774 -220 ct 854 -220 l 854 -225 l 854 -251 846 -272 829 -286 ct
811 -300 787 -308 756 -308 ct 736 -308 717 -305 698 -300 ct 679 -296 661 -289 644 -279 ct
644 -332 l 664 -340 685 -346 704 -350 ct 724 -354 743 -356 762 -356 ct 812 -356 849 -343 874 -317 ct
899 -291 911 -251 911 -198 ct p ef
988 -348 m 1048 -348 l 1157 -56 l 1265 -348 l 1326 -348 l 1196 0 l
1118 0 l 988 -348 l p ef
1703 -188 m 1703 -160 l 1441 -160 l 1443 -121 1455 -91 1476 -70 ct 1497 -50 1527 -39 1565 -39 ct
1587 -39 1608 -42 1628 -47 ct 1649 -53 1669 -61 1690 -72 ct 1690 -18 l 1669 -9 1648 -2 1627 2 ct
1605 7 1583 9 1561 9 ct 1506 9 1462 -7 1430 -39 ct 1397 -72 1381 -115 1381 -170 ct
1381 -227 1396 -272 1427 -306 ct 1458 -339 1499 -356 1551 -356 ct 1598 -356 1635 -341 1662 -311 ct
1689 -281 1703 -240 1703 -188 ct p
1646 -204 m 1645 -236 1637 -261 1620 -280 ct 1603 -298 1580 -308 1552 -308 ct
1520 -308 1495 -299 1475 -281 ct 1456 -263 1445 -237 1442 -204 ct 1646 -204 l
p ef
pom
1.000 1.000 0.402 c 13065 9889 m 11160 9889 l 11160 7985 l 14970 7985 l
14970 9889 l 13065 9889 l p ef
0.003 0.003 0.003 c 13065 9889 m 11160 9889 l 11160 7985 l 14970 7985 l
14970 9889 l 13065 9889 l pc
pum
12197 9157 t
0.105 0.105 0.105 c 340 -448 m 340 -387 l 316 -399 294 -407 273 -413 ct
251 -418 231 -421 211 -421 ct 177 -421 151 -414 133 -401 ct 114 -388 105 -369 105 -345 ct
105 -324 111 -309 123 -298 ct 136 -288 159 -279 193 -273 ct 231 -265 l 278 -256 312 -241 334 -218 ct
357 -196 368 -166 368 -128 ct 368 -83 353 -49 323 -26 ct 293 -3 248 9 190 9 ct
168 9 145 7 120 2 ct 96 -3 70 -11 44 -20 ct 44 -85 l 69 -71 94 -60 118 -53 ct
143 -46 167 -42 190 -42 ct 226 -42 254 -49 273 -63 ct 293 -77 302 -97 302 -123 ct
302 -146 295 -164 281 -177 ct 267 -189 245 -199 213 -206 ct 175 -213 l 128 -222 94 -237 73 -257 ct
52 -277 42 -304 42 -340 ct 42 -381 56 -413 85 -437 ct 114 -460 154 -472 204 -472 ct
226 -472 248 -470 271 -466 ct 293 -462 316 -456 340 -448 ct p ef
462 -483 m 519 -483 l 519 0 l 462 0 l 462 -483 l p ef
798 -175 m 752 -175 720 -170 702 -159 ct 684 -149 675 -131 675 -105 ct 675 -85 682 -69 695 -57 ct
709 -45 727 -39 750 -39 ct 781 -39 807 -50 826 -73 ct 845 -95 854 -125 854 -162 ct
854 -175 l 798 -175 l p
911 -198 m 911 0 l 854 0 l 854 -53 l 841 -32 825 -16 806 -6 ct 786 4 763 9 734 9 ct
699 9 671 -1 650 -21 ct 629 -41 618 -68 618 -101 ct 618 -140 631 -170 657 -190 ct
684 -210 723 -220 774 -220 ct 854 -220 l 854 -225 l 854 -251 846 -272 829 -286 ct
811 -300 787 -308 756 -308 ct 736 -308 717 -305 698 -300 ct 679 -296 661 -289 644 -279 ct
644 -332 l 664 -340 685 -346 704 -350 ct 724 -354 743 -356 762 -356 ct 812 -356 849 -343 874 -317 ct
899 -291 911 -251 911 -198 ct p ef
988 -348 m 1048 -348 l 1157 -56 l 1265 -348 l 1326 -348 l 1196 0 l
1118 0 l 988 -348 l p ef
1703 -188 m 1703 -160 l 1441 -160 l 1443 -121 1455 -91 1476 -70 ct 1497 -50 1527 -39 1565 -39 ct
1587 -39 1608 -42 1628 -47 ct 1649 -53 1669 -61 1690 -72 ct 1690 -18 l 1669 -9 1648 -2 1627 2 ct
1605 7 1583 9 1561 9 ct 1506 9 1462 -7 1430 -39 ct 1397 -72 1381 -115 1381 -170 ct
1381 -227 1396 -272 1427 -306 ct 1458 -339 1499 -356 1551 -356 ct 1598 -356 1635 -341 1662 -311 ct
1689 -281 1703 -240 1703 -188 ct p
1646 -204 m 1645 -236 1637 -261 1620 -280 ct 1603 -298 1580 -308 1552 -308 ct
1520 -308 1495 -299 1475 -281 ct 1456 -263 1445 -237 1442 -204 ct 1646 -204 l
p ef
pom
1.000 1.000 0.402 c 18145 9890 m 16240 9890 l 16240 7986 l 20050 7986 l
20050 9890 l 18145 9890 l p ef
0.003 0.003 0.003 c 18145 9890 m 16240 9890 l 16240 7986 l 20050 7986 l
20050 9890 l 18145 9890 l pc
pum
17277 9158 t
0.105 0.105 0.105 c 340 -448 m 340 -387 l 316 -399 294 -407 273 -413 ct
251 -418 231 -421 211 -421 ct 177 -421 151 -414 133 -401 ct 114 -388 105 -369 105 -345 ct
105 -324 111 -309 123 -298 ct 136 -288 159 -279 193 -273 ct 231 -265 l 278 -256 312 -241 334 -218 ct
357 -196 368 -166 368 -128 ct 368 -83 353 -49 323 -26 ct 293 -3 248 9 190 9 ct
168 9 145 7 120 2 ct 96 -3 70 -11 44 -20 ct 44 -85 l 69 -71 94 -60 118 -53 ct
143 -46 167 -42 190 -42 ct 226 -42 254 -49 273 -63 ct 293 -77 302 -97 302 -123 ct
302 -146 295 -164 281 -177 ct 267 -189 245 -199 213 -206 ct 175 -213 l 128 -222 94 -237 73 -257 ct
52 -277 42 -304 42 -340 ct 42 -381 56 -413 85 -437 ct 114 -460 154 -472 204 -472 ct
226 -472 248 -470 271 -466 ct 293 -462 316 -456 340 -448 ct p ef
462 -483 m 519 -483 l 519 0 l 462 0 l 462 -483 l p ef
798 -175 m 752 -175 720 -170 702 -159 ct 684 -149 675 -131 675 -105 ct 675 -85 682 -69 695 -57 ct
709 -45 727 -39 750 -39 ct 781 -39 807 -50 826 -73 ct 845 -95 854 -125 854 -162 ct
854 -175 l 798 -175 l p
911 -198 m 911 0 l 854 0 l 854 -53 l 841 -32 825 -16 806 -6 ct 786 4 763 9 734 9 ct
699 9 671 -1 650 -21 ct 629 -41 618 -68 618 -101 ct 618 -140 631 -170 657 -190 ct
684 -210 723 -220 774 -220 ct 854 -220 l 854 -225 l 854 -251 846 -272 829 -286 ct
811 -300 787 -308 756 -308 ct 736 -308 717 -305 698 -300 ct 679 -296 661 -289 644 -279 ct
644 -332 l 664 -340 685 -346 704 -350 ct 724 -354 743 -356 762 -356 ct 812 -356 849 -343 874 -317 ct
899 -291 911 -251 911 -198 ct p ef
988 -348 m 1048 -348 l 1157 -56 l 1265 -348 l 1326 -348 l 1196 0 l
1118 0 l 988 -348 l p ef
1703 -188 m 1703 -160 l 1441 -160 l 1443 -121 1455 -91 1476 -70 ct 1497 -50 1527 -39 1565 -39 ct
1587 -39 1608 -42 1628 -47 ct 1649 -53 1669 -61 1690 -72 ct 1690 -18 l 1669 -9 1648 -2 1627 2 ct
1605 7 1583 9 1561 9 ct 1506 9 1462 -7 1430 -39 ct 1397 -72 1381 -115 1381 -170 ct
1381 -227 1396 -272 1427 -306 ct 1458 -339 1499 -356 1551 -356 ct 1598 -356 1635 -341 1662 -311 ct
1689 -281 1703 -240 1703 -188 ct p
1646 -204 m 1645 -236 1637 -261 1620 -280 ct 1603 -298 1580 -308 1552 -308 ct
1520 -308 1495 -299 1475 -281 ct 1456 -263 1445 -237 1442 -204 ct 1646 -204 l
p ef
pom
0.003 0.003 0.003 c 10436 5274 m 10376 5384 10298 5482 10203 5571 ct 10185 5552 l
10168 5533 l 10259 5449 10334 5355 10392 5249 ct 10414 5262 l 10436 5274 l
p ef
10203 5571 m 10108 5658 9998 5736 9873 5805 ct 9861 5782 l 9849 5760 l
9969 5693 10077 5618 10168 5533 ct 10185 5552 l 10203 5571 l p ef
9873 5805 m 9627 5942 9325 6044 8986 6124 ct 8980 6099 l 8974 6074 l 9308 5996 9605 5895 9849 5760 ct
9861 5782 l 9873 5805 l p ef
8986 6124 m 8313 6282 7495 6351 6679 6420 ct 6677 6395 l 6674 6370 l 7488 6300 8303 6232 8974 6074 ct
8980 6099 l 8986 6124 l p ef
6679 6420 m 5866 6490 5055 6561 4394 6726 ct 4387 6702 l 4381 6677 l 5045 6511 5858 6440 6674 6370 ct
6677 6395 l 6679 6420 l p ef
4394 6726 m 4065 6808 3773 6913 3537 7053 ct 3524 7031 l 3511 7009 l 3751 6867 4047 6760 4381 6677 ct
4387 6702 l 4394 6726 l p ef
3537 7053 m 3420 7122 3317 7200 3230 7288 ct 3212 7270 l 3194 7252 l 3284 7161 3390 7081 3511 7009 ct
3524 7031 l 3537 7053 l p ef
3230 7288 m 3143 7376 3072 7473 3019 7582 ct 2997 7570 l 2974 7559 l 3029 7446 3103 7344 3194 7252 ct
3212 7270 l 3230 7288 l p ef
10525 4809 m 10173 5298 l 10536 5411 l 10525 4809 l p ef
2905 7985 m 3246 7488 l 2879 7383 l 2905 7985 l p ef
10509 5288 m 10468 5503 10402 5672 10319 5808 ct 10298 5795 l 10276 5782 l
10356 5650 10419 5486 10459 5278 ct 10484 5283 l 10509 5288 l p ef
10319 5808 m 10236 5945 10134 6048 10021 6128 ct 10006 6107 l 9992 6086 l
10100 6010 10196 5912 10276 5782 ct 10298 5795 l 10319 5808 l p ef
10021 6128 m 9909 6207 9784 6264 9654 6309 ct 9646 6285 l 9637 6261 l 9763 6217 9883 6162 9992 6086 ct
10006 6107 l 10021 6128 l p ef
9654 6309 m 9526 6354 9391 6388 9257 6422 ct 9251 6397 l 9244 6373 l 9377 6339 9510 6305 9637 6261 ct
9646 6285 l 9654 6309 l p ef
9257 6422 m 9124 6456 8991 6489 8864 6534 ct 8856 6510 l 8847 6486 l 8976 6441 9110 6407 9244 6373 ct
9251 6397 l 9257 6422 l p ef
8864 6534 m 8739 6579 8619 6634 8511 6712 ct 8496 6691 l 8481 6671 l 8593 6590 8717 6532 8847 6486 ct
8856 6510 l 8864 6534 l p ef
8511 6712 m 8404 6789 8308 6888 8229 7020 ct 8207 7007 l 8185 6994 l 8268 6856 8369 6752 8481 6671 ct
8496 6691 l 8511 6712 l p ef
8229 7020 m 8150 7153 8088 7320 8049 7530 ct 8023 7526 l 7998 7521 l 8039 7303 8103 7132 8185 6994 ct
8207 7007 l 8229 7020 l p ef
10525 4809 m 10273 5356 l 10652 5398 l 10525 4809 l p ef
7985 7986 m 8235 7438 l 7856 7397 l 7985 7986 l p ef
10591 5278 m 10631 5486 10694 5650 10774 5781 ct 10753 5795 l 10731 5808 l
10648 5672 10582 5502 10541 5287 ct 10566 5283 l 10591 5278 l p ef
10774 5781 m 10854 5912 10950 6009 11058 6085 ct 11044 6106 l 11029 6127 l
10916 6047 10814 5945 10731 5808 ct 10753 5795 l 10774 5781 l p ef
11058 6085 m 11167 6162 11287 6216 11413 6260 ct 11404 6284 l 11396 6308 l
11266 6263 11141 6206 11029 6127 ct 11044 6106 l 11058 6085 l p ef
11413 6260 m 11540 6305 11673 6338 11806 6372 ct 11800 6396 l 11793 6421 l
11659 6387 11524 6353 11396 6308 ct 11404 6284 l 11413 6260 l p ef
11806 6372 m 11940 6406 12074 6440 12203 6485 ct 12194 6509 l 12186 6533 l
12059 6488 11926 6455 11793 6421 ct 11800 6396 l 11806 6372 l p ef
12203 6485 m 12333 6531 12457 6589 12569 6670 ct 12554 6690 l 12539 6711 l
12431 6633 12311 6578 12186 6533 ct 12194 6509 l 12203 6485 l p ef
12569 6670 m 12681 6751 12782 6855 12865 6993 ct 12843 7006 l 12821 7019 l
12742 6887 12646 6788 12539 6711 ct 12554 6690 l 12569 6670 l p ef
12865 6993 m 12947 7131 13011 7302 13052 7520 ct 13027 7525 l 13001 7529 l
12962 7319 12900 7152 12821 7019 ct 12843 7006 l 12865 6993 l p ef
10525 4809 m 10398 5398 l 10777 5356 l 10525 4809 l p ef
13065 7985 m 13194 7396 l 12815 7437 l 13065 7985 l p ef
10658 5249 m 10716 5355 10791 5449 10882 5533 ct 10864 5552 l 10847 5571 l
10752 5482 10674 5384 10614 5274 ct 10636 5262 l 10658 5249 l p ef
10882 5533 m 10973 5618 11080 5694 11201 5761 ct 11189 5783 l 11176 5805 l
11052 5736 10941 5659 10847 5571 ct 10864 5552 l 10882 5533 l p ef
11201 5761 m 11444 5895 11742 5996 12075 6075 ct 12070 6100 l 12064 6124 l
11725 6045 11423 5942 11176 5805 ct 11189 5783 l 11201 5761 l p ef
12075 6075 m 12746 6233 13562 6301 14375 6371 ct 14373 6396 l 14371 6421 l
13555 6351 12737 6283 12064 6124 ct 12070 6100 l 12075 6075 l p ef
14375 6371 m 15191 6441 16005 6512 16669 6678 ct 16663 6703 l 16656 6727 l
15995 6562 15184 6491 14371 6421 ct 14373 6396 l 14375 6371 l p ef
16669 6678 m 17003 6761 17299 6868 17539 7010 ct 17526 7032 l 17513 7054 l
17277 6914 16985 6809 16656 6727 ct 16663 6703 l 16669 6678 l p ef
17539 7010 m 17660 7082 17766 7162 17856 7253 ct 17838 7271 l 17820 7289 l
17733 7201 17630 7123 17513 7054 ct 17526 7032 l 17539 7010 l p ef
17856 7253 m 17947 7345 18021 7447 18076 7560 ct 18053 7571 l 18031 7583 l
17978 7474 17907 7377 17820 7289 ct 17838 7271 l 17856 7253 l p ef
10525 4809 m 10513 5411 l 10877 5298 l 10525 4809 l p ef
18145 7986 m 18171 7384 l 17804 7489 l 18145 7986 l p ef
0 6988 t
pom
count op_count sub {pop} repeat countdictstack dict_count sub {end} repeat b4_inc_state restore
%%PageTrailer
%%Trailer
%%EOF

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 621 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 480 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 382 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 488 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 434 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 675 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 591 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 433 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 730 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 707 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 221 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 665 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 441 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 555 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 503 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 686 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 238 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 456 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 379 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 211 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 316 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1,013 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 211 B

View file

@ -14,3 +14,4 @@ as debugging.
structures
xml-fortran
statepoint

View file

@ -0,0 +1,205 @@
.. _devguide_statepoint:
======================================
State Point Binary File Specifications
======================================
----------
Revision 2
----------
**integer(4) REVISION_STATEPOINT**
Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.
**integer(4) VERSION_MAJOR**
Major version number for OpenMC
**integer(4) VERSION_MINOR**
Minor version number for OpenMC
**integer(4) VERSION_RELEASE**
Release version number for OpenMC
**integer(4) run_mode**
run mode used. The modes are described in constants.F90.
**integer(8) n_particles**
Number of particles used per generation.
**integer(4) n_batches**
Total number of batches (active + inactive).
**integer(4) n_inactive**
Number of inactive batches
**integer(4) gen_per_batch**
Number of generations per batch for criticality calculations
**integer(4) current_batch**
The number of batches already simulated.
*do i = 1, current_batch*
**real(8) k_batch(i)**
k-effective for the i-th batch
if (entropy_on)
**real(8) entropy for the i-th batch**
**integer(4) N_GLOBAL_TALLIES**
Number of global tally scores
*do i = 1, N_GLOBAL_TALLIES*
**real(8) global_tallies(i) % sum**
Accumulated sum for the i-th global tally
*do i = 1, N_GLOBAL_TALLIES*
**real(8) global_tallies(i) % sum_sq**
Accumulated sum of squares for the i-th global tally
**integer(4) n_tallies**
*do i = 1, n_tallies*
**integer(4) size(tallies(i) % scores, 1)**
Total number of score bins for the i-th tally
**integer(4) size(tallies(i) % scores, 2)**
Total number of filter bins for the i-th tally
*do i = 1, n_tallies*
*do k = 1, size(tallies(i) % scores, 2)*
*do j = 1, size(tallies(i) % scores, 1)*
**real(8) tallies(i) % scores(j,k) % sum**
Accumulated sum for the j-th score and k-th filter of the i-th
tally
**real(8) tallies(i) % scores(j,k) % sum_sq**
Accumulated sum of squares for the j-th score and k-th filter of
the i-th tally
----------
Revision 1
----------
**integer(4) REVISION_STATEPOINT**
Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.
**integer(4) VERSION_MAJOR**
Major version number for OpenMC
**integer(4) VERSION_MINOR**
Minor version number for OpenMC
**integer(4) VERSION_RELEASE**
Release version number for OpenMC
**integer(4) run_mode**
run mode used. The modes are described in constants.F90.
**integer(8) n_particles**
Number of particles used per generation.
**integer(4) n_batches**
Total number of batches (active + inactive).
**integer(4) n_inactive**
Number of inactive batches
**integer(4) gen_per_batch**
Number of generations per batch for criticality calculations
**integer(4) current_batch**
The number of batches already simulated.
*do i = 1, current_batch*
**real(8) k_batch(i)**
k-effective for the i-th batch
if (entropy_on)
**real(8) entropy for the i-th batch**
**integer(4) N_GLOBAL_TALLIES**
Number of global tally scores
*do i = 1, N_GLOBAL_TALLIES*
**real(8) global_tallies(i) % sum**
Accumulated sum for the i-th global tally
*do i = 1, N_GLOBAL_TALLIES*
**real(8) global_tallies(i) % sum_sq**
Accumulated sum of squares for the i-th global tally
**integer(4) n_tallies**
*do i = 1, n_tallies*
**integer(4) size(tallies(i) % scores, 1)**
Total number of score bins for the i-th tally
**integer(4) size(tallies(i) % scores, 2)**
Total number of filter bins for the i-th tally
*do k = 1, size(tallies(i) % scores, 2)*
*do j = 1, size(tallies(i) % scores, 1)*
**real(8) tallies(i) % scores(j,k) % sum**
Accumulated sum for the j-th score and k-th filter of the i-th
tally
*do k = 1, size(tallies(i) % scores, 2)*
*do j = 1, size(tallies(i) % scores, 1)*
**real(8) tallies(i) % scores(j,k) % sum_sq**
Accumulated sum of squares for the j-th score and k-th filter of
the i-th tally

View file

@ -0,0 +1,37 @@
============ ====================== =============================================
Type Variable Description
============ ====================== =============================================
integer(4) REVISION_STATEPOINT Revision of the binary state point file. Any
time a change is made in the format of the
state-point file, this integer is
incremented.
integer(4) VERSION_MAJOR Major version number for OpenMC
integer(4) VERSION_MINOR Minor version number for OpenMC
integer(4) VERSION_RELEASE Release version number for OpenMC
integer(4) run_mode Run mode used. 1 = criticality, 2 = fixed
source
integer(8) n_particles Number of particles used per generation.
integer(4) n_batches Total number of batches (active + inactive).
integer(4) n_inactive Number of inactive batches
integer(4) gen_per_batch Number of generations per batch for
criticality calculations
integer(4) current_batch Number of batches already simulated.
============ ====================== =============================================
The next variable appears only for a criticality calculation (run_mode =
MODE_CRITICALITY = 1).
============ ====================== =============================================
real(8) k_batch(i), i = 1, k-effective for the i-th batch
current_batch
============ ====================== =============================================
The next variable appears only for a criticality calculation where Shannon
entropy has been turned on.
============ ====================== =============================================
real(8) entropy(i), i = 1, Shannon entropy for the i-th batch
current_batch
============ ====================== =============================================

View file

@ -173,6 +173,110 @@ of this is that the longer you run a simulation, the better you know your
results. Therefore, by running a simulation long enough, it is possible to
reduce the stochastic uncertainty to arbitrarily low levels.
Confidence Intervals
--------------------
While the sample variance and standard deviation gives us some idea about the
variability of the estimate of the mean of whatever quantities we've tallied, it
does not help us interpret how confidence we should be in the results. To
quantity the reliability of our estimates, we can use `confidence intervals`_
based on the calculated sample variance.
A :math:`1-\alpha` confidence interval for a population parameter is defined as
such: if we repeat the same experiment many times and calculate the confidence
interval for each experiment, then :math:`1 - \alpha` percent of the calculated
intervals would encompass the true population parameter. Let :math:`x_1, x_2,
\dots, x_N` be samples from a set of independent, identically-distributed random
variables each with population mean :math:`\mu` and variance
:math:`\sigma^2`. The t-statistic is defined as
.. math::
:label: t-statistic
t = \frac{\bar{x} - \mu}{s/\sqrt{N}}
where :math:`\bar{x}` is the sample mean from equation :eq:`sample-mean` and
:math:`s` is the standard deviation based on equation
:eq:`unbiased-variance`. If the random variables :math:`X_i` are
normally-distributed, then the t-statistic has a `Student's t-distribution`_
with :math:`N-1` degrees of freedom. This implies that
.. math::
:label: t-probability
Pr \left ( -t_{1 - \alpha/2, N - 1} \le \frac{\bar{x} - \mu}{s/\sqrt{N}} \le
t_{1 - \alpha/2, N - 1} \right ) = 1 - \alpha
where :math:`t_{1-\alpha/2, N-1}` is the :math:`1 - \alpha/2` percentile of a
t-distribution with :math:`N-1` degrees of freedom. Thus, the :math:`1 - \alpha`
two sided confidence interval for the sample mean is
.. math::
:label: two-sided-ci
\bar{x} \pm t_{1 - \alpha/2, N-1} \frac{s}{\sqrt{N}}.
One should be cautioned that equation :eq:`two-sided-ci` **only applies if the
underlying random variables are normally-distributed!** In general, this may not
be true for a tally random variable -- the central limit theorem guarantees only
that the sample mean is normally distributed, not the underlying random
variable. If batching is used, then the underlying random variable, which would
then be the averages from each batch, will be normally distributed as long as
the conditions of the central limit theorem are met.
Let us now outline the method used to calculate the percentile of the Student's
t-distribution. For one or two degrees of freedom, the percentile can be written
analytically. For one degree of freedom, the t-distribution becomes a standard
`Cauchy distribution`_ whose cumulative distribution function is
.. math::
:label: cauchy-cdf
c(x) = \frac{1}{\pi} \arctan x + \frac{1}{2}.
Thus, inverting the cumulative distribution function, we find the :math:`x`
percentile of the standard Cauchy distribution to be
.. math::
:label: percentile-1
t_{x,1} = \tan \left ( \pi \left ( x - \frac{1}{2} \right ) \right ).
For two degrees of freedom, the cumulative distribution function is the
second-degree polynomial
.. math::
:label: t-2-polynomial
c(x) = \frac{1}{2} + \frac{x}{2\sqrt{x^2 + 2}}
Solving for :math:`x`, we find the :math:`x` percentile to be
.. math::
:label: percentile-2
t_{x,2} = \frac{2\sqrt{2} (x - 1/2)}{\sqrt{1 - 4 (x - 1/2)^2}}
For degrees of freedom greater than two, it is not possible to obtain an
analytical formula for the inverse of the cumulative distribution function. We
must resort to either numerically solving for the inverse or to an
approximation. Approximations for percentiles of the t-distribution have been
found with high levels of accuracy. OpenMC uses the approximation from
[George]_:
.. math::
:label: percentile-n
t_{x,n} = \sqrt{\frac{n}{n-2}} \left ( z_x + \frac{1}{4} \frac{z_x^3 -
3z_x}{n-2} + \frac{1}{96} \frac{5z_x^5 - 56z_x^3 + 75z_x}{(n-2)^2} +
\frac{1}{384} \frac{3z_x^7 - 81z_x^5 + 417z_x^3 - 315z_x}{(n-2)^3} \right )
where :math:`z_x` is the :math:`x` percentile of the standard normal
distribution. In order to determine an arbitrary percentile of the standard
normal distribution, we use an `unpublished rational approximation`_. After
using the rational approximation, one iteration of Newton's method is applied to
improve the estimate of the percentile.
------------------------
Random Number Generation
------------------------
@ -226,6 +330,14 @@ Note that equation :eq:`lcg-skipahead` has the same form as equation :eq:`lcg`
so the idea is to determine the new multiplicative and additive constants in
:math:`O(\log N)` operations.
----------
References
----------
.. [George] E. E. Olusegun George and Meenakshi Sivaram, "A modification of the
Fisher-Cornish approximation for the student t percentiles," Communication
in Statistics - Simulation and Computation, 16 (4), pp. 1123-1132 (1987).
.. _linear congruential generator: http://en.wikipedia.org/wiki/Linear_congruential_generator
.. _Brown: https://laws.lanl.gov/vhosts/mcnp.lanl.gov/pdf_files/anl_rn_arb-strides_1994.pdf
@ -247,3 +359,11 @@ so the idea is to determine the new multiplicative and additive constants in
.. _normal distribution: http://en.wikipedia.org/wiki/Normal_distribution
.. _converges in distribution: http://en.wikipedia.org/wiki/Convergence_of_random_variables#Convergence_in_distribution
.. _confidence intervals: http://en.wikipedia.org/wiki/Confidence_interval
.. _Student's t-distribution: http://en.wikipedia.org/wiki/Student%27s_t-distribution
.. _Cauchy distribution: http://en.wikipedia.org/wiki/Cauchy_distribution
.. _unpublished rational approximation: http://home.online.no/~pjacklam/notes/invnorm/

View file

@ -10,6 +10,7 @@ bugs fixed, and known issues for each successive release.
.. toctree::
:maxdepth: 1
notes_0.4.4
notes_0.4.3
notes_0.4.2
notes_0.4.1

View file

@ -4,10 +4,6 @@
Release Notes for OpenMC 0.4.3
==============================
.. note::
These release notes are for an upcoming release of OpenMC and are still
subject to change.
-------------------
System Requirements
-------------------
@ -21,7 +17,9 @@ the problem at hand (mostly on the number of nuclides in the problem).
New Features
------------
- Option to report confidence intervals for tally results.
- Rotation and translation for filled cells.
- Ability to explicitly specify <estimator> for tallies.
- Ability to store state points and use them to restart runs.
- Fixed source calculations (no subcritical multiplication however).
- Expanded options for external source distribution.
@ -34,6 +32,7 @@ New Features
Bug Fixes
---------
- 33f29a_: Handle negative values in probability table.
- 1c472d_: Fixed survival biasing with probability tables.
- 3c6e80_: Fixed writing tallies with no filters.
- 460ef1_: Invalid results for duplicate tallies.
@ -43,6 +42,7 @@ Bug Fixes
- 3212f5_: Fixed issue with blank line at beginning of XML files.
.. _nelsonag: https://github.com/nelsonag
.. _33f29a: https://github.com/mit-crpg/openmc/commit/33f29a
.. _1c472d: https://github.com/mit-crpg/openmc/commit/1c472d
.. _3c6e80: https://github.com/mit-crpg/openmc/commit/3c6e80
.. _3bd35b: https://github.com/mit-crpg/openmc/commit/3bd35b

View file

@ -0,0 +1,28 @@
.. _notes_0.4.4:
==============================
Release Notes for OpenMC 0.4.4
==============================
.. note::
These release notes are for an upcoming release of OpenMC and are still
subject to change.
-------------------
System Requirements
-------------------
There are no special requirements for running the OpenMC code. As of this
release, OpenMC has been tested on a variety of Linux distributions, Mac OS X,
and Microsoft Windows 7. Memory requirements will vary depending on the size of
the problem at hand (mostly on the number of nuclides in the problem).
------------
New Features
------------
- Option to specify <upper_right> for tally meshes.
---------
Bug Fixes
---------

View file

@ -55,6 +55,17 @@ Settings Specification -- settings.xml
All simulation parameters and miscellaneous options are specified in the
settings.xml file.
``<confidence_intervals>`` Element
----------------------------------
The ``<confidence_intervals>`` element has no attributes and has an accepted
value of "on" or "off". If set to "on", uncertainties on tally results will be
reported as the half-width of the 95% two-sided confidence interval. If set to
"off", uncertainties on tally results will be reported as the sample standard
deviation.
*Default*: off
``<criticality>`` Element
-------------------------
@ -344,8 +355,21 @@ displayed. This element takes the following attributes:
*Default*: 5
``<write_state_point>`` Element
-------------------------------
The ``<write_state_point>`` element is used to indicate batches at which the
user wishes to have a binary state point file written to disk. The state point
file can be used to restart a run or to get tally results at an intermediate
stage. This element has no attributes and should consist of a list of integers
corresponding to batches at which a binary state point file should be written to
disk.
*Default*: None
``<write_source>`` Element
------------------------------
--------------------------
The ``<write_source>`` element has no attributes and has an accepted value of
"on" or "off". If set to "on", a binary source file will be written to disk at
@ -512,9 +536,9 @@ Each ``<cell>`` element can have the following attributes or sub-elements:
:rotation:
If the cell is filled with a universe, this element specifies the angles in
degrees about the x, y, and z axes that the filled universe should be
rotated. Should be given as three real numbers.For example, if you wanted to
rotate the filled universe by 90 degrees about the z-axis, the cell element
would look something like:
rotated. Should be given as three real numbers. For example, if you wanted
to rotate the filled universe by 90 degrees about the z-axis, the cell
element would look something like:
.. code-block:: xml
@ -669,6 +693,21 @@ The ``<tally>`` element accepts the following sub-elements:
A list of filters to specify what region of phase space should contribute to
the tally. See below for full details on what filters are available.
:nuclides:
If specified, the scores listed will be for particular nuclides, not the
summation of reactions from all nuclides. The format for nuclides should be
[Atomic symbol]-[Mass number], e.g. "U-235". The reaction rate for all
nuclides can be obtained with "total". For example, to obtain the reaction
rates for U-235, Pu-239, and all nuclides in a material, this element should
be:
.. code-block:: xml
<nuclides>U-235 Pu-239 total</nuclides>
*Default*: total
:scores:
The desired responses to be accumulated. See below for full details on what
responses can be tallied.

View file

@ -60,6 +60,11 @@ as debugging.</p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="structures.html">1. Data Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="xml-fortran.html">2. xml-fortran Input Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="statepoint.html">3. State Point Binary File Specifications</a><ul>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-2">3.1. Revision 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-1">3.2. Revision 1</a></li>
</ul>
</li>
</ul>
</div>
</div>

266
devguide/statepoint.html Normal file
View file

@ -0,0 +1,266 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>3. State Point Binary File Specifications &mdash; OpenMC Documentation</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Developers Guide" href="index.html" />
<link rel="next" title="Publications" href="../publications.html" />
<link rel="prev" title="2. xml-fortran Input Parsing" href="xml-fortran.html" />
</head>
<body>
<div class="header">
<a href="../index.html">
<img class="logo" src="../_static/openmc.png" alt="Logo"/>
</a>
</div>
<div class="topnav">
<p>
«&#160;&#160;<a href="xml-fortran.html">2. xml-fortran Input Parsing</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="../publications.html">Publications</a>&#160;&#160;»
</p>
</div>
<div class="content">
<div class="section" id="state-point-binary-file-specifications">
<span id="devguide-statepoint"></span><h1>3. State Point Binary File Specifications<a class="headerlink" href="#state-point-binary-file-specifications" title="Permalink to this headline"></a></h1>
<div class="section" id="revision-2">
<h2>3.1. Revision 2<a class="headerlink" href="#revision-2" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.</div></blockquote>
<p><strong>integer(4) VERSION_MAJOR</strong></p>
<blockquote>
<div>Major version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_MINOR</strong></p>
<blockquote>
<div>Minor version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_RELEASE</strong></p>
<blockquote>
<div>Release version number for OpenMC</div></blockquote>
<p><strong>integer(4) run_mode</strong></p>
<blockquote>
<div>run mode used. The modes are described in constants.F90.</div></blockquote>
<p><strong>integer(8) n_particles</strong></p>
<blockquote>
<div>Number of particles used per generation.</div></blockquote>
<p><strong>integer(4) n_batches</strong></p>
<blockquote>
<div>Total number of batches (active + inactive).</div></blockquote>
<p><strong>integer(4) n_inactive</strong></p>
<blockquote>
<div>Number of inactive batches</div></blockquote>
<p><strong>integer(4) gen_per_batch</strong></p>
<blockquote>
<div>Number of generations per batch for criticality calculations</div></blockquote>
<p><strong>integer(4) current_batch</strong></p>
<blockquote>
<div>The number of batches already simulated.</div></blockquote>
<p><em>do i = 1, current_batch</em></p>
<blockquote>
<div><p><strong>real(8) k_batch(i)</strong></p>
<blockquote>
<div>k-effective for the i-th batch</div></blockquote>
<p>if (entropy_on)</p>
<blockquote>
<div><strong>real(8) entropy for the i-th batch</strong></div></blockquote>
</div></blockquote>
<p><strong>integer(4) N_GLOBAL_TALLIES</strong></p>
<blockquote>
<div>Number of global tally scores</div></blockquote>
<p><em>do i = 1, N_GLOBAL_TALLIES</em></p>
<blockquote>
<div><p><strong>real(8) global_tallies(i) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the i-th global tally</div></blockquote>
</div></blockquote>
<p><em>do i = 1, N_GLOBAL_TALLIES</em></p>
<blockquote>
<div><p><strong>real(8) global_tallies(i) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the i-th global tally</div></blockquote>
</div></blockquote>
<p><strong>integer(4) n_tallies</strong></p>
<p><em>do i = 1, n_tallies</em></p>
<blockquote>
<div><p><strong>integer(4) size(tallies(i) % scores, 1)</strong></p>
<blockquote>
<div>Total number of score bins for the i-th tally</div></blockquote>
<p><strong>integer(4) size(tallies(i) % scores, 2)</strong></p>
<blockquote>
<div>Total number of filter bins for the i-th tally</div></blockquote>
</div></blockquote>
<p><em>do i = 1, n_tallies</em></p>
<blockquote>
<div><p><em>do k = 1, size(tallies(i) % scores, 2)</em></p>
<blockquote>
<div><p><em>do j = 1, size(tallies(i) % scores, 1)</em></p>
<blockquote>
<div><p><strong>real(8) tallies(i) % scores(j,k) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the j-th score and k-th filter of the i-th
tally</div></blockquote>
<p><strong>real(8) tallies(i) % scores(j,k) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the j-th score and k-th filter of
the i-th tally</div></blockquote>
</div></blockquote>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-1">
<h2>3.2. Revision 1<a class="headerlink" href="#revision-1" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.</div></blockquote>
<p><strong>integer(4) VERSION_MAJOR</strong></p>
<blockquote>
<div>Major version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_MINOR</strong></p>
<blockquote>
<div>Minor version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_RELEASE</strong></p>
<blockquote>
<div>Release version number for OpenMC</div></blockquote>
<p><strong>integer(4) run_mode</strong></p>
<blockquote>
<div>run mode used. The modes are described in constants.F90.</div></blockquote>
<p><strong>integer(8) n_particles</strong></p>
<blockquote>
<div>Number of particles used per generation.</div></blockquote>
<p><strong>integer(4) n_batches</strong></p>
<blockquote>
<div>Total number of batches (active + inactive).</div></blockquote>
<p><strong>integer(4) n_inactive</strong></p>
<blockquote>
<div>Number of inactive batches</div></blockquote>
<p><strong>integer(4) gen_per_batch</strong></p>
<blockquote>
<div>Number of generations per batch for criticality calculations</div></blockquote>
<p><strong>integer(4) current_batch</strong></p>
<blockquote>
<div>The number of batches already simulated.</div></blockquote>
<p><em>do i = 1, current_batch</em></p>
<blockquote>
<div><p><strong>real(8) k_batch(i)</strong></p>
<blockquote>
<div>k-effective for the i-th batch</div></blockquote>
<p>if (entropy_on)</p>
<blockquote>
<div><strong>real(8) entropy for the i-th batch</strong></div></blockquote>
</div></blockquote>
<p><strong>integer(4) N_GLOBAL_TALLIES</strong></p>
<blockquote>
<div>Number of global tally scores</div></blockquote>
<p><em>do i = 1, N_GLOBAL_TALLIES</em></p>
<blockquote>
<div><p><strong>real(8) global_tallies(i) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the i-th global tally</div></blockquote>
</div></blockquote>
<p><em>do i = 1, N_GLOBAL_TALLIES</em></p>
<blockquote>
<div><p><strong>real(8) global_tallies(i) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the i-th global tally</div></blockquote>
</div></blockquote>
<p><strong>integer(4) n_tallies</strong></p>
<p><em>do i = 1, n_tallies</em></p>
<blockquote>
<div><p><strong>integer(4) size(tallies(i) % scores, 1)</strong></p>
<blockquote>
<div>Total number of score bins for the i-th tally</div></blockquote>
<p><strong>integer(4) size(tallies(i) % scores, 2)</strong></p>
<blockquote>
<div>Total number of filter bins for the i-th tally</div></blockquote>
<p><em>do k = 1, size(tallies(i) % scores, 2)</em></p>
<blockquote>
<div><p><em>do j = 1, size(tallies(i) % scores, 1)</em></p>
<blockquote>
<div><p><strong>real(8) tallies(i) % scores(j,k) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the j-th score and k-th filter of the i-th
tally</div></blockquote>
</div></blockquote>
</div></blockquote>
<p><em>do k = 1, size(tallies(i) % scores, 2)</em></p>
<blockquote>
<div><p><em>do j = 1, size(tallies(i) % scores, 1)</em></p>
<blockquote>
<div><p><strong>real(8) tallies(i) % scores(j,k) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the j-th score and k-th filter of
the i-th tally</div></blockquote>
</div></blockquote>
</div></blockquote>
</div></blockquote>
</div>
</div>
</div>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="xml-fortran.html">2. xml-fortran Input Parsing</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="../publications.html">Publications</a>&#160;&#160;»
</p>
</div>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30411614-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>

View file

@ -0,0 +1,171 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>&lt;no title&gt; &mdash; OpenMC Documentation</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
</head>
<body>
<div class="header">
<a href="../index.html">
<img class="logo" src="../_static/openmc.png" alt="Logo"/>
</a>
</div>
<div class="topnav">
<p>
<a class="uplink" href="../index.html">Contents</a>
</p>
</div>
<div class="content">
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="28%" />
<col width="57%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Type</th>
<th class="head">Variable</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>integer(4)</td>
<td>REVISION_STATEPOINT</td>
<td>Revision of the binary state point file. Any
time a change is made in the format of the
state-point file, this integer is
incremented.</td>
</tr>
<tr class="row-odd"><td>integer(4)</td>
<td>VERSION_MAJOR</td>
<td>Major version number for OpenMC</td>
</tr>
<tr class="row-even"><td>integer(4)</td>
<td>VERSION_MINOR</td>
<td>Minor version number for OpenMC</td>
</tr>
<tr class="row-odd"><td>integer(4)</td>
<td>VERSION_RELEASE</td>
<td>Release version number for OpenMC</td>
</tr>
<tr class="row-even"><td>integer(4)</td>
<td>run_mode</td>
<td>Run mode used. 1 = criticality, 2 = fixed
source</td>
</tr>
<tr class="row-odd"><td>integer(8)</td>
<td>n_particles</td>
<td>Number of particles used per generation.</td>
</tr>
<tr class="row-even"><td>integer(4)</td>
<td>n_batches</td>
<td>Total number of batches (active + inactive).</td>
</tr>
<tr class="row-odd"><td>integer(4)</td>
<td>n_inactive</td>
<td>Number of inactive batches</td>
</tr>
<tr class="row-even"><td>integer(4)</td>
<td>gen_per_batch</td>
<td>Number of generations per batch for
criticality calculations</td>
</tr>
<tr class="row-odd"><td>integer(4)</td>
<td>current_batch</td>
<td>Number of batches already simulated.</td>
</tr>
</tbody>
</table>
<p>The next variable appears only for a criticality calculation (run_mode =
MODE_CRITICALITY = 1).</p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="28%" />
<col width="57%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>real(8)</td>
<td>k_batch(i), i = 1,
current_batch</td>
<td>k-effective for the i-th batch</td>
</tr>
</tbody>
</table>
<p>The next variable appears only for a criticality calculation where Shannon
entropy has been turned on.</p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="28%" />
<col width="57%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>real(8)</td>
<td>entropy(i), i = 1,
current_batch</td>
<td>Shannon entropy for the i-th batch</td>
</tr>
</tbody>
</table>
</div>
<div class="bottomnav">
<p>
<a class="uplink" href="../index.html">Contents</a>
</p>
</div>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30411614-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>

View file

@ -29,7 +29,7 @@
<script type="text/javascript" src="../_static/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Developers Guide" href="index.html" />
<link rel="next" title="Publications" href="../publications.html" />
<link rel="next" title="3. State Point Binary File Specifications" href="statepoint.html" />
<link rel="prev" title="1. Data Structures" href="structures.html" />
</head>
<body>
@ -45,7 +45,7 @@
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="../publications.html">Publications</a>&#160;&#160;»
<a href="statepoint.html">3. State Point Binary File Specifications</a>&#160;&#160;»
</p>
</div>
@ -65,7 +65,7 @@
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="../publications.html">Publications</a>&#160;&#160;»
<a href="statepoint.html">3. State Point Binary File Specifications</a>&#160;&#160;»
</p>
</div>

View file

@ -74,9 +74,11 @@
<li class="toctree-l3"><a class="reference internal" href="statistics.html#mean">3.3.1. Mean</a></li>
<li class="toctree-l3"><a class="reference internal" href="statistics.html#variance">3.3.2. Variance</a></li>
<li class="toctree-l3"><a class="reference internal" href="statistics.html#variance-of-the-mean">3.3.3. Variance of the Mean</a></li>
<li class="toctree-l3"><a class="reference internal" href="statistics.html#confidence-intervals">3.3.4. Confidence Intervals</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="statistics.html#random-number-generation">3.4. Random Number Generation</a></li>
<li class="toctree-l2"><a class="reference internal" href="statistics.html#references">3.5. References</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geometry.html">4. Geometry</a><ul>

View file

@ -178,6 +178,75 @@ of this is that the longer you run a simulation, the better you know your
results. Therefore, by running a simulation long enough, it is possible to
reduce the stochastic uncertainty to arbitrarily low levels.</p>
</div>
<div class="section" id="confidence-intervals">
<h3>3.3.4. Confidence Intervals<a class="headerlink" href="#confidence-intervals" title="Permalink to this headline"></a></h3>
<p>While the sample variance and standard deviation gives us some idea about the
variability of the estimate of the mean of whatever quantities we&#8217;ve tallied, it
does not help us interpret how confidence we should be in the results. To
quantity the reliability of our estimates, we can use <a class="reference external" href="http://en.wikipedia.org/wiki/Confidence_interval">confidence intervals</a>
based on the calculated sample variance.</p>
<p>A <img class="math" src="../_images/math/feea5c83d5de074b138327d3617c30402fdd9768.png" alt="1-\alpha"/> confidence interval for a population parameter is defined as
such: if we repeat the same experiment many times and calculate the confidence
interval for each experiment, then <img class="math" src="../_images/math/e63009dbf6176a47dc83a6c06dd5ce224d6e57d4.png" alt="1 - \alpha"/> percent of the calculated
intervals would encompass the true population parameter. Let <img class="math" src="../_images/math/d0c7c0908f2b24307dd8c0d64e8082efd5872155.png" alt="x_1, x_2,
\dots, x_N"/> be samples from a set of independent, identically-distributed random
variables each with population mean <img class="math" src="../_images/math/2d8c833ed800824727cd7bd2fb9de1a12ad7e674.png" alt="\mu"/> and variance
<img class="math" src="../_images/math/741fb9098efcb98055f467f87630a5d0ca599b6b.png" alt="\sigma^2"/>. The t-statistic is defined as</p>
<div class="math" id="equation-t-statistic">
<p><span class="eqno">(9)</span><img src="../_images/math/7a8fa6d18fdddd436cd3c52612a3372897f7c5c0.png" alt="t = \frac{\bar{x} - \mu}{s/\sqrt{N}}"/></p>
</div><p>where <img class="math" src="../_images/math/f06e84fe84a6c63a9c2c392af11652f6e0d72cf4.png" alt="\bar{x}"/> is the sample mean from equation <a href="#equation-sample-mean">(2)</a> and
<img class="math" src="../_images/math/f37bba504894945c07a32f5496d74299a37aa51c.png" alt="s"/> is the standard deviation based on equation
<a href="#equation-unbiased-variance">(5)</a>. If the random variables <img class="math" src="../_images/math/5f8e5cbb6204882df1cf17cfe4b308d485af8056.png" alt="X_i"/> are
normally-distributed, then the t-statistic has a <a class="reference external" href="http://en.wikipedia.org/wiki/Student%27s_t-distribution">Student&#8217;s t-distribution</a>
with <img class="math" src="../_images/math/a256c70ad4c46ec1127c5be68f8bb3075e9ced31.png" alt="N-1"/> degrees of freedom. This implies that</p>
<div class="math" id="equation-t-probability">
<p><span class="eqno">(10)</span><img src="../_images/math/4a210f77a1c79011bdc5ac4f2cac91a4c5a08959.png" alt="Pr \left ( -t_{1 - \alpha/2, N - 1} \le \frac{\bar{x} - \mu}{s/\sqrt{N}} \le
t_{1 - \alpha/2, N - 1} \right ) = 1 - \alpha"/></p>
</div><p>where <img class="math" src="../_images/math/1bc7ce223ddb22edcd126ed8d841b796f2f337d9.png" alt="t_{1-\alpha/2, N-1}"/> is the <img class="math" src="../_images/math/f3f0133f5afb7e759a00024c929a5f273f316403.png" alt="1 - \alpha/2"/> percentile of a
t-distribution with <img class="math" src="../_images/math/a256c70ad4c46ec1127c5be68f8bb3075e9ced31.png" alt="N-1"/> degrees of freedom. Thus, the <img class="math" src="../_images/math/e63009dbf6176a47dc83a6c06dd5ce224d6e57d4.png" alt="1 - \alpha"/>
two sided confidence interval for the sample mean is</p>
<div class="math" id="equation-two-sided-ci">
<p><span class="eqno">(11)</span><img src="../_images/math/80bc7504239295d322d8606b71adc1190e09a896.png" alt="\bar{x} \pm t_{1 - \alpha/2, N-1} \frac{s}{\sqrt{N}}."/></p>
</div><p>One should be cautioned that equation <a href="#equation-two-sided-ci">(11)</a> <strong>only applies if the
underlying random variables are normally-distributed!</strong> In general, this may not
be true for a tally random variable &#8211; the central limit theorem guarantees only
that the sample mean is normally distributed, not the underlying random
variable. If batching is used, then the underlying random variable, which would
then be the averages from each batch, will be normally distributed as long as
the conditions of the central limit theorem are met.</p>
<p>Let us now outline the method used to calculate the percentile of the Student&#8217;s
t-distribution. For one or two degrees of freedom, the percentile can be written
analytically. For one degree of freedom, the t-distribution becomes a standard
<a class="reference external" href="http://en.wikipedia.org/wiki/Cauchy_distribution">Cauchy distribution</a> whose cumulative distribution function is</p>
<div class="math" id="equation-cauchy-cdf">
<p><span class="eqno">(12)</span><img src="../_images/math/436e8db97463066d1a7386a95b10ac520bbe8b3a.png" alt="c(x) = \frac{1}{\pi} \arctan x + \frac{1}{2}."/></p>
</div><p>Thus, inverting the cumulative distribution function, we find the <img class="math" src="../_images/math/26eeb5258ca5099acf8fe96b2a1049c48c89a5e6.png" alt="x"/>
percentile of the standard Cauchy distribution to be</p>
<div class="math" id="equation-percentile-1">
<p><span class="eqno">(13)</span><img src="../_images/math/fa2f03813f247d34e237d7d4f70aad833a23ac36.png" alt="t_{x,1} = \tan \left ( \pi \left ( x - \frac{1}{2} \right ) \right )."/></p>
</div><p>For two degrees of freedom, the cumulative distribution function is the
second-degree polynomial</p>
<div class="math" id="equation-t-2-polynomial">
<p><span class="eqno">(14)</span><img src="../_images/math/6951671d483dd1a00fdbf1c2a63f822d8a5dfb0f.png" alt="c(x) = \frac{1}{2} + \frac{x}{2\sqrt{x^2 + 2}}"/></p>
</div><p>Solving for <img class="math" src="../_images/math/26eeb5258ca5099acf8fe96b2a1049c48c89a5e6.png" alt="x"/>, we find the <img class="math" src="../_images/math/26eeb5258ca5099acf8fe96b2a1049c48c89a5e6.png" alt="x"/> percentile to be</p>
<div class="math" id="equation-percentile-2">
<p><span class="eqno">(15)</span><img src="../_images/math/9bc6d41e157898a5956cd9c4ccf338dea7050d12.png" alt="t_{x,2} = \frac{2\sqrt{2} (x - 1/2)}{\sqrt{1 - 4 (x - 1/2)^2}}"/></p>
</div><p>For degrees of freedom greater than two, it is not possible to obtain an
analytical formula for the inverse of the cumulative distribution function. We
must resort to either numerically solving for the inverse or to an
approximation. Approximations for percentiles of the t-distribution have been
found with high levels of accuracy. OpenMC uses the approximation from
<a class="reference internal" href="#george">[George]</a>:</p>
<div class="math" id="equation-percentile-n">
<p><span class="eqno">(16)</span><img src="../_images/math/5ba93ef9c5f2963c0b31e884c59317c780965345.png" alt="t_{x,n} = \sqrt{\frac{n}{n-2}} \left ( z_x + \frac{1}{4} \frac{z_x^3 -
3z_x}{n-2} + \frac{1}{96} \frac{5z_x^5 - 56z_x^3 + 75z_x}{(n-2)^2} +
\frac{1}{384} \frac{3z_x^7 - 81z_x^5 + 417z_x^3 - 315z_x}{(n-2)^3} \right )"/></p>
</div><p>where <img class="math" src="../_images/math/13ec3386d628b5ca8d96ff83af9b240831084348.png" alt="z_x"/> is the <img class="math" src="../_images/math/26eeb5258ca5099acf8fe96b2a1049c48c89a5e6.png" alt="x"/> percentile of the standard normal
distribution. In order to determine an arbitrary percentile of the standard
normal distribution, we use an <a class="reference external" href="http://home.online.no/~pjacklam/notes/invnorm/">unpublished rational approximation</a>. After
using the rational approximation, one iteration of Newton&#8217;s method is applied to
improve the estimate of the percentile.</p>
</div>
</div>
<div class="section" id="random-number-generation">
<h2>3.4. Random Number Generation<a class="headerlink" href="#random-number-generation" title="Permalink to this headline"></a></h2>
@ -195,7 +264,7 @@ simplest and commonly used algorithms is called a <a class="reference external"
generator</a>. We start with some random number seed <img class="math" src="../_images/math/da04290a79211712a58bf7241c9fb64251e000c3.png" alt="\xi_0"/> and a sequence
of random numbers is generated using the following recurrence relation:</p>
<div class="math" id="equation-lcg">
<p><span class="eqno">(9)</span><img src="../_images/math/838ea831f2458960d581811d15ea37bae3f20014.png" alt="\xi_{i+1} = g \xi_i + c \mod M"/></p>
<p><span class="eqno">(17)</span><img src="../_images/math/838ea831f2458960d581811d15ea37bae3f20014.png" alt="\xi_{i+1} = g \xi_i + c \mod M"/></p>
</div><p>where <img class="math" src="../_images/math/311cabda3a9b09f0dde217303ca9d1cd9201dcf6.png" alt="g"/>, <img class="math" src="../_images/math/3372c1cb6d68cf97c2d231acc0b47b95a9ed04cc.png" alt="c"/>, and <img class="math" src="../_images/math/5d1e4485dc90c450e8c76826516c1b2ccb8fce16.png" alt="M"/> are constants. The choice of these
constants will have a profound effect on the quality and performance of the
generator, so they should not be chosen arbitrarily. As Donald Knuth said in his
@ -215,11 +284,22 @@ us to skip ahead in <img class="math" src="../_images/math/c0db20de736ea9b9091c5
algorithm to do so is described in a paper by <a class="reference external" href="https://laws.lanl.gov/vhosts/mcnp.lanl.gov/pdf_files/anl_rn_arb-strides_1994.pdf">Brown</a>. This algorithm relies on
the following relationship:</p>
<div class="math" id="equation-lcg-skipahead">
<p><span class="eqno">(10)</span><img src="../_images/math/29e04a6d8160c6dd91ec828d9133bcdeff0f1fdc.png" alt="\xi_{i+k} = g^k \xi_i + c \frac{g^k - 1}{g - 1} \mod M"/></p>
</div><p>Note that equation <a href="#equation-lcg-skipahead">(10)</a> has the same form as equation <a href="#equation-lcg">(9)</a>
<p><span class="eqno">(18)</span><img src="../_images/math/29e04a6d8160c6dd91ec828d9133bcdeff0f1fdc.png" alt="\xi_{i+k} = g^k \xi_i + c \frac{g^k - 1}{g - 1} \mod M"/></p>
</div><p>Note that equation <a href="#equation-lcg-skipahead">(18)</a> has the same form as equation <a href="#equation-lcg">(17)</a>
so the idea is to determine the new multiplicative and additive constants in
<img class="math" src="../_images/math/c0db20de736ea9b9091c56adbd1e4111cc026472.png" alt="O(\log N)"/> operations.</p>
</div>
<div class="section" id="references">
<h2>3.5. References<a class="headerlink" href="#references" title="Permalink to this headline"></a></h2>
<table class="docutils citation" frame="void" id="george" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[George]</a></td><td>E. E. Olusegun George and Meenakshi Sivaram, &#8220;A modification of the
Fisher-Cornish approximation for the student t percentiles,&#8221; Communication
in Statistics - Simulation and Computation, 16 (4), pp. 1123-1132 (1987).</td></tr>
</tbody>
</table>
</div>
</div>

Binary file not shown.

View file

@ -29,7 +29,7 @@
<script type="text/javascript" src="_static/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="index.html" />
<link rel="next" title="License Agreement" href="license.html" />
<link rel="prev" title="2. xml-fortran Input Parsing" href="devguide/xml-fortran.html" />
<link rel="prev" title="3. State Point Binary File Specifications" href="devguide/statepoint.html" />
</head>
<body>
<div class="header">
@ -40,7 +40,7 @@
<div class="topnav">
<p>
«&#160;&#160;<a href="devguide/xml-fortran.html">2. xml-fortran Input Parsing</a>
«&#160;&#160;<a href="devguide/statepoint.html">3. State Point Binary File Specifications</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="index.html">Contents</a>
&#160;&#160;::&#160;&#160;
@ -74,7 +74,7 @@ pp. 125&#8211;135 (2012). [<a class="reference external" href="http://web.mit.ed
<div class="bottomnav">
<p>
«&#160;&#160;<a href="devguide/xml-fortran.html">2. xml-fortran Input Parsing</a>
«&#160;&#160;<a href="devguide/statepoint.html">3. State Point Binary File Specifications</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="index.html">Contents</a>
&#160;&#160;::&#160;&#160;

View file

@ -28,7 +28,7 @@
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="next" title="Release Notes for OpenMC 0.4.3" href="notes_0.4.3.html" />
<link rel="next" title="Release Notes for OpenMC 0.4.4" href="notes_0.4.4.html" />
<link rel="prev" title="Quick Install Guide" href="../quickinstall.html" />
</head>
<body>
@ -44,7 +44,7 @@
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a>&#160;&#160;»
<a href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a>&#160;&#160;»
</p>
</div>
@ -57,6 +57,7 @@
bugs fixed, and known issues for each successive release.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.2.html">Release Notes for OpenMC 0.4.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.1.html">Release Notes for OpenMC 0.4.1</a></li>
@ -74,7 +75,7 @@ bugs fixed, and known issues for each successive release.</p>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a>&#160;&#160;»
<a href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a>&#160;&#160;»
</p>
</div>

View file

@ -30,7 +30,7 @@
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Release Notes" href="index.html" />
<link rel="next" title="Release Notes for OpenMC 0.4.2" href="notes_0.4.2.html" />
<link rel="prev" title="Release Notes" href="index.html" />
<link rel="prev" title="Release Notes for OpenMC 0.4.4" href="notes_0.4.4.html" />
</head>
<body>
<div class="header">
@ -41,7 +41,7 @@
<div class="topnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
«&#160;&#160;<a href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
@ -54,11 +54,6 @@
<div class="section" id="release-notes-for-openmc-0-4-3">
<span id="notes-0-4-3"></span><h1>Release Notes for OpenMC 0.4.3<a class="headerlink" href="#release-notes-for-openmc-0-4-3" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These release notes are for an upcoming release of OpenMC and are still
subject to change.</p>
</div>
<div class="section" id="system-requirements">
<h2>System Requirements<a class="headerlink" href="#system-requirements" title="Permalink to this headline"></a></h2>
<p>There are no special requirements for running the OpenMC code. As of this
@ -69,7 +64,9 @@ the problem at hand (mostly on the number of nuclides in the problem).</p>
<div class="section" id="new-features">
<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Option to report confidence intervals for tally results.</li>
<li>Rotation and translation for filled cells.</li>
<li>Ability to explicitly specify &lt;estimator&gt; for tallies.</li>
<li>Ability to store state points and use them to restart runs.</li>
<li>Fixed source calculations (no subcritical multiplication however).</li>
<li>Expanded options for external source distribution.</li>
@ -82,6 +79,7 @@ the problem at hand (mostly on the number of nuclides in the problem).</p>
<div class="section" id="bug-fixes">
<h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/33f29a">33f29a</a>: Handle negative values in probability table.</li>
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/1c472d">1c472d</a>: Fixed survival biasing with probability tables.</li>
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/3c6e80">3c6e80</a>: Fixed writing tallies with no filters.</li>
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/460ef1">460ef1</a>: Invalid results for duplicate tallies.</li>
@ -98,7 +96,7 @@ the problem at hand (mostly on the number of nuclides in the problem).</p>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
«&#160;&#160;<a href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;

View file

@ -0,0 +1,114 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>Release Notes for OpenMC 0.4.4 &mdash; OpenMC Documentation</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Release Notes" href="index.html" />
<link rel="next" title="Release Notes for OpenMC 0.4.3" href="notes_0.4.3.html" />
<link rel="prev" title="Release Notes" href="index.html" />
</head>
<body>
<div class="header">
<a href="../index.html">
<img class="logo" src="../_static/openmc.png" alt="Logo"/>
</a>
</div>
<div class="topnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a>&#160;&#160;»
</p>
</div>
<div class="content">
<div class="section" id="release-notes-for-openmc-0-4-4">
<span id="notes-0-4-4"></span><h1>Release Notes for OpenMC 0.4.4<a class="headerlink" href="#release-notes-for-openmc-0-4-4" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These release notes are for an upcoming release of OpenMC and are still
subject to change.</p>
</div>
<div class="section" id="system-requirements">
<h2>System Requirements<a class="headerlink" href="#system-requirements" title="Permalink to this headline"></a></h2>
<p>There are no special requirements for running the OpenMC code. As of this
release, OpenMC has been tested on a variety of Linux distributions, Mac OS X,
and Microsoft Windows 7. Memory requirements will vary depending on the size of
the problem at hand (mostly on the number of nuclides in the problem).</p>
</div>
<div class="section" id="new-features">
<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Option to specify &lt;upper_right&gt; for tally meshes.</li>
</ul>
</div>
<div class="section" id="bug-fixes">
<h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a>&#160;&#160;»
</p>
</div>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30411614-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>

File diff suppressed because one or more lines are too long

View file

@ -76,21 +76,23 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
<li class="toctree-l1"><a class="reference internal" href="input.html">3. Writing XML Input Files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="input.html#overview-of-files">3.1. Overview of Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="input.html#settings-specification-settings-xml">3.2. Settings Specification &#8211; settings.xml</a><ul>
<li class="toctree-l3"><a class="reference internal" href="input.html#criticality-element">3.2.1. <tt class="docutils literal"><span class="pre">&lt;criticality&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#cross-sections-element">3.2.2. <tt class="docutils literal"><span class="pre">&lt;cross_sections&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#cutoff-element">3.2.3. <tt class="docutils literal"><span class="pre">&lt;cutoff&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#energy-grid-element">3.2.4. <tt class="docutils literal"><span class="pre">&lt;energy_grid&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#entropy-element">3.2.5. <tt class="docutils literal"><span class="pre">&lt;entropy&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#fixed-source-element">3.2.6. <tt class="docutils literal"><span class="pre">&lt;fixed_source&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#no-reduce-element">3.2.7. <tt class="docutils literal"><span class="pre">&lt;no_reduce&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#ptables-element">3.2.8. <tt class="docutils literal"><span class="pre">&lt;ptables&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#seed-element">3.2.9. <tt class="docutils literal"><span class="pre">&lt;seed&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#source-element">3.2.10. <tt class="docutils literal"><span class="pre">&lt;source&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#survival-biasing-element">3.2.11. <tt class="docutils literal"><span class="pre">&lt;survival_biasing&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#trace-element">3.2.12. <tt class="docutils literal"><span class="pre">&lt;trace&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#uniform-fs-element">3.2.13. <tt class="docutils literal"><span class="pre">&lt;uniform_fs&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#verbosity-element">3.2.14. <tt class="docutils literal"><span class="pre">&lt;verbosity&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#write-source-element">3.2.15. <tt class="docutils literal"><span class="pre">&lt;write_source&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#confidence-intervals-element">3.2.1. <tt class="docutils literal"><span class="pre">&lt;confidence_intervals&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#criticality-element">3.2.2. <tt class="docutils literal"><span class="pre">&lt;criticality&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#cross-sections-element">3.2.3. <tt class="docutils literal"><span class="pre">&lt;cross_sections&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#cutoff-element">3.2.4. <tt class="docutils literal"><span class="pre">&lt;cutoff&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#energy-grid-element">3.2.5. <tt class="docutils literal"><span class="pre">&lt;energy_grid&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#entropy-element">3.2.6. <tt class="docutils literal"><span class="pre">&lt;entropy&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#fixed-source-element">3.2.7. <tt class="docutils literal"><span class="pre">&lt;fixed_source&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#no-reduce-element">3.2.8. <tt class="docutils literal"><span class="pre">&lt;no_reduce&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#ptables-element">3.2.9. <tt class="docutils literal"><span class="pre">&lt;ptables&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#seed-element">3.2.10. <tt class="docutils literal"><span class="pre">&lt;seed&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#source-element">3.2.11. <tt class="docutils literal"><span class="pre">&lt;source&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#survival-biasing-element">3.2.12. <tt class="docutils literal"><span class="pre">&lt;survival_biasing&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#trace-element">3.2.13. <tt class="docutils literal"><span class="pre">&lt;trace&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#uniform-fs-element">3.2.14. <tt class="docutils literal"><span class="pre">&lt;uniform_fs&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#verbosity-element">3.2.15. <tt class="docutils literal"><span class="pre">&lt;verbosity&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#write-state-point-element">3.2.16. <tt class="docutils literal"><span class="pre">&lt;write_state_point&gt;</span></tt> Element</a></li>
<li class="toctree-l3"><a class="reference internal" href="input.html#write-source-element">3.2.17. <tt class="docutils literal"><span class="pre">&lt;write_source&gt;</span></tt> Element</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="input.html#geometry-specification-geometry-xml">3.3. Geometry Specification &#8211; geometry.xml</a><ul>

View file

@ -94,8 +94,18 @@ which should be plotted. OpenMC expects that these files are called:</p>
<h2>3.2. Settings Specification &#8211; settings.xml<a class="headerlink" href="#settings-specification-settings-xml" title="Permalink to this headline"></a></h2>
<p>All simulation parameters and miscellaneous options are specified in the
settings.xml file.</p>
<div class="section" id="confidence-intervals-element">
<h3>3.2.1. <tt class="docutils literal"><span class="pre">&lt;confidence_intervals&gt;</span></tt> Element<a class="headerlink" href="#confidence-intervals-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;confidence_intervals&gt;</span></tt> element has no attributes and has an accepted
value of &#8220;on&#8221; or &#8220;off&#8221;. If set to &#8220;on&#8221;, uncertainties on tally results will be
reported as the half-width of the 95% two-sided confidence interval. If set to
&#8220;off&#8221;, uncertainties on tally results will be reported as the sample standard
deviation.</p>
<blockquote>
<div><em>Default</em>: off</div></blockquote>
</div>
<div class="section" id="criticality-element">
<h3>3.2.1. <tt class="docutils literal"><span class="pre">&lt;criticality&gt;</span></tt> Element<a class="headerlink" href="#criticality-element" title="Permalink to this headline"></a></h3>
<h3>3.2.2. <tt class="docutils literal"><span class="pre">&lt;criticality&gt;</span></tt> Element<a class="headerlink" href="#criticality-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;criticality&gt;</span></tt> element indicates that a criticality calculation should be
performed. It has the following attributes/sub-elements:</p>
<blockquote>
@ -130,7 +140,7 @@ immediately.</p>
</div></blockquote>
</div>
<div class="section" id="cross-sections-element">
<span id="cross-sections"></span><h3>3.2.2. <tt class="docutils literal"><span class="pre">&lt;cross_sections&gt;</span></tt> Element<a class="headerlink" href="#cross-sections-element" title="Permalink to this headline"></a></h3>
<span id="cross-sections"></span><h3>3.2.3. <tt class="docutils literal"><span class="pre">&lt;cross_sections&gt;</span></tt> Element<a class="headerlink" href="#cross-sections-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;cross_sections&gt;</span></tt> element has no attributes and simply indicates the path
to an XML cross section listing file (usually named cross_sections.xml). If this
element is absent from the settings.xml file, the <span class="target" id="index-0"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt>
@ -138,7 +148,7 @@ environment variable will be used to find the path to the XML cross section
listing.</p>
</div>
<div class="section" id="cutoff-element">
<h3>3.2.3. <tt class="docutils literal"><span class="pre">&lt;cutoff&gt;</span></tt> Element<a class="headerlink" href="#cutoff-element" title="Permalink to this headline"></a></h3>
<h3>3.2.4. <tt class="docutils literal"><span class="pre">&lt;cutoff&gt;</span></tt> Element<a class="headerlink" href="#cutoff-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;cutoff&gt;</span></tt> element indicates the weight cutoff used below which particles
undergo Russian roulette. Surviving particles are assigned a user-determined
weight. Note that weight cutoffs and Russian rouletting are not turned on by
@ -162,7 +172,7 @@ roulette.</p>
</div></blockquote>
</div>
<div class="section" id="energy-grid-element">
<h3>3.2.4. <tt class="docutils literal"><span class="pre">&lt;energy_grid&gt;</span></tt> Element<a class="headerlink" href="#energy-grid-element" title="Permalink to this headline"></a></h3>
<h3>3.2.5. <tt class="docutils literal"><span class="pre">&lt;energy_grid&gt;</span></tt> Element<a class="headerlink" href="#energy-grid-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;energy_grid&gt;</span></tt> element determines the treatment of the energy grid during
a simulation. Setting this element to &#8220;nuclide&#8221; will cause OpenMC to use a
nuclide&#8217;s energy grid when determining what points to interpolate between for
@ -173,7 +183,7 @@ treatment is slightly different than that employed in Serpent.</p>
<div><em>Default</em>: union</div></blockquote>
</div>
<div class="section" id="entropy-element">
<h3>3.2.5. <tt class="docutils literal"><span class="pre">&lt;entropy&gt;</span></tt> Element<a class="headerlink" href="#entropy-element" title="Permalink to this headline"></a></h3>
<h3>3.2.6. <tt class="docutils literal"><span class="pre">&lt;entropy&gt;</span></tt> Element<a class="headerlink" href="#entropy-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;entropy&gt;</span></tt> element describes a mesh that is used for calculating Shannon
entropy. This mesh should cover all possible fissionable materials in the
problem. It has the following attributes/sub-elements:</p>
@ -203,7 +213,7 @@ problem. It has the following attributes/sub-elements:</p>
</div></blockquote>
</div>
<div class="section" id="fixed-source-element">
<h3>3.2.6. <tt class="docutils literal"><span class="pre">&lt;fixed_source&gt;</span></tt> Element<a class="headerlink" href="#fixed-source-element" title="Permalink to this headline"></a></h3>
<h3>3.2.7. <tt class="docutils literal"><span class="pre">&lt;fixed_source&gt;</span></tt> Element<a class="headerlink" href="#fixed-source-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;fixed_source&gt;</span></tt> element indicates that a fixed source calculation should be
performed. It has the following attributes/sub-elements:</p>
<blockquote>
@ -225,7 +235,7 @@ represents a realization of random variables for tallies.</p>
</div></blockquote>
</div>
<div class="section" id="no-reduce-element">
<h3>3.2.7. <tt class="docutils literal"><span class="pre">&lt;no_reduce&gt;</span></tt> Element<a class="headerlink" href="#no-reduce-element" title="Permalink to this headline"></a></h3>
<h3>3.2.8. <tt class="docutils literal"><span class="pre">&lt;no_reduce&gt;</span></tt> Element<a class="headerlink" href="#no-reduce-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;no_reduce&gt;</span></tt> element has no attributes and has an accepted value of &#8220;on&#8221;
or &#8220;off&#8221;. If set to &#8220;on&#8221;, all user-defined tallies and global tallies will not
be reduced across processors in a parallel calculation. This means that the
@ -236,7 +246,7 @@ tally data, this option can significantly improve the parallel efficiency.</p>
<div><em>Default</em>: off</div></blockquote>
</div>
<div class="section" id="ptables-element">
<h3>3.2.8. <tt class="docutils literal"><span class="pre">&lt;ptables&gt;</span></tt> Element<a class="headerlink" href="#ptables-element" title="Permalink to this headline"></a></h3>
<h3>3.2.9. <tt class="docutils literal"><span class="pre">&lt;ptables&gt;</span></tt> Element<a class="headerlink" href="#ptables-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;ptables&gt;</span></tt> element determines whether probability tables should be used
in the unresolved resonance range if available. This element has no attributes
or sub-elements and can be set to either &#8220;off&#8221; or &#8220;on&#8221;.</p>
@ -244,14 +254,14 @@ or sub-elements and can be set to either &#8220;off&#8221; or &#8220;on&#8221;.<
<div><em>Default</em>: on</div></blockquote>
</div>
<div class="section" id="seed-element">
<h3>3.2.9. <tt class="docutils literal"><span class="pre">&lt;seed&gt;</span></tt> Element<a class="headerlink" href="#seed-element" title="Permalink to this headline"></a></h3>
<h3>3.2.10. <tt class="docutils literal"><span class="pre">&lt;seed&gt;</span></tt> Element<a class="headerlink" href="#seed-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">seed</span></tt> element is used to set the seed used for the linear congruential
pseudo-random number generator.</p>
<blockquote>
<div><em>Default</em>: 1</div></blockquote>
</div>
<div class="section" id="source-element">
<h3>3.2.10. <tt class="docutils literal"><span class="pre">&lt;source&gt;</span></tt> Element<a class="headerlink" href="#source-element" title="Permalink to this headline"></a></h3>
<h3>3.2.11. <tt class="docutils literal"><span class="pre">&lt;source&gt;</span></tt> Element<a class="headerlink" href="#source-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">source</span></tt> element gives information on an external source distribution to
be used either as the source for a fixed source calculation or the initial
source guess for criticality calculations. It takes the following
@ -353,7 +363,7 @@ c E e^{-E/a} dE"/>.</p>
</div></blockquote>
</div>
<div class="section" id="survival-biasing-element">
<h3>3.2.11. <tt class="docutils literal"><span class="pre">&lt;survival_biasing&gt;</span></tt> Element<a class="headerlink" href="#survival-biasing-element" title="Permalink to this headline"></a></h3>
<h3>3.2.12. <tt class="docutils literal"><span class="pre">&lt;survival_biasing&gt;</span></tt> Element<a class="headerlink" href="#survival-biasing-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;survival_biasing&gt;</span></tt> element has no attributes and has an accepted value
of &#8220;on&#8221; or &#8220;off&#8221;. If set to &#8220;on&#8221;, this option will enable the use of survival
biasing, otherwise known as implicit capture or absorption.</p>
@ -361,7 +371,7 @@ biasing, otherwise known as implicit capture or absorption.</p>
<div><em>Default</em>: off</div></blockquote>
</div>
<div class="section" id="trace-element">
<span id="trace"></span><h3>3.2.12. <tt class="docutils literal"><span class="pre">&lt;trace&gt;</span></tt> Element<a class="headerlink" href="#trace-element" title="Permalink to this headline"></a></h3>
<span id="trace"></span><h3>3.2.13. <tt class="docutils literal"><span class="pre">&lt;trace&gt;</span></tt> Element<a class="headerlink" href="#trace-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;trace&gt;</span></tt> element can be used to print out detailed information about a
single particle during a simulation. This element should be followed by three
integers: the batch number, generation number, and particle number.</p>
@ -369,7 +379,7 @@ integers: the batch number, generation number, and particle number.</p>
<div><em>Default</em>: None</div></blockquote>
</div>
<div class="section" id="uniform-fs-element">
<h3>3.2.13. <tt class="docutils literal"><span class="pre">&lt;uniform_fs&gt;</span></tt> Element<a class="headerlink" href="#uniform-fs-element" title="Permalink to this headline"></a></h3>
<h3>3.2.14. <tt class="docutils literal"><span class="pre">&lt;uniform_fs&gt;</span></tt> Element<a class="headerlink" href="#uniform-fs-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;uniform_fs&gt;</span></tt> element describes a mesh that is used for re-weighting
source sites at every generation based on the uniform fission site methodology
described in Kelly et al., &#8220;MC21 Analysis of the Nuclear Energy Agency Monte
@ -398,7 +408,7 @@ problem. It has the following attributes/sub-elements:</p>
</div></blockquote>
</div>
<div class="section" id="verbosity-element">
<h3>3.2.14. <tt class="docutils literal"><span class="pre">&lt;verbosity&gt;</span></tt> Element<a class="headerlink" href="#verbosity-element" title="Permalink to this headline"></a></h3>
<h3>3.2.15. <tt class="docutils literal"><span class="pre">&lt;verbosity&gt;</span></tt> Element<a class="headerlink" href="#verbosity-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;verbosity&gt;</span></tt> element tells the code how much information to display to
the standard output. A higher verbosity corresponds to more information being
displayed. This element takes the following attributes:</p>
@ -415,8 +425,19 @@ displayed. This element takes the following attributes:</p>
</table>
</div></blockquote>
</div>
<div class="section" id="write-state-point-element">
<h3>3.2.16. <tt class="docutils literal"><span class="pre">&lt;write_state_point&gt;</span></tt> Element<a class="headerlink" href="#write-state-point-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;write_state_point&gt;</span></tt> element is used to indicate batches at which the
user wishes to have a binary state point file written to disk. The state point
file can be used to restart a run or to get tally results at an intermediate
stage. This element has no attributes and should consist of a list of integers
corresponding to batches at which a binary state point file should be written to
disk.</p>
<blockquote>
<div><em>Default</em>: None</div></blockquote>
</div>
<div class="section" id="write-source-element">
<h3>3.2.15. <tt class="docutils literal"><span class="pre">&lt;write_source&gt;</span></tt> Element<a class="headerlink" href="#write-source-element" title="Permalink to this headline"></a></h3>
<h3>3.2.17. <tt class="docutils literal"><span class="pre">&lt;write_source&gt;</span></tt> Element<a class="headerlink" href="#write-source-element" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">&lt;write_source&gt;</span></tt> element has no attributes and has an accepted value of
&#8220;on&#8221; or &#8220;off&#8221;. If set to &#8220;on&#8221;, a binary source file will be written to disk at
the end of the run that can be used as a starting source for another run.</p>
@ -579,9 +600,9 @@ bounding surfaces would be given as &#8220;-3 5&#8221;.</p>
</tr>
<tr class="field-even field"><th class="field-name">rotation:</th><td class="field-body"><p class="first">If the cell is filled with a universe, this element specifies the angles in
degrees about the x, y, and z axes that the filled universe should be
rotated. Should be given as three real numbers.For example, if you wanted to
rotate the filled universe by 90 degrees about the z-axis, the cell element
would look something like:</p>
rotated. Should be given as three real numbers. For example, if you wanted
to rotate the filled universe by 90 degrees about the z-axis, the cell
element would look something like:</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt">&lt;cell</span> <span class="na">fill=</span><span class="s">&quot;...&quot;</span> <span class="na">rotation=</span><span class="s">&quot;0 0 90&quot;</span> <span class="nt">/&gt;</span>
</pre></div>
</div>
@ -730,15 +751,30 @@ post-collision energy, and an arbitrary structured mesh.</p>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">label:</th><td class="field-body">This is an optional sub-element specifying the name of this tally to be used
<tr class="field-odd field"><th class="field-name">label:</th><td class="field-body"><p class="first">This is an optional sub-element specifying the name of this tally to be used
for output purposes. This string is limited to 52 characters for formatting
purposes.</td>
purposes.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">filters:</th><td class="field-body">A list of filters to specify what region of phase space should contribute to
the tally. See below for full details on what filters are available.</td>
<tr class="field-even field"><th class="field-name">filters:</th><td class="field-body"><p class="first">A list of filters to specify what region of phase space should contribute to
the tally. See below for full details on what filters are available.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">scores:</th><td class="field-body">The desired responses to be accumulated. See below for full details on what
responses can be tallied.</td>
<tr class="field-odd field"><th class="field-name">nuclides:</th><td class="field-body"><p class="first">If specified, the scores listed will be for particular nuclides, not the
summation of reactions from all nuclides. The format for nuclides should be
[Atomic symbol]-[Mass number], e.g. &#8220;U-235&#8221;. The reaction rate for all
nuclides can be obtained with &#8220;total&#8221;. For example, to obtain the reaction
rates for U-235, Pu-239, and all nuclides in a material, this element should
be:</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt">&lt;nuclides&gt;</span>U-235 Pu-239 total<span class="nt">&lt;/nuclides&gt;</span>
</pre></div>
</div>
<p><em>Default</em>: total</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">scores:</th><td class="field-body"><p class="first last">The desired responses to be accumulated. See below for full details on what
responses can be tallied.</p>
</td>
</tr>
</tbody>
</table>