From 6ebe0115bc0d63fd0b783c5df3ca1b5d9e34503a Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Mon, 19 Mar 2012 11:04:15 -0400 Subject: [PATCH] Updated documentation. --- _sources/usersguide/input.txt | 154 ++++++++++++++++++++++------ searchindex.js | 2 +- usersguide/input.html | 182 ++++++++++++++++++++++++++++------ 3 files changed, 274 insertions(+), 64 deletions(-) diff --git a/_sources/usersguide/input.txt b/_sources/usersguide/input.txt index 89431ba114..55072f24fa 100644 --- a/_sources/usersguide/input.txt +++ b/_sources/usersguide/input.txt @@ -307,16 +307,23 @@ settings.xml file. The ``criticality`` element indicates that a criticality calculation should be performed. It has the following attributes/sub-elements: - :cycles: - The number of total fission source iterations. + :batches: + The total number of batches, where each batch corresponds to multiple + fission source iterations. Batching is done to eliminate correlation between + realizations of random variables. *Default*: None + :generations_per_batch: + The number of total fission source iterations per batch. + + *Default*: 1 + :inactive: - The number of inactive fission source iterations. In general, the starting - cycles in a criticality calculation can not be used to contribute to tallies - since the fission source distribution and eigenvalue are generally not - converged immediately + The number of inactive batches. In general, the starting cycles in a + criticality calculation can not be used to contribute to tallies since the + fission source distribution and eigenvalue are generally not converged + immediately. *Default*: None @@ -353,6 +360,18 @@ default. This element has the following attributes/sub-elements: *Default*: 1.0 +``energy_grid`` Element +----------------------- + +The ``energy_grid`` element determines the treatment of the energy grid during a +simulation. Setting this element to "nuclide" will cause OpenMC to use a +nuclide's energy grid when determining what points to interpolate between for +determining cross sections (i.e. non-unionized energy grid). To use a unionized +energy grid, set this element to "union". Note that the unionized energy grid +treatment is slightly different than that employed in Serpent. + + *Default*: union + ``entropy`` Element ------------------- @@ -573,40 +592,115 @@ tallies. This element should be followed by "yes" or "no" Geometry Plotting Specification -- plot.xml ------------------------------------------- -A rudimentary plotting capability is available in OpenMC by specifying a -plot.xml file and subsequently running with the command-line flag ``-plot``. The -root element of the plot.xml is simply ```` and four sub-elements can be -defined to configure the plotting range and resolution. +A basic 2D plotting capability is available in OpenMC by creating a +plots.xml file and subsequently running with the command-line flag ``-plot``. The +root element of the plot.xml is simply ```` and any number output +figures can be defined with ```` sub-elements. -``origin`` Element +``plot`` Element ------------------ -The ``origin`` element has no attributes/sub-elements and indicates the -Cartesian coordinates of the center of the plot. +Each plot must contain a combination of the following attributes or sub-elements: - *Default*: None + :id: + The unique ``id`` of the plot. -``width`` Element ------------------ + *Default*: None - Required entry -The ``width`` element has no attributes/sub-elements and indicates the width of -the plot in each of the basis directions. + :filename: + Filename for the output plot file. - *Default*: None + *Default*: "plot" -``basis`` Element ------------------ + :color: + Keyword for plot coloring. This can only be either ``cell`` or ``mat``, + which colors regions by cells and materials, respectively. -The ``basis`` element has no attributes/sub-elements and indicates the specified -basis for plotting. The only option option currently accepted is "xy". + *Default*: ``cell`` - *Default*: xy + :origin: + Specifies the XYZ coordinate of the center of the plot. Should be 3 floats + separated by spaces. -``pixel`` Element ------------------ + *Default*: None - Required entry -The ``pixel`` element has no attributes/sub-elements and indicates the distance -between horizontal rays sent through the geometry to record surface crossings. A -smaller ``pixel`` will result in a higher-resolution plot. + :width: + Specifies the width of the plot along each of the basis directions. + Should be 2 or 3 floats separated by spaces for 2D plots and 3D plots, + respectively. - *Default*: 0.01 + *Default*: None - Required entry + + :type: + Keyword for type of plot to be produced. Currently only ``slice`` plots are + implemented, which create 2D pixel maps saved in the PPM file format. PPM + files can be displayed in most viewers (e.g. the default Gnome viewer, + IrfanView, etc.). + + .. note:: Since the PPM format is saved without any kind of compression, + the resulting file sizes can be quite large. Saving the image in + the PNG format can often times reduce the file size by orders of + magnitude without any loss of image quality. + + *Default*: "slice" + +``plot`` elements of ``type`` ``slice`` also contain the following attributes or +sub-elements: + + :basis: + Keyword specifying the plane of the plot for ``slice`` type plots. Can be + one of: ``xy``, ``xz``, ``yz``. + + *Default*: ``xy`` + + :pixels: + Specifies the number of pixes to be used along each of the basis directions for + ``slice`` plots. Should be 2 integers separated by spaces. + + .. warning:: The ``pixels`` input determines the output file size. For the PPM + format, 10 million pixels will result in a file just under 30 MB in + size. + + .. warning:: If the aspect ratio defined in ``pixels`` does not match the aspect + ratio defined in ``width`` the plot may appear stretched or squeezed. + + .. warning:: Geometry features along a basis direction smaller than ``width``/``pixels`` + along that basis direction may not appear in the plot. + + *Default*: None - Required entry for ``slice`` plots + + :background: + Specifies the RGB color of the regions where no OpenMC cell can be found. Should + be 3 integers deparated by spaces. + + *Default*: 0 0 0 (white) + + :col_spec: + Any number of this optional tag may be included in each ``plot`` element, which can + override the default random colors for cells or materials. Each ``col_spec`` + element must contain ``id`` and ``rgb`` sub-elements. + + :id: + Specifies the cell or material unique id for the color specification. + + :rgb: + Specifies the custom color for the cell or material. Should be 3 intergers separated + by spaces. + + *Default*: None + + :mask: + The special ``mask`` sub-element allows for the selective plotting of *only* + user-specified cells or materials. Only one ``mask`` element is allowed per ``plot`` + element, and it must contain as atributes or sub-elements a background masking color and + a list of cells or materials to plot: + + :components: + List of unique ``id`` numbers of the cells or materials to plot. Should be any number + of integers separated by spaces. + + :background: + Color to apply to all cells or materials not in the ``components`` list of cells or + materials to plot. This overrides any ``col_spec`` color specifications. + + *Default*: None diff --git a/searchindex.js b/searchindex.js index 3ef2269ee2..460e6e4c52 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:[2,3,1],code:[0,5,3,1,2],entropi:2,forget:5,focus:0,four:2,secondli:2,signific:3,reson:[2,3],follow:[2,1],content:0,depend:1,openmpi:1,cm3:2,sent:2,sourc:[2,1],everi:2,risk:1,account:2,mpi:1,print:2,volum:2,gfortran:1,affect:3,list:2,iter:2,vector:3,cosin:3,team:[0,5],small:3,dimens:2,energyout:2,smaller:2,natur:2,direct:[2,3],second:[0,2],pass:1,download:1,further:1,carlo:[0,5,3,2],what:2,sub:2,neg:2,section:[0,3,1,2],weight_avg:2,calcul:[0,2],cell:2,version:[2,1],ever:2,method:3,whatev:1,involv:1,vibrat:3,full:[2,1],led:5,deriv:1,whose:2,variat:3,gener:[2,3],coeffici:2,here:[2,3],mev:2,let:2,ubuntu:1,path:2,becom:3,sinc:[2,3,1],valu:2,box:2,hdf5:1,technolog:0,converg:2,amount:3,chang:[3,1],hexagon:2,magnitud:3,parallelepip:2,default_x:2,appli:2,apt:1,"boolean":2,instal:[0,1],total:2,establish:3,unit:[2,3],highli:1,plot:[2,4],from:[2,3,1],describ:2,would:[2,3],memori:1,univers:2,two:[2,3],program:2,call:2,recommend:1,"70c":2,type:2,tell:[2,1],more:[0,2],desir:2,relat:3,warn:2,flag:[2,1],indic:2,examin:2,particular:2,known:[2,1],origin:2,must:2,none:2,sometim:[2,3],setup:1,work:1,uniqu:2,other:2,itself:1,can:[2,3,1],root:[2,1],scatter:[2,3],serpent:0,give:2,sudo:1,accept:[2,3],high:1,sphere:2,critic:[0,2],tag:2,want:1,occur:3,occup:2,motion:3,surfac:[0,3,2],end:2,divid:3,rather:[2,3],cylind:2,csg:2,six:2,how:[2,1],anyon:2,answer:3,veloc:3,simpl:2,updat:1,product:2,clone:1,after:2,reflect:[2,3],mesh:2,mai:[2,1],multipl:2,law:3,data:[0,2],parallel:1,physic:[0,2],circumst:2,github:1,essenti:4,third:2,light:3,correspond:2,element:2,caus:3,inform:[0,2],combin:2,allow:2,enter:[3,1],order:[0,1],travel:3,oper:2,over:[2,3],move:3,thermal:3,through:[2,3,4],flexibl:2,vari:3,paramet:[2,1],outer:3,fit:2,complex:2,exchang:2,pixel:2,good:[3,1],greater:3,thei:[2,3],initi:2,repositori:1,now:3,maxwellian:3,bryan:5,name:[2,1],anyth:1,cross_sect:2,instruct:1,separ:2,exampl:[2,1],massachusett:0,each:2,debug:1,complet:2,side:2,mean:1,compil:1,weight:2,monoton:2,unresolv:2,heavi:3,expect:2,energi:2,event:2,shannon:2,out:2,variabl:[2,3,1],shown:3,absorpt:2,space:2,gradient:3,profil:1,rewrit:3,health:2,rel:3,lattic:2,cartersian:2,integr:3,romano:[0,5],given:2,free:[0,3],standard:2,base:[0,3],advisor:5,institut:0,card:2,basi:2,angl:[2,3],could:2,latest:1,filter:2,turn:[2,1],length:2,wither:2,geometri:[0,4,3,2],undergo:[2,3],assign:2,first:2,upper_right:2,softwar:1,rang:[2,3],directli:1,upper:2,feel:0,onc:2,lastnam:2,number:[2,1],pgi:1,unlik:2,done:1,construct:[0,2],assume_separ:2,differ:2,cartesian:2,start:2,associ:[2,3],interact:[0,3],hdf5_root:1,system:3,messag:1,termin:1,conveni:2,"final":2,includ:[2,5],option:[2,1],methodolog:[0,3],specifi:2,part:3,enclos:2,moder:3,than:[2,3],serv:2,john:2,target:3,prevent:2,rate:2,structur:2,horizont:2,project:5,were:2,posit:2,arrang:2,toward:2,markup:2,randomli:3,comput:[0,1],sab:2,ani:[2,3],rai:2,have:[2,3,1],tabl:2,need:[2,1],seen:2,equival:2,upscatt:3,note:2,also:[0,1,2],contact:0,build:1,which:[2,1],environ:2,mit:1,singl:2,begin:2,unless:1,distribut:[2,3,1],trace:2,normal:[3,1],track:3,who:2,most:2,letter:2,phase:2,herman:5,cover:2,quantiti:2,bracket:2,determin:2,effect:[2,3],axi:2,neutrno:3,reactor:0,text:1,verbos:2,corner:2,find:2,make:[3,1],xml:[2,4],current:[2,5],onli:2,explicitli:2,locat:1,execut:1,configur:[2,1],activ:5,should:[2,1],mcnp:0,fuel:2,surviv:2,contribut:2,get:1,kinemat:3,familiar:2,express:2,secondari:[2,3],ssh:1,increas:2,use_mpi:1,enabl:[2,1],"default":2,she:2,contain:2,openmc:[0,1,2,3,4,5],where:[2,3],set:[2,1,4],elast:3,see:[2,3,1],nuclid:2,result:2,respons:2,close:2,particl:[0,3,2],infinit:2,boundari:2,fission:2,written:[2,3],score:2,between:[2,3],across:2,attribut:2,assumpt:[2,3],kei:1,numer:2,screen:1,physicist:2,extens:2,lower_left:2,solv:3,group:[0,2],addit:1,reaction:2,last:2,ptabl:2,cycl:2,interprocedur:1,howev:3,mont:[0,5,3,2],tutori:4,equat:3,mani:[2,3],com:1,comment:2,pre:2,simpli:2,point:3,overview:[2,4],roulett:2,respect:2,guid:[0,4],assum:[2,3],smith:[2,5],rudimentari:2,slowli:3,creat:[2,3,4],addition:2,due:[2,3],been:1,implicit:2,accumul:2,much:2,interest:[2,3],use_hdf5:1,both:1,resolut:2,andrew:5,coordin:2,els:1,present:2,"case":[2,3],look:2,gnu:1,solid:[0,2],rectangular:2,defin:2,"while":2,abov:[2,3,1],region:2,almost:3,site:2,bias:2,quadrat:2,ascii:2,develop:[0,5],welcom:4,incorrectli:2,perform:[2,4],began:0,gprof:1,cross:[0,3,2],same:[2,3,1],html:2,probabl:[2,3],neutron:[0,4,3,2],higher:2,incorrect:[2,3],optim:1,nest:2,siegel:5,capabl:[0,2],moment:2,user:[0,4,1,2],implement:1,sete:2,lower:2,off:[2,3],center:2,older:1,thu:3,usual:2,well:[2,1],person:2,without:[2,1],command:[2,1],wherebi:[2,3],thi:[2,3,1,4],choos:1,model:[0,2],dimension:2,left:2,distanc:2,identifi:2,firstnam:2,when:[2,3,1],obtain:1,rest:3,kill:2,aspect:4,paul:[0,5],languag:2,cut:2,miscellan:2,makefil:1,paral:2,fortran:1,valid:[2,1],densiti:2,input:[2,4],subsequ:2,take:2,bin:[2,1],format:[0,2],webpag:2,piec:2,isotrop:3,birth:2,vacuum:2,characterist:2,string:2,intel:1,specif:[2,4],arbitrari:2,plane:2,temperatur:3,flux:2,either:2,output:[2,1],right:2,captur:2,some:2,percentag:2,born:2,mpich2:1,sampl:[2,3],integ:2,inact:2,guess:2,transport:[0,3],transmiss:2,lead:2,per:2,larg:3,condit:2,combinatori:2,refer:2,machin:1,object:2,run:[2,1],perpendicular:2,host:1,prerequisit:1,post:2,simpler:2,src:1,about:2,actual:[2,1],materi:[2,3,4],slightli:2,simul:[0,4,2],stand:2,produc:2,crpg:1,cutoff:2,own:1,effici:2,within:[0,1,2],bound:[2,3],automat:2,three:2,down:[2,1],calcult:2,your:1,git:1,span:2,wai:2,support:1,avail:2,width:2,interfac:[2,1],low:3,overhead:2,"function":3,form:[2,3],roulet:2,atom:2,russian:2,line:[2,1],talli:[2,4],count:2,absent:2,immedi:2,possibl:[2,1],whether:2,coeff:2,mpi_root:1,displai:2,record:2,below:2,otherwis:2,problem:2,cellborn:2,featur:[2,1],constant:3,pin:2,dure:2,repres:2,file:[2,1,4],proport:3,fill:2,assembl:2,denot:2,nonetheless:3,benoit:5,percent:2,detail:2,declar:2,collis:[2,3],spatial:2,test:1,you:[4,1],survival_bias:2,architectur:1,repeat:2,intend:1,kord:5,eigenvalu:2,uniformli:2,debian:1,experienc:1,nucleu:3,directori:1,ignor:3,time:3,nuclei:3},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:{all:[2,3,1],code:[0,5,3,1,2],entropi:2,forget:5,focus:0,secondli:2,signific:3,correl:2,reson:[2,3],follow:[2,1],locat:1,content:0,depend:1,openmpi:1,under:2,cm3:2,"case":[2,3],sourc:[2,1],everi:2,risk:1,account:2,mpi:1,print:2,volum:2,gfortran:1,affect:3,list:2,iter:2,vector:3,cosin:3,team:[0,5],small:3,dimens:2,energyout:2,smaller:2,natur:2,direct:[2,3],second:[0,2],pass:1,download:1,further:1,carlo:[0,5,3,2],integr:3,what:2,sub:2,neg:2,section:[0,3,1,2],weight_avg:2,calcul:[0,2],current:[2,5],version:[2,1],order:[0,1,2],ever:2,method:3,whatev:1,involv:1,vibrat:3,full:[2,1],led:5,deriv:1,whose:2,variat:3,gener:[2,3],coeffici:2,here:[2,3],mev:2,let:2,ubuntu:1,path:2,along:2,becom:3,sinc:[2,3,1],valu:2,box:2,hdf5:1,technolog:0,converg:2,amount:3,within:[0,1,2],chang:[3,1],hexagon:2,magnitud:[2,3],parallelepip:2,default_x:2,appli:2,apt:1,filenam:2,"boolean":2,instal:[0,1],total:2,establish:3,unit:[2,3],highli:1,plot:[2,4],from:[2,3,1],describ:2,would:[2,3],memori:1,univers:2,two:[2,3],program:2,call:2,recommend:1,"70c":2,type:2,tell:[2,1],more:[0,2],desir:2,relat:3,warn:2,flag:[2,1],indic:2,examin:2,particular:2,known:[2,1],origin:2,must:2,none:2,sometim:[2,3],setup:1,work:1,uniqu:2,other:2,itself:1,can:[2,3,1],root:[2,1],scatter:[2,3],overrid:2,serpent:[0,2],give:2,sudo:1,accept:[2,3],high:1,sphere:2,critic:[0,2],tag:2,want:1,occur:3,occup:2,motion:3,surfac:[0,3,2],end:2,divid:3,rather:[2,3],cylind:2,csg:2,six:2,how:[2,1],anyon:2,answer:3,veloc:3,simpl:2,updat:1,map:2,product:2,mat:2,clone:1,after:2,reflect:[2,3],mesh:2,mai:[2,1],multipl:2,law:3,data:[0,2],parallel:1,physic:[0,2],circumst:2,github:1,essenti:4,third:2,light:3,correspond:2,element:2,caus:[2,3],inform:[0,2],combin:2,allow:2,enter:[3,1],travel:3,oper:2,atribut:2,over:[2,3],move:3,thermal:3,through:[2,3,4],flexibl:2,vari:3,paramet:[2,1],outer:3,fit:2,complex:2,exchang:2,pixel:2,non:2,good:[3,1],greater:3,thei:[2,3],initi:2,repositori:1,automat:2,now:3,maxwellian:3,bryan:5,name:[2,1],anyth:1,cross_sect:2,instruct:1,separ:2,massachusett:0,each:2,debug:1,found:2,complet:2,side:2,mean:1,compil:1,energy_grid:2,weight:2,monoton:2,unresolv:2,heavi:3,expect:2,energi:2,event:2,shannon:2,out:2,variabl:[2,3,1],shown:3,absorpt:2,space:2,gradient:3,profil:1,rewrit:3,health:2,rel:3,lattic:2,cartersian:2,generations_per_batch:2,million:2,romano:[0,5],given:2,free:[0,3],standard:2,base:[0,3],advisor:5,institut:0,card:2,basi:2,angl:[2,3],could:2,latest:1,filter:2,turn:[2,1],length:2,wither:2,geometri:[0,4,3,2],undergo:[2,3],assign:2,first:2,upper_right:2,softwar:1,rang:[2,3],directli:1,upper:2,feel:0,onc:2,lastnam:2,qualiti:2,number:[2,1],pgi:1,unlik:2,done:[2,1],construct:[0,2],assume_separ:2,size:2,avail:2,differ:2,start:2,associ:[2,3],interact:[0,3],hdf5_root:1,system:3,messag:1,termin:1,white:2,conveni:2,"final":2,includ:[2,5],option:[2,1],methodolog:[0,3],specifi:2,part:3,enclos:2,moder:3,than:[2,3],png:2,serv:2,kind:2,john:2,target:3,keyword:2,prevent:2,rate:2,structur:2,exampl:[2,1],project:5,were:2,posit:2,arrang:2,toward:2,markup:2,randomli:3,comput:[0,1],viewer:2,sab:2,ani:[2,3],have:[2,3,1],tabl:2,need:[2,1],seen:2,equival:2,upscatt:3,note:2,also:[0,1,2],contact:0,build:1,which:[2,1],environ:2,mit:1,singl:2,begin:2,unless:1,distribut:[2,3,1],trace:2,normal:[3,1],track:3,who:2,compress:2,most:2,letter:2,phase:2,choos:1,herman:5,appear:2,cover:2,quantiti:2,col_spec:2,declar:2,determin:2,effect:[2,3],axi:2,neutrno:3,reactor:0,text:1,random:2,corner:2,find:2,make:[3,1],xml:[2,4],cell:2,onli:2,explicitli:2,ratio:2,firstnam:2,configur:1,activ:5,written:[2,3],should:[2,1],mcnp:0,fuel:2,surviv:2,contribut:2,get:1,kinemat:3,familiar:2,express:2,secondari:[2,3],ssh:1,increas:2,requir:2,use_mpi:1,enabl:[2,1],"default":2,she:2,contain:2,openmc:[0,1,2,3,4,5],depar:2,where:[2,3],set:[2,1,4],elimin:2,elast:3,see:[2,3,1],nuclid:2,result:2,respons:2,close:2,particl:[0,3,2],infinit:2,boundari:2,fission:2,irfanview:2,figur:2,score:2,between:[2,3],across:2,attribut:2,assumpt:[2,3],kei:1,numer:2,screen:1,physicist:2,extens:2,lower_left:2,solv:3,group:[0,2],addit:1,reaction:2,last:2,ptabl:2,cycl:2,interprocedur:1,howev:3,etc:2,mont:[0,5,3,2],tutori:4,equat:3,mani:[2,3],com:1,comment:2,pre:2,simpli:2,point:[2,3],color:2,overview:[2,4],roulett:2,respect:2,guid:[0,4],assum:[2,3],smith:[2,5],quit:2,slowli:3,creat:[2,3,4],addition:2,due:[2,3],been:1,implicit:2,compon:2,accumul:2,much:2,interest:[2,3],basic:2,use_hdf5:1,both:1,imag:2,andrew:5,coordin:2,els:1,present:2,emploi:2,subsequ:2,look:2,gnu:1,solid:[0,2],batch:2,rectangular:2,defin:2,"while":2,abov:[2,3,1],region:2,almost:3,site:2,bias:2,quadrat:2,ascii:2,proport:3,develop:[0,5],welcom:4,incorrectli:2,perform:[2,4],began:0,gprof:1,cross:[0,3,2],same:[2,3,1],html:2,probabl:[2,3],neutron:[0,4,3,2],higher:2,incorrect:[2,3],optim:1,nest:2,siegel:5,capabl:[0,2],moment:2,user:[0,4,1,2],immedi:2,implement:[2,1],sete:2,lower:2,off:[2,3],center:2,older:1,entri:2,thu:3,usual:2,well:[2,1],person:2,without:[2,1],command:[2,1],wherebi:[2,3],thi:[2,3,1,4],interpol:2,model:[0,2],dimension:2,left:2,identifi:2,birth:2,just:2,when:[2,3,1],obtain:1,rest:3,kill:2,aspect:[2,4],paul:[0,5],languag:2,cut:2,miscellan:2,makefil:1,paral:2,fortran:1,rgb:2,valid:[2,1],treatment:2,densiti:2,input:[2,4],save:2,match:2,take:2,bin:[2,1],format:[0,2],webpag:2,piec:2,realiz:2,grid:2,background:2,vacuum:2,characterist:2,string:2,loss:2,intel:1,specif:[2,4],arbitrari:2,plane:2,temperatur:3,flux:2,either:2,output:[2,1],right:2,often:2,captur:2,some:2,percentag:2,born:2,mpich2:1,sampl:[2,3],integ:2,inact:2,guess:2,transport:[0,3],transmiss:2,slice:2,lead:2,per:2,larg:[2,3],select:2,condit:2,combinatori:2,refer:2,machin:1,object:2,run:[2,1],perpendicular:2,host:1,squeez:2,prerequisit:1,post:2,simpler:2,src:1,about:2,actual:[2,1],gnome:2,materi:[2,3,4],slightli:2,simul:[0,4,2],union:2,stand:2,produc:2,crpg:1,cutoff:2,own:1,effici:2,xyz:2,"float":2,bound:[2,3],ppm:2,three:2,down:[2,1],calcult:2,your:1,stretch:2,git:1,span:2,wai:2,execut:1,support:1,custom:2,verbos:2,width:2,interfac:[2,1],low:3,overhead:2,"function":3,form:[2,3],roulet:2,atom:2,russian:2,line:[2,1],talli:[2,4],count:2,absent:2,isotrop:3,possibl:[2,1],whether:2,coeff:2,mpi_root:1,displai:2,below:2,otherwis:2,problem:2,cellborn:2,featur:[2,1],constant:3,pin:2,dure:2,repres:2,pix:2,file:[2,1,4],doe:2,fill:2,assembl:2,denot:2,interg:2,nonetheless:3,benoit:5,percent:2,detail:2,bracket:2,collis:[2,3],special:2,spatial:2,test:1,you:[4,1],survival_bias:2,architectur:1,repeat:2,intend:1,kord:5,eigenvalu:2,uniformli:2,debian:1,reduc:2,experienc:1,nucleu:3,directori:1,mask:2,ignor:3,time:[2,3],nuclei:3},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/input.html b/usersguide/input.html index aa49a1b074..e955f36b67 100644 --- a/usersguide/input.html +++ b/usersguide/input.html @@ -357,18 +357,25 @@ performed. It has the following attributes/sub-elements:

-cycles:

The number of total fission source iterations.

+batches:

The total number of batches, where each batch corresponds to multiple +fission source iterations. Batching is done to eliminate correlation between +realizations of random variables.

Default: None

-inactive:

The number of inactive fission source iterations. In general, the starting -cycles in a criticality calculation can not be used to contribute to tallies -since the fission source distribution and eigenvalue are generally not -converged immediately

+generations_per_batch: + 

The number of total fission source iterations per batch.

+

Default: 1

+ + +inactive:

The number of inactive batches. In general, the starting cycles in a +criticality calculation can not be used to contribute to tallies since the +fission source distribution and eigenvalue are generally not converged +immediately.

Default: None

-particles:

The number of neutrons to simulate per fission source iteration.

+particles:

The number of neutrons to simulate per fission source iteration.

Default: None

@@ -408,6 +415,17 @@ roulette.

+
+

energy_grid Element

+

The energy_grid element determines the treatment of the energy grid during a +simulation. Setting this element to “nuclide” will cause OpenMC to use a +nuclide’s energy grid when determining what points to interpolate between for +determining cross sections (i.e. non-unionized energy grid). To use a unionized +energy grid, set this element to “union”. Note that the unionized energy grid +treatment is slightly different than that employed in Serpent.

+
+
Default: union
+

entropy Element

This element describes a mesh that is used for calculting Shannon entropy. This @@ -644,38 +662,136 @@ separate can lead to incorrect results.

Geometry Plotting Specification – plot.xml

-

A rudimentary plotting capability is available in OpenMC by specifying a -plot.xml file and subsequently running with the command-line flag -plot. The -root element of the plot.xml is simply <plot> and four sub-elements can be -defined to configure the plotting range and resolution.

-
-

origin Element

-

The origin element has no attributes/sub-elements and indicates the -Cartesian coordinates of the center of the plot.

+

A basic 2D plotting capability is available in OpenMC by creating a +plots.xml file and subsequently running with the command-line flag -plot. The +root element of the plot.xml is simply <plots> and any number output +figures can be defined with <plot> sub-elements.

+
+

plot Element

+

Each plot must contain a combination of the following attributes or sub-elements:

-
Default: None
+
+++ + + + + + + + + + + + + + +
id:

The unique id of the plot.

+

Default: None - Required entry

+
filename:

Filename for the output plot file.

+

Default: “plot”

+
color:

Keyword for plot coloring. This can only be either cell or mat, +which colors regions by cells and materials, respectively.

+

Default: cell

+
origin:

Specifies the XYZ coordinate of the center of the plot. Should be 3 floats +separated by spaces.

+

Default: None - Required entry

+
width:

Specifies the width of the plot along each of the basis directions. +Should be 2 or 3 floats separated by spaces for 2D plots and 3D plots, +respectively.

+

Default: None - Required entry

+
type:

Keyword for type of plot to be produced. Currently only slice plots are +implemented, which create 2D pixel maps saved in the PPM file format. PPM +files can be displayed in most viewers (e.g. the default Gnome viewer, +IrfanView, etc.).

+
+

Note

+

Since the PPM format is saved without any kind of compression, +the resulting file sizes can be quite large. Saving the image in +the PNG format can often times reduce the file size by orders of +magnitude without any loss of image quality.

-
-

width Element

-

The width element has no attributes/sub-elements and indicates the width of -the plot in each of the basis directions.

+

Default: “slice”

+
+
+

plot elements of type slice also contain the following attributes or +sub-elements:

-
Default: None
+
+++ + + + + + + + + + + + +
basis:

Keyword specifying the plane of the plot for slice type plots. Can be +one of: xy, xz, yz.

+

Default: xy

+
pixels:

Specifies the number of pixes to be used along each of the basis directions for +slice plots. Should be 2 integers separated by spaces.

+
+

Warning

+

The pixels input determines the output file size. For the PPM +format, 10 million pixels will result in a file just under 30 MB in +size.

-
-

basis Element

-

The basis element has no attributes/sub-elements and indicates the specified -basis for plotting. The only option option currently accepted is “xy”.

-
-
Default: xy
+
+

Warning

+

If the aspect ratio defined in pixels does not match the aspect +ratio defined in width the plot may appear stretched or squeezed.

-
-

pixel Element

-

The pixel element has no attributes/sub-elements and indicates the distance -between horizontal rays sent through the geometry to record surface crossings. A -smaller pixel will result in a higher-resolution plot.

-
-
Default: 0.01
+
+

Warning

+

Geometry features along a basis direction smaller than width/pixels +along that basis direction may not appear in the plot.

+
+

Default: None - Required entry for slice plots

+
background:

Specifies the RGB color of the regions where no OpenMC cell can be found. Should +be 3 integers deparated by spaces.

+

Default: 0 0 0 (white)

+
col_spec:

Any number of this optional tag may be included in each plot element, which can +override the default random colors for cells or materials. Each col_spec +element must contain id and rgb sub-elements.

+ +++ + + + + + +
id:Specifies the cell or material unique id for the color specification.
rgb:Specifies the custom color for the cell or material. Should be 3 intergers separated +by spaces.
+

Default: None

+
mask:

The special mask sub-element allows for the selective plotting of only +user-specified cells or materials. Only one mask element is allowed per plot +element, and it must contain as atributes or sub-elements a background masking color and +a list of cells or materials to plot:

+ +++ + + + + + +
components:List of unique id numbers of the cells or materials to plot. Should be any number +of integers separated by spaces.
background:Color to apply to all cells or materials not in the components list of cells or +materials to plot. This overrides any col_spec color specifications.
+

Default: None

+
+