From 827f32f6da33cad5639cbc8b9df03b02b64e93e5 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Thu, 6 Oct 2011 14:41:30 -0400 Subject: [PATCH] Updated gh-pages with more recent documentation. --- ...957c84a11d8c98ca1c14ce7503ae092732d4e6.png | Bin 443 -> 0 bytes ...30b1a87775e9369562420d9e32da943c4b3bae.png | Bin 373 -> 0 bytes ...1626a4247765b36a08da3e914fc41028595eba.png | Bin 419 -> 0 bytes ...29a8e8ad4acaef724ee89e9fcde1d74dbb0476.png | Bin 471 -> 0 bytes ...5a2ed2e7eb1c21e9c8a4865ed91aa94197ea88.png | Bin 377 -> 0 bytes ...0d006945fc3a0f50efa53c2223121169886c6e.png | Bin 327 -> 0 bytes ...d0248415e45cef5618aa27e4eba785b557a247.png | Bin 551 -> 0 bytes ...c19d0db9df6a7a7ff72abd437beb89db8b8a4f.png | Bin 341 -> 0 bytes ...58a1997bd9a2dafb5364565627a3fe73856f73.png | Bin 388 -> 0 bytes ...0a370354cf9f53e8b5219dbc856f54d52c5a04.png | Bin 196 -> 0 bytes _sources/install.txt | 25 +++++-- _sources/usersguide/index.txt | 2 +- _sources/usersguide/input.txt | 58 +++++++++++++++-- developers.html | 10 +-- genindex.html | 10 +-- index.html | 10 +-- install.html | 38 ++++++++--- methods/index.html | 10 +-- search.html | 10 +-- searchindex.js | 2 +- usersguide/index.html | 19 ++++-- usersguide/input.html | 61 +++++++++++++++--- 22 files changed, 196 insertions(+), 59 deletions(-) delete mode 100644 _images/math/38957c84a11d8c98ca1c14ce7503ae092732d4e6.png delete mode 100644 _images/math/3930b1a87775e9369562420d9e32da943c4b3bae.png delete mode 100644 _images/math/5a1626a4247765b36a08da3e914fc41028595eba.png delete mode 100644 _images/math/7e29a8e8ad4acaef724ee89e9fcde1d74dbb0476.png delete mode 100644 _images/math/815a2ed2e7eb1c21e9c8a4865ed91aa94197ea88.png delete mode 100644 _images/math/b60d006945fc3a0f50efa53c2223121169886c6e.png delete mode 100644 _images/math/b6d0248415e45cef5618aa27e4eba785b557a247.png delete mode 100644 _images/math/cbc19d0db9df6a7a7ff72abd437beb89db8b8a4f.png delete mode 100644 _images/math/e258a1997bd9a2dafb5364565627a3fe73856f73.png delete mode 100644 _images/math/e30a370354cf9f53e8b5219dbc856f54d52c5a04.png diff --git a/_images/math/38957c84a11d8c98ca1c14ce7503ae092732d4e6.png b/_images/math/38957c84a11d8c98ca1c14ce7503ae092732d4e6.png deleted file mode 100644 index 71ca0cd7591569cb122500ce32e37dff189085d2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 443 zcmV;s0Yv_ZP)1UJ0{rsq3TOf!7#Nsf3@C^pU>@z4q2!7y|0aE4+jPeW@4=^xnbl|}7DOBv=J0N%kH3KU41>_$= z1~xf}83GK6z)<0lx`kl|x>yOC7}N|0m>Jw6?F{ICL5RV_14Rto42FjRn9+tN298@K zF^Cz!xP_VV1xtQI6Jt_95!)yDURmS;FlBN-l>21pM_jgMe}GMtgS4_C9-CkiX=ZR@ lbKC^d%wWfo>6l>Q0|545SOivfu$%w@002ovPDHLkV1mR`rDFg9 diff --git a/_images/math/3930b1a87775e9369562420d9e32da943c4b3bae.png b/_images/math/3930b1a87775e9369562420d9e32da943c4b3bae.png deleted file mode 100644 index f01b93da486b40d51225d765cf8d8e166a9eabf8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 373 zcmV-*0gC>KP)o}>E?yT#zL?siVF#SBOyy;;Lc}4+ z7$-LTiC3A51fjWM6@rR}<@0QXsVca`8SnseB~jmUwHS_6EVr+|-sr)uCQ2S5&*Lx^ zg{Pj|1J(%MH<6!a9bqC(+6%8u{)ex9O%+;$xo0@x`&__nKJI0=oNzDCYJS8o>Kr#e T6HD=*00000NkvXXu0mjf>vE*w diff --git a/_images/math/5a1626a4247765b36a08da3e914fc41028595eba.png b/_images/math/5a1626a4247765b36a08da3e914fc41028595eba.png deleted file mode 100644 index 53e3734c001572926e5fdfe79f8ccbbc39f725ee..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 419 zcmV;U0bKrxP)YHzzJABy7-)Czz5ziFnHiqAjH6+I0275s{jK-K9E*+RZa)-IrSKr5L zX4V3*8x}C|yauW(s8Hwx@i%i!U~>R5jOIFnP2fs0TMnd{7$ShWFJE8?C}iLWm}?6Z zVmAQs85k!p90RL#11e@P2GJ847BCwyFie8*1A%S?D_G3H5XLZ%f#DOwE!G6i2MnA6 z5WW`!!$FWdw>U$G{i#P^a@V2Cn?hDjU{GBEHy zU?VTn74)BY$VE^wyQ3keLg1*`@bLTDl^3-AUje*lUQ8xY6C7!aTs zfHznVp$Z)VTF-6(WkA3c{K2{bMTl9U93lo`fWb4o!OCucBE$-W3=D^13=rVjfHw>| z7GM#~fQLv0L*$wQ6uI;U)>+7WPKYX~G3;l8O%y&qp zw9tSZ=we0~Lt!BU57=ye7ZA9>z`(>Mz;FuLfOT+HdBAW`sAJ%1U|`@2fHHtFz>MZS zUI%bG$>;!r9*6-@Rhb}H{AFM{05Sl|V0eyU0AB%WLW@LIHHm?70oY#<27@R=8UuH;|H@uVD%?8IWQCKc-MTr3DJy^8kW2PgnZ=tt$Wk N002ovPDHLkV1nK8sbl~E diff --git a/_images/math/815a2ed2e7eb1c21e9c8a4865ed91aa94197ea88.png b/_images/math/815a2ed2e7eb1c21e9c8a4865ed91aa94197ea88.png deleted file mode 100644 index 30559edc28258f1d2d252d3c12a189e32e9ff8a3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 377 zcmV-<0fzpGP)_MFM6O0#*kRj3ClUvI$Pd-%+h*0Pt4nh0_#J|8xoI-PNINp8UgZB>R&+$rUGOBrJX^fH9!9p9YRR<@~ z_yKRRd;Mko+F(6 ziuu)@b(pGIt%%I^D0%Csu{YcNu(){SqwL!XC1P97*6w@oBoy=&<{sP`9MS zA&F;gTe~DWM4fjYD%f diff --git a/_images/math/b6d0248415e45cef5618aa27e4eba785b557a247.png b/_images/math/b6d0248415e45cef5618aa27e4eba785b557a247.png deleted file mode 100644 index c52f17f6e92743e1ec2bb9e610da21bd7d62fad5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 551 zcmV+?0@(eDP)c1Oxi<@!KNkmtL5>ybKIw;~+92KOqh(sKO z4pPL)4=Ch1nv1~ep{P;jvi;N52=YuQ zs#;t`*47;)D-mQPbhI%f_s_I-mmQ=c{d|X_6M@<(ntmQhJ`P1sNRU~g=9ISkNb)E! z+&jIp*yD|5?I@&@~-9lfObj#IN*vR!@^8s-@Cs_&Qua-K@7H;X3JXIBSSBE zxL#1wUYA8ASsmBqD@~<4Ht8 zR4C75V89BP9zR7D(6b9*zyV?zxF#U;SuZfG#HIEU19Jj0pI3pw43}C-2G#~-KH~(2 z2q2~Gs+^AERFfdHa&ZPuX=K5|0)~kj7+4D`6grWG!`YiSW&+iUBMVL}03jx@;YdIM zXgeoV?Xff70000mP)t-s|Ns90 z002NhK%SnSbaZrLVqy#o47Rqm%*@OpA|i^4iUb4%P*70j=H@UkFcuaTh4K^R0003G zNklYk6vcn}*BWh56tx74E)F7=1_amo23g#d>ZoK99IfCaND&`E!C8ES z+CeA;t#8o9MLMXngXboG!Taql2B%NhgX)}0H6$Yw{mPoC2Hc;sX-uzF-iy&^))0K*ckp5(%s`)R zy8!M!%zi$|IeaR;_^~+FJ53FQaGM@ek*Q+BQm(sWSytyS9 iO!hKO`JN0ug#G|0yEsw#^OV2<0000t<74`goJwk;_s$-uy% zq@-ltym?(+UC*99J9FlYn3xz3508?Pl7oXoKtKQs3(M7~9?3ur{+=$5Asp9}6A}`V z7?>wB2%MZ1z_-YvL4fZ@Z?v + + + + + 1 + sphere + 0.0 0.0 0.0 5.0 + vacuum + + + + 1 + 0 + 1 + -1 + + + +At the beginning of this file is a comment, denoted by a tag starting with +````. Comments, as well as any other type of input, +may span multiple lines. One convenient feature of the XML input format is that +sub-elements of the ``cell`` and ``surface`` elements can also be equivalently +expressed of attributes of the original element, e.g. the geometry file above +could be written as:: + + + + + + + + + + +.. _constructive solid geometry: http://en.wikipedia.org/wiki/Constructive_solid_geometry + +.. _quadratic surfaces: http://en.wikipedia.org/wiki/Quadric + Types of surfaces: ``x-plane`` diff --git a/developers.html b/developers.html index 0002296015..9d28668ffe 100644 --- a/developers.html +++ b/developers.html @@ -7,13 +7,13 @@ - Development Team — OpenMC v0.3.1 documentation + Development Team — OpenMC v0.3.2 documentation - + @@ -35,7 +35,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -98,7 +98,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/genindex.html b/genindex.html index 78d6efe403..891a0cbbe3 100644 --- a/genindex.html +++ b/genindex.html @@ -7,13 +7,13 @@ - Index — OpenMC v0.3.1 documentation + Index — OpenMC v0.3.2 documentation - +
    @@ -31,7 +31,7 @@
  • index
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -79,7 +79,7 @@
  • index
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/index.html b/index.html index 696ebb757a..ed433be8fe 100644 --- a/index.html +++ b/index.html @@ -7,13 +7,13 @@ - The OpenMC Monte Carlo Code — OpenMC v0.3.1 documentation + The OpenMC Monte Carlo Code — OpenMC v0.3.2 documentation - + @@ -35,7 +35,7 @@
  • next |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -117,7 +117,7 @@ within the Computationa
  • next |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/install.html b/install.html index 262ece667a..add2003253 100644 --- a/install.html +++ b/install.html @@ -7,13 +7,13 @@ - Installation — OpenMC v0.3.1 documentation + Installation — OpenMC v0.3.2 documentation - + @@ -39,7 +39,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -56,11 +56,26 @@ on your machine. Since a number of Fortran 2003 features are used in the code, it is recommended that you use the latest version of whatever compiler you choose. For gfortran, it is recommended that you use version 4.5.0 or above.

    +

    If you are using Debian or a Debian derivative such as Ubuntu, you can install +the gfortran compiler using the following command:

    +
    sudo apt-get install gfortran
    +
    +
    +

    Warning

    +

    The runtime preformance with the Intel Fortran compiler and PGI +Fortran compiler will likely exceed that of the gfortran compiler. Compiling +with high optimization on the gfortran compiler may make up for some of the +performance difference

    +

    To compile with support for parallel runs on a distributed-memory architecture, you will need to have a valid implementation of MPI installed on your machine. The code has been tested and is known to work with the latest versions -of both OpenMPI and MPICH2. You may use older versions of MPI implementations at -your own risk.

    +of both OpenMPI and MPICH2. You may use older versions of MPI implementations +at your own risk. OpenMPI and/or MPICH2 can be installed on Debian derivatives +with:

    +
    sudo apt-get install mpich2
+sudo apt-get install openmpi-bin
    +

    Configuration

    @@ -87,18 +102,23 @@ interprocedural optimization.
    Enables parallel runs using the Message Passing Interface. Users should also set the MPI root directory by setting the MPI variable further down in the Makefile.
    -
    USE_MPI
    +
    USE_OPENMP
    Enables parallel runs on shared-memory architecture using OpenMP threading.
    USE_COARRAY
    Enables parallel runs using Fortran 2008 coarrays.
    +
    +

    Note

    +

    OpenMC does not yet support parallelism using OpenMP or Fortran 2008 +coarrays.

    +

    Compiling

    To compile the code, run the following commands from within the root directory for OpenMC:

    cd openmc/src
-make -f Makefile
    +make

    This will build an executable named openmc.

    @@ -160,7 +180,7 @@ make -f Makefile
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/methods/index.html b/methods/index.html index 1ca9276204..b1c7dfba3f 100644 --- a/methods/index.html +++ b/methods/index.html @@ -7,13 +7,13 @@ - Methodology — OpenMC v0.3.1 documentation + Methodology — OpenMC v0.3.2 documentation - + @@ -39,7 +39,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -123,7 +123,7 @@ gradient to the surface at the point of crossing, i.e. previous | -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/search.html b/search.html index 9e981ae533..5d38d06733 100644 --- a/search.html +++ b/search.html @@ -7,13 +7,13 @@ - Search — OpenMC v0.3.1 documentation + Search — OpenMC v0.3.2 documentation - + @@ -37,7 +37,7 @@
  • index
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -85,7 +85,7 @@
  • index
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/searchindex.js b/searchindex.js index 1d7cac3fcb..614d7ea0b7 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:1,code:[0,5,3,1,2],forget:5,execut:1,thi:[2,1,4],move:3,focus:0,through:[4,3],aspect:4,materail:2,follow:[2,1],paul:[0,5],languag:2,reactor:0,xml:[2,4],whose:2,group:0,firstnam:2,also:[0,1],configur:1,makefil:1,should:1,fortran:1,mcnp:0,openmpi:1,vec:[],els:1,bracket:2,hat:[],lastnam:2,risk:1,thei:3,format:[0,2],webpag:2,familiar:2,piec:2,secondari:3,gfortran:1,characterist:2,use_mpi:1,bryan:5,intel:1,specif:2,arbitrari:2,cdot:[],anyth:1,html:2,gener:3,separ:2,vector:3,massachusett:0,team:[0,5],debug:1,architectur:1,where:3,compil:1,set:[2,1],began:0,direct:3,second:0,expect:2,pass:1,run:[2,1],carlo:[0,5,3,2],transport:[0,3],variabl:1,shown:3,gradient:3,section:[0,1],content:0,kord:5,written:[2,3],version:1,health:2,use_coarrai:1,between:2,paramet:1,ever:2,method:3,math:[],whatev:1,machin:1,led:5,serpent:0,coeffici:2,openmc:[0,1,2,3,4,5],romano:[0,5],physicist:2,free:0,perpendicular:2,extens:2,base:0,let:2,here:2,prerequisit:1,advisor:5,solv:3,depend:1,becom:3,sinc:1,card:2,both:1,about:2,thread:1,angl:2,interprocedur:1,materi:2,current:5,technolog:0,construct:0,simul:[0,4,2],profil:1,length:2,tutori:4,equat:3,geometri:[0,3,2],mani:2,chang:1,undergo:3,interact:0,first:2,softwar:1,own:1,effici:2,point:3,feel:0,exchang:2,within:[0,1],number:1,pgi:1,down:1,unlik:2,done:1,been:1,openmp:1,instal:[0,1],stand:2,guid:[0,4],your:1,unit:3,smith:[2,5],differ:2,from:1,describ:2,wai:2,memori:1,addition:2,data:[0,2],support:1,enabl:1,messag:1,parallel:1,much:2,interfac:[2,1],includ:5,recommend:1,call:2,choos:1,locat:1,type:2,tell:1,more:0,option:[2,1],name:1,benoit:5,methodolog:[0,3],specifi:2,particl:[0,3],flag:1,enclos:2,examin:2,particular:2,known:1,coarrai:1,talli:2,john:2,input:[2,4],gnu:1,solid:0,work:1,see:[2,1],structur:2,project:5,calcul:0,can:[3,1],abov:[3,1],root:1,veloc:3,randomli:3,program:2,featur:1,comput:0,have:1,creat:[2,3,4],order:[0,1],share:1,indic:2,activ:5,high:1,sphere:2,critic:0,tag:2,implement:1,file:[2,4],further:1,need:[2,1],seen:2,collis:3,ascii:2,occup:2,quadrat:2,denot:2,surfac:[0,3,2],develop:[0,5],form:[2,3],inform:0,perform:4,cylind:2,make:1,gprof:1,when:1,cross:[0,3],same:2,contact:0,other:2,valid:1,anyon:2,build:1,which:[2,1],test:1,you:[4,1],simpl:2,neutron:[0,3,4],complet:2,infinit:2,mpich2:1,unless:1,distribut:1,normal:3,optim:1,mont:[0,5,3,2],nest:2,who:2,reflect:3,capabl:0,plane:2,track:3,user:[0,1,4],mai:1,src:1,associ:2,herman:5,physic:[0,2],welcom:4,sete:2,experienc:1,essenti:4,older:1,directori:1,assembl:2,markup:2,well:1,quantiti:2,mpi:1,person:2,exampl:2,command:1,wherebi:[2,3],allow:2,institut:0,paral:2,model:[0,2],axi:2,travel:3,latest:1},objtypes:{},titles:["The OpenMC Monte Carlo Code","Installation","Creating XML Input Files","Methodology","User’s Guide","Development Team"],objnames:{},filenames:["index","install","usersguide/input","methods/index","usersguide/index","developers"]}) \ No newline at end of file +Search.setIndex({objects:{},terms:{oper:2,all:1,code:[0,5,3,1,2],forget:5,execut:1,thi:[2,1,4],move:3,focus:0,through:[4,3],aspect:4,follow:[2,1],paul:[0,5],yet:1,languag:2,reactor:0,xml:[2,4],cell:2,group:0,firstnam:2,also:[0,1,2],materi:[2,4],configur:1,makefil:1,complex:2,should:1,fortran:1,mcnp:0,openmpi:1,herman:5,overview:[2,4],els:1,bracket:2,bin:1,lastnam:2,everi:2,risk:1,thei:3,get:1,webpag:2,familiar:2,express:2,piec:2,secondari:3,use_openmp:1,volum:2,vacuum:2,characterist:2,use_mpi:1,bryan:5,end:2,intel:1,specif:[2,4],anyth:1,arbitrari:2,separ:2,vector:3,declar:2,massachusett:0,have:[2,1],team:[0,5],debug:1,architectur:1,where:3,valid:1,compil:1,set:[2,1,4],began:0,some:1,direct:3,combinatori:2,second:0,doe:1,expect:2,pass:1,run:[2,1],carlo:[0,5,3,2],transport:[0,3],input:[2,4],variabl:1,shown:3,sub:2,gradient:3,openmc:[0,1,2,3,4,5],boundari:2,current:5,kord:5,written:[2,3],version:[2,1],health:2,use_coarrai:1,lattic:2,gfortran:1,content:0,ever:2,method:3,element:2,refer:2,machin:1,object:2,led:5,deriv:1,serpent:0,whose:2,romano:[0,5],gener:3,each:2,coeffici:2,perpendicular:2,free:0,like:1,extens:2,base:0,let:2,here:2,prerequisit:1,advisor:5,solv:3,depend:1,construct:[0,2],becom:3,between:2,card:2,simpler:2,both:1,about:2,particl:[0,3],would:[],thread:1,capabl:0,angl:2,interprocedur:1,veloc:3,materail:[],technolog:0,geometri:[0,4,3,2],simul:[0,4,2],profil:1,length:2,tutori:4,equat:3,span:2,section:[0,1],mani:2,chang:1,undergo:3,travel:3,interact:0,first:2,comment:2,softwar:1,own:1,effici:2,point:3,feel:0,exchang:2,format:[0,2],within:[0,1,2],bound:2,apt:1,pgi:1,down:1,unlik:2,"boolean":2,done:1,been:1,openmp:1,instal:[0,1],stand:2,guid:[0,4],your:1,unit:3,smith:[2,5],coarrai:1,differ:[2,1],from:1,describ:2,wai:2,memori:1,addition:2,data:[0,2],support:1,univers:2,sometim:2,messag:1,sinc:1,start:2,much:2,interfac:[2,1],includ:5,recommend:1,paramet:1,call:2,choos:1,conveni:2,type:2,tell:1,more:0,option:[2,1],name:[2,1],benoit:5,methodolog:[0,3],enabl:1,specifi:2,warn:1,flag:1,exce:1,enclos:2,examin:2,particular:2,known:1,number:[2,1],line:2,talli:[2,4],origin:2,must:2,john:2,look:2,gnu:1,solid:[0,2],coeff:2,work:1,uniqu:2,structur:2,project:5,defin:2,calcul:0,whatev:1,abov:[2,3,1],otherwis:[],root:[2,1],could:2,randomli:3,program:2,featur:[2,1],comput:0,uid:2,creat:[2,3,4],order:[0,1],can:[2,3,1],sudo:1,share:1,ani:2,indic:2,activ:5,high:1,sphere:2,critic:0,tag:2,implement:1,file:[2,4],further:1,need:[2,1],seen:2,quantiti:2,ascii:2,physicist:2,quadrat:2,denot:2,surfac:[0,3,2],multipl:2,form:[2,3],equival:2,inform:0,perform:[4,1],cylind:2,csg:2,gprof:1,when:1,cross:[0,3],same:2,contact:0,note:1,other:2,html:2,anyon:2,build:1,which:[2,1],test:1,you:[4,1],occup:2,simpl:2,neutron:[0,3,4],complet:2,close:2,infinit:2,begin:2,mpich2:1,unless:1,distribut:1,see:[2,1],normal:3,optim:1,mont:[0,5,3,2],nest:2,who:2,reflect:3,most:2,plane:2,track:3,user:[0,4,1,2],preform:1,mai:[2,1],develop:[0,5],attribut:2,src:1,associ:2,parallel:1,physic:[0,2],welcom:4,sete:2,experienc:1,essenti:4,wherebi:[2,3],older:1,directori:1,assembl:2,markup:2,collis:3,well:[2,1],locat:1,mpi:1,person:2,debian:1,exampl:2,command:1,runtim:1,allow:2,institut:0,paral:2,model:[0,2],axi:2,make:1,ubuntu:1,latest:1},objtypes:{},titles:["The OpenMC Monte Carlo Code","Installation","Creating XML Input Files","Methodology","User’s Guide","Development Team"],objnames:{},filenames:["index","install","usersguide/input","methods/index","usersguide/index","developers"]}) \ No newline at end of file diff --git a/usersguide/index.html b/usersguide/index.html index 6649c42db4..c105df43a9 100644 --- a/usersguide/index.html +++ b/usersguide/index.html @@ -7,13 +7,13 @@ - User’s Guide — OpenMC v0.3.1 documentation + User’s Guide — OpenMC v0.3.2 documentation - + @@ -39,7 +39,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • @@ -54,7 +54,14 @@ essential aspects of using OpenMC to perform neutronic simulations.

    @@ -105,7 +112,7 @@ essential aspects of using OpenMC to perform neutronic simulations.

  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
    • diff --git a/usersguide/input.html b/usersguide/input.html index 30cece53bc..fec77ea686 100644 --- a/usersguide/input.html +++ b/usersguide/input.html @@ -7,13 +7,13 @@ - Creating XML Input Files — OpenMC v0.3.1 documentation + Creating XML Input Files — OpenMC v0.3.2 documentation - + @@ -40,7 +40,7 @@
  • previous |
    • -
  • OpenMC v0.3.1 documentation »
    • +
  • OpenMC v0.3.2 documentation »
  • User’s Guide »
    • @@ -72,10 +72,10 @@ person. The nested tags firstname, lastname, age, and indicate characteristics about the person being described.

    In much the same way, OpenMC input uses XML tags to describe the geometry, the materials, and settings for a Monte Carlo simulation.

    -
    -

    Files

    +
    +

    Overview of Files

    To assemble a complete model for OpenMC, one needs to create separate XML files -for the geometry, materails, and settings. Additionally, an optional tallies XML +for the geometry, materials, and settings. Additionally, an optional tallies XML file specifies physical quantities to be tallied. OpenMC expects that these files are called:

      @@ -87,6 +87,49 @@ files are called:

    Geometry Specification – geometry.xml

    +

    The geometry in OpenMC is described using constructive solid geometry (CSG), +also sometimes referred to as combinatorial geometry. CSG allows a user to +create complex objects using Boolean operators on a set of simpler surfaces. In +the geometry model, each unique closed volume in defined by its bounding +surfaces. In OpenMC, most quadratic surfaces can be modeled and used as +bounding surfaces.

    +

    Every geometry.xml must have an XML declaration at the beginning of the file and +a root element named geometry. Within the root element the user can define any +number of cells, surfaces, and lattices. Let us look at the following example:

    +
    <?xml version="1.0">
+<geometry>
+  <!-- This is a comment -->
+
+  <surface>
+    <uid>1</uid>
+    <type>sphere</type>
+    <coeffs>0.0 0.0 0.0 5.0</coeffs>
+    <boundary>vacuum</boundary>
+  <surface>
+
+  <cell>
+    <uid>1</uid>
+    <universe>0</universe>
+    <material>1</material>
+    <surfaces>-1</surfaces>
+  </cell>
+</geometry>
    +
    +

    At the beginning of this file is a comment, denoted by a tag starting with +<!-- and ending with -->. Comments, as well as any other type of input, +may span multiple lines. One convenient feature of the XML input format is that +sub-elements of the cell and surface elements can also be equivalently +expressed of attributes of the original element, e.g. the geometry file above +could be written as:

    +
    <?xml version="1.0">
+<geometry>
+  <!-- This is a comment -->
+
+  <surface uid="1" type="sphere" coeffs="0.0 0.0 0.0 5.0" boundary="vacuum" />
+  <cell uid="1" universe="0" material="1" surfaces="-1" />
+
+</geometry>
    +

    Types of surfaces:

    x-plane
    @@ -138,7 +181,7 @@ R^2"/>. The coefficients specified are “Table Of Contents