From f5748f2d7d2431271a4a29a31afba0fa9d978c00 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Thu, 13 Oct 2011 16:36:31 -0400 Subject: [PATCH] Updated documentation with new theme and expanded description of input for geometry and materials. --- docs/img/openmc.png | Bin 0 -> 8862 bytes docs/source/conf.py | 10 +-- docs/source/usersguide/input.rst | 108 +++++++++++++++++++++++++++---- 3 files changed, 103 insertions(+), 15 deletions(-) create mode 100644 docs/img/openmc.png diff --git a/docs/img/openmc.png b/docs/img/openmc.png new file mode 100644 index 0000000000000000000000000000000000000000..9f5e97cd6e844052caf6e6095a5088922eb89113 GIT binary patch literal 8862 zcmaJ{cRX9~_ZP88@iB@TAGG$~wQH}~sz!?1yNFS0wf5drYKvL4c4MWbs8+425h7Jo zC{n~8-~0LV_s{RXUPWh=%qUFLlUfMU_}8O&naA!fosaA`nJKq{qz5QK$?Q^aG;S5rt=798Q=~Ja}IJN z3JVJp_wx4%c5!~{CLR#v0pC+$CnEZn$UysnRru@O(y+d}I;E(=IhjKYI?5hi1a-PC zpUn^ljSpo2Jy2EAnPz0Y8weU5f@UC3@xxKDFA;j%)<_^UHuhQLom9alPia^zYuOnpMIM9DZ~ZIq_VwrcFt zVf~zO^Tc{Yts2zzHPdzs;UqnjJ)jD)yBIC;lo;>tB=lKRCi zyXLE2IJUy_P5X>c$OVJ(XOj2;L(BK~KD~$a|C-i%AIy3mMEaKXR2?fZLtx2rQf9k} z*RD?JpRSIV8R=2(of`4{Pw}-_>ZG1kg zzqDrO3e>~YOv5eafDOe(IA+xrv9Xn6H6ELpa!5b}vfllniG`_xo_D#=CQ~qT`A8NTTUfKq|NU%k*0JAf&aR$O?)4m$5^! znqQ?jkG>xW;vz2fx167nXi*v9TH(&W6DO=n)upVk^znOOp_SdIx9%@k(A=8c^7Y3>GQ}H$?e6W7So4uNY9OsAxI3 zLUqA!&biOJeo<_SVmbu-=@UZ0N0cMRRXM4mt~EdlE;<}YhhLJ!+syeJGXV-6pm?tI z6B|QpLI=JHpd?uEK=<{JvQNf}y{}OAA5k|^0!v>{e`_HzLwyw&4F~;_cy(FbtNXXa zXtoz+XfE}X7cz;&iA)UZBV_P6K)E;#I4PFXbH(vB*R~XP3wV*0!Y~yuw>pqx%6)7< zN&x88#ZuKI1=imU`VEp1vp%2B?QXa?kxqk)$eT_~A{gzwM17RRm*07*wvzBL=KJ9{ zNxTHkN%=R3JF_83;i(<#>3nG8L`fGlDh6B*LW<3m5#6E%$J`q>UgcHJPy`WVP@F;_ zQhKs$#Mar_zNj@nkxi{F&)8VK3#B`{+#j1)y?nc7hcnGqBku9Wo|SSPgG9yiqo|d@ z{~n5#qPdi)3YqF6|DcIo8sqpVT2lqTz92VkPWS(@;r6D0Kh_KA3de)?+>G21{s7 zju`hb^*lnBdC~)FI6z5A`do;h;J|%#mZcCa*3%71yy=IQJ7~JobHPv{mkR+CeF%w~ zyd5W?d!@CDcEuUK&e=o~@sU3a(j**=WY=fA9n+%I`R5eaP@{qv&@F|G8Z}}Lr$wA4 zuxz@n_BwT0PaSo4>W!b9As;WNd>gC3hqF7I+=jU@ojPcqF*%vT{hot*{eH!y7f=I2 zz7tzLEt1@+Lf6Mnb9twm!6N4+{~0OFUJ0!KI-_$(UG-!Z5Feq?^b{ujwnVsp%lgaM4?L4XW#fcefA&vCm4v!1xCFOtciR zr0M!774Okp&g&sPD|Gb@=Fybl|W%yfPK%`CVEuN?>`C69vdJS;uB&>co@YamKFRCW{^-w%sND z3#u4>yI%mbC|Yp(yetQC*O|w3Jwjrf4Z1962%C>meSEX4by5Z`&xd~cJkG%z(QhU?FXiatJ|EGu;S=&GQ4W!!|h0W)On{xk78N` z8Q~~KrP?X-=DcEK&B@K_P|i^3m*HFbCl>xQx6(M@59PKzBj4qtQk{)p5rvYg*t0DM z`TRY**dvl}G9gnllBgk41B|y%5>KwQ5M9twE$F#I^OLU_A|_4+UhQg=Zy6iH>qJ#m z_NB}Bv4_RSwbty2fusEd)fn`p@t3Nbq%XRw_#}L_j<`89ST+OhV)g_3Vg2P`b*>3& zo**W|RA6i-l5yUiX(^>UeH6Xaa>I+{4^4TlKtXP1 zCR9DHLnXt4f#O!fU*+wq4O*}-e>c3L>3frc435piy&bSbVt%4T;0tbzu>J%9`f?mX zdNNWx9Z?bIDGJY6ZLI1dlZX##H*6B(Zl<h1$@L+ccDTTxA?Bfi|Oi`#sV$4;*A z&M6qrlFQj%SIt}yW;EYxjKu6w6407ROrKylS_{?iovNNJp2aSqtZ!EN5P$hq$HR2t zaLc}TQ~dfhJ@03>?}pF5lzcJwM&U{gR(#5~%B*%I)99ZhU8X0j;xHRn5oBlt?w!eg zy102UJ!QQ&_hIr!lGhkE^7Y!?gAK|^?!(@_XK8f)Vc&$I0rH!8O*(VVE4d(VSD_Vy zHC=N$yDkOgjYz(KY0)?);B|xdATOz#e-&~6%q`e0k5P|NmnW*LaYK@KRe*_o6%?l-E=qwh z4Nx+UR_)p8g2bwY94n@7_kzlLJtT$~dmis{R9Qz6qaB&19(RktFsd9YQnRzjA!5k@ zagzXFt9Dgcmhwy+{!!#$cYnhxF%z<816xZ#dYjFFT%m(@k9Lw-C*^$@nH#B=$zfqjPc7)o30L z;z)Yff-YMK(74d)VszMz+*+`ge`qdL>c~bDgAUtoP8ayHH~E?lTs4OZDNl zx3{|(Cf#_tVUuq`U|{2(fD|7HY>J&ZM=xEzY?#(caVUDqZ*r4OzZQY8l7g%f)$B}s zx->&JpYzaMY9KKo#d^vY72KM&#im|MF>FuM5vP;R*m;v7|524(N8%a=3yH)F_9-PH zbn3VI(OEC>YzJ+w7H6HRvkh1xi_xqTz<&T48I(S5Q5ki%>L@_G0e3(&;4bu-yic0u z(#;tQC;2Wfh>&NoQ9a80PgEH^5DTfLip zEvOJubRUpOUqzZ_YGnc48}^7jjLi7YaTyw7s@R~L+Q`%KIU@IbQo=xhy{avkqA<^SD0dQu4BY&DLoR);5m*ubp28M<+n_H%%& zBfE{%$x)$%(~Hr5#3he3N-WUw!BnNOsbQN&79Y)JOvMDfvA@m@KQv%pb`;3FB;BC~ zY~esqD331Dwt9bL1^9F|JG44iQBDC&NLdB~p3arTP(gdrj2b2SShH9zfPTuWk?g~J)Dzu-Ef+}aSqa*2@3 za;#45l20$x8HjZJ!{Z4l_Qxv^p#oSZbZ#2_T+f4W5%S7)WHmeeOzk%uC`h6?Q%=ye ziPja{3?URU{bm=*IgxM8`Qd|TGtUq2XUonOCNHnFty3(Q9k|2{!cq?Ew=BoT9D@@z*TF~mb zU#&CmYKBbUNamJGO5nOL)y2W)Z^3|w<5sKjW>$)mrWuW2`%F)Sam{~bg(s3yq#0J6 zg`x{!{dZdd!R)4mBBTQ?UmQj&Yi@sf>Igpn*uC+JdxGZE?h_w55(lUjQnXLlAYYfK|qGy43}z!Tkg*Vp7zAfM0_od~@5tH%^wwxZh0C?;l)XSa4Kh0sy`P^t!j zX~UHWYRvcGy}(!leO2Fu!b0_qcdZ3LQfN5eTcoRwx-usCyme!E|0eq7*akypyg#L3 zrPpu^I8SoRn8! zO)8H4nK%$8{d3&=PiaR`jMm}~kl(SAU9Uov4d>C+rL42V8GyhZ(u05mApzDuCtJc; zBc=5gdXogMX8+O$eeJn1zV6$rDBa9GuRm}9B2&rCR2a@r&1n#{H2f~_%`Z6KnsI5| zUeP?cP=(hU0t^14L~CiB|#-~1EF zd_GrO4b@k6IDaxjEbMo)Q`JJNB$aFLD0?wkTRV;7uGV0drYJ5XDS=r+zHc~5o}Bh zt$kkmx;S^&r%+b3#@D1^G~=P39nXPb47}2l^EeNlm;-ww&)I8_Ec08Ewqr9|o4yWK z)l9DC16iFb6iTYk>7~^cY<6l_H%Qo~lDZ$}n!03_y%UA>GVD?`>>doXjK(=DbIo!b z*N^!`_5~4d61f+3xWpQ?F?cF3=<3LGcWgfSB0}0oT<}k$gLVO#IRa$$j$5vyU>wUL z42Cz*_|71!1_)MNE!BN)v>RegLP;V*0nud#wSYBUk|Q!E&6e=82!d(#P~^z90<&>f z!A6x<+fUy$2_F~7yqUfiQ5)Ze5uU#uGX`YwdJxe^MHeCVXaUS#*6sy{*c3-d+}$s1 z>0S|>@+s<+`1tza)ecHTw@w+Cl3Tp=yi(lz5YOi|=6%pW1tCjd=qhNEkt&wWA1Zi% zP$>6Iu0!s2GoHCV|De(0o3+i~quy~5t6K;v!2y_$P1|kV8o}}DxYI&2 zc_e7I%Y?^*QeswrJI43CR;d?med~g4p}L#Dd26n_R~Lzy)#wL# zRAp0vWAu?2iP-blG{&i>!oQW#Bb1#n>seDV{{4jG${9i?HTcG+dcN7}IZ5!xVR&_p zvvT^n<%sNoPqL@&J>-=9l;>OID8)T;&!o1%yPqhi8b}KAVXEYZ+n#oS`&HMYenpzt z#)tsod9k+`zr`C<14>QNWs~acr3XmN^4P9$W0Zrywd zQ+%~h!eWs_^+6U*`|pNiIwcZ>D<9(7k~bFr8Y8o;h} ze7-S5XsL(X@6MP?X-i&`E*apu*mAQ#-vr2Bzc*p%*>8xTBUR$D)BXj$=qdi&o40C;Y-$i=Lrna=b zDLCfc8@{|jq>2G7X%O~H;hL%8d^^Ncj}#ZtzoqfQTDeaFOlLSBNykbv0fcIlN(0>~ zvo$-<_@*Ycc|io#KbUn#O7Q9?)f5%ygb@qd>MKn$b+`6MEk7f^Ho0&Yw9K2|8=RHd zC~kRA9^L)+SG3J0|HL`0gkDT8Un;#Op2foN3B4{cy-6+}fL7%tW6U;VwVv$LDAv=ao1h(POsB-4y=EuWbYAq@^}5gI`dD`v^{1>Ol21iO}W6y6e9}V_u>5d zI!8Z$9Z!Y5Din^X8oKpi3+v9kh5bA5@=OTMs;Ov^4PQ2|C35s@cO0VN37wd9I6C|I zb;ToOQrUBL4@!5Y>HK5QW`p14%9JNwY(`tGE5{10B-FGgq^qwZg5nP=d{`HO!k@j> z(U+V4o?1pan;!sB!dB+ARSZ~rDfK_dH~{lI8N&v>YIY#xEu_B02VVg~QjV$t@HbU; z|H$7dH6wWaPdCQ|Ll4rHP40W=?zQ-kH(u+o8+*cTBo3VX4Ef-6Sb87+&w) zORstS!ZvKNFgx`Wgi~R>E|&iTBlfF%pDHcVPj~o!i%c9yU-mp{G^+FwVNWKY-O?8y0GL*g8jIxy6LwQD&I^c7ZGhpD z;ctJnoqe$5l%yB(t|`PB>&Ru@Wg9RF7T5OJ+D&eVy89Xv_wCyOZO6}7DFrB>DtOr4 zMbaJ}2>LyGSJ{VK3=l+==?Cinf|#*Mx8NsFoK}ms>4^6P*{ddq`~f;& z3l|}iC#?7LNr0}12;@df9sf<=G`mC+uTU`?1=r=jg@@oG6b$B-wLQ~E88nRrzdm|f z6ZxTXb!L^)qZg-{U9 zMn+3jBHlDY@RLT-9VdHm@$LoymeYR+QstF0ddVEgmxZAFc0jejxap=*2jE!$WARlo zYmN%NqM*=XxC|Z0i5FlR0T)tSCa*g7UJ{08f|LdkCA)bFY=q? ziSd*te`2UqrP3-ua|uMt<+1XlTdoH=iiuOyhLNL`f}R%o)&SgKB=L?3@=XB(Jq{c? zSmL9s@EF!pKDJ*Cagz8iz+>t1QJxArJI$y#XKZ(V8CushJd!?wv?IhSVH{id#A_wb zhE_HBH$2scOIc57&hYtZo8&7JMKaK==*KsTx6ioX|2d=!JA;D~?ezxpJGo)Db?D?C z?nA8xF&^uC(u%4Se&URN2ZAD!JRwi93m68#hKjTm%awnH3C z0i$W`k4;#ZppdWbyr!#~wOge>W6KcXy?3PtKvE``ZT}tBjpi^G@ha01G1Mn#Y?kYr zqor%1qtvZWGlaq_+Q6bJZmyiiy0qlOmK!sCjSDB;fQ->b0GR>x8k!Z!x9F;foG=p( zussY1Y6{fBYCKFEm2({;HNqQp*6;QuDD-%O3>8i8NvnHqg}HWjmyB59y7UYD7(Ydw zt35r_?_>zPpCJ-th{V*muel%q_6Z$}uGxuV5~Ii>x}_r#E{58xTgV!y+t-rNgaVR1#BQ`<&{Iq;^d>&MbfPAn!?EB!)Xzl!^ib! zWvv$uH~pnoR9o=6g5$>4K_SGz)NsJ#0KxR*uk+RkTmYMgR@{0yJKPXenCl;upHVN`o5vXFUGB*?jNx4 z_%EwXAb*IGXIB2LP43;A#gGIlXf21?2`WIp53P>E`^|NA#TpW v documentation". -#html_title = None +html_title = "OpenMC Documentation" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = '../../img/pyne_icon_small.png' +html_logo = '../img/openmc.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/docs/source/usersguide/input.rst b/docs/source/usersguide/input.rst index 8dbbc5d09a..873ce2cb4f 100644 --- a/docs/source/usersguide/input.rst +++ b/docs/source/usersguide/input.rst @@ -94,51 +94,137 @@ could be written as:: -.. _constructive solid geometry: http://en.wikipedia.org/wiki/Constructive_solid_geometry +Each ``surface`` element can have the following attributes or sub-elements: -.. _quadratic surfaces: http://en.wikipedia.org/wiki/Quadric + :uid: + A unique integer that can be used to identify the surface. -Types of surfaces: + *Default*: None -``x-plane`` + :type: + The type of the surfaces. This can be ``x-plane``, ``y-plane``, ``z-plane``, + ``plane``, ``x-cylinder``, ``y-cylinder``, ``z-cylinder``, or ``sphere``. + + *Default*: None + + :coeffs: + The corresponding coefficients for the given type of surface. See below for + a list a what coefficients to specify for a given surface + + *Default*: None + + :boundary: + The boundary condition for the surface. This can be ``vacuum`` or ``reflective``. + + *Default*: ``reflective`` + +Each ``cell`` element can have the following attributes or sub-elements: + + :uid: + A unique integer that can be used to identify the surface. + + *Default*: None + + :universe: + The ``uid`` of the universe that this cell is contained in. + + *Default*: 0 + + :fill: + The ``uid`` of the universe that fills this cell. + + .. note:: If a fill is specified, no material should be given. + + *Default*: None + + :material: + The ``uid`` of the material that this cell contains. + + .. note:: If a material is specified, no fill should be given. + + *Default*: None + + :surfaces: + A list of the ``uids`` for surfaces that bound this cell, e.g. if the cell + is on the negative side of surface 3 and the positive side of surface 5, the + bounding surfaces would be given as "-3 5". + + *Default*: None + +The following quadratic surfaces can be modeled: + +:x-plane: A plane perpendicular to the x axis, i.e. a surface of the form :math:`x - x_0 = 0`. The coefficients specified are ":math:`x_0`". -``y-plane`` +:y-plane: A plane perpendicular to the y axis, i.e. a surface of the form :math:`y - y_0 = 0`. The coefficients specified are ":math:`y_0`". -``z-plane`` +:z-plane: A plane perpendicular to the z axis, i.e. a surface of the form :math:`z - z_0 = 0`. The coefficients specified are ":math:`z_0`". -``plane`` +:plane: An arbitrary plane of the form :math:`Ax + By + Cz = D`. The coefficients specified are ":math:`A \: B \: C \: D`". -``x-cylinder`` +:x-cylinder: An infinite cylinder whose length is paralle to the x-axis. This is a quadratic surface of the form :math:`(y - y_0)^2 + (z - z_0)^2 = R^2`. The coefficients specified are ":math:`y_0 \: z_0 \: R`". -``y-cylinder`` +:y-cylinder: An infinite cylinder whose length is paralle to the y-axis. This is a quadratic surface of the form :math:`(x - x_0)^2 + (z - z_0)^2 = R^2`. The coefficients specified are ":math:`x_0 \: z_0 \: R`". -``z-cylinder`` +:z-cylinder: An infinite cylinder whose length is paralle to the z-axis. This is a quadratic surface of the form :math:`(x - x_0)^2 + (y - y_0)^2 = R^2`. The coefficients specified are ":math:`x_0 \: y_0 \: R`". -``sphere`` +:sphere: A sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 = R^2`. The coefficients specified are ":math:`x_0 \: y_0 \: z_0 \: R`". +.. _constructive solid geometry: http://en.wikipedia.org/wiki/Constructive_solid_geometry + +.. _quadratic surfaces: http://en.wikipedia.org/wiki/Quadric + ---------------------------------------- Materials Specification -- materials.xml ---------------------------------------- +Each ``material`` element can have the following attributes or sub-elements: + + :density: + An element with attributes/sub-elements called ``value`` and ``units``. The + ``value`` attribute is the numeric value of the density while the ``units`` + can be "g/cm3", "kg/m3", "atom/b-cm", or "atom/cm3". For example, this could + be specified as:: + + + + *Default*: None + + :nuclide: + + An element with attributes/sub-elements called ``name``, ``xs``, and ``ao`` + or ``wo``. The ``name`` attribute is the name of the cross-section for a + desired nuclide while the ``xs`` attribute is the cross-section + identifier. Finally, the ``ao`` and ``wo`` attributes specify the atom or + weight percent of that nuclide within the material, respectively. One + example would be as follows:: + + + + + .. note:: If one nuclide is specified in atom percent, all others must also + be given in atom percent. The same applies for weight percentages. + + *Default*: None + -------------------------------------- Settings Specification -- settings.xml --------------------------------------