Ecosyste.ms: Repos
An open API service providing repository metadata for many open source software ecosystems.
GitHub / terrapower / terrapower.github.io
Documentation website build
JSON API: https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrapower%2Fterrapower.github.io
Stars: 6
Forks: 3
Open Issues: 0
License: None
Language: HTML
Repo Size: 700 MB
Dependencies:
188
Created: over 4 years ago
Updated: 10 days ago
Last pushed: 10 days ago
Last synced: 10 days ago
Commit Stats
Commits: 800
Authors: 23
Mean commits per author: 34.78
Development Distribution Score: 0.334
More commit stats: https://commits.ecosyste.ms/hosts/GitHub/repositories/terrapower/terrapower.github.io
Topics: clean-energy, nuclear, nuclear-reactor
Files
Loading...
Readme
Loading...
Dependencies
- ARMI *
- Requirements *
- ThissectiongivesageneraloverviewoftherequirementsofARMI.Theserequirements *
- aremeanttosatisfyNRCregulationsandalsogiveafirmbasisforthehigh-level *
- belinkedtobothunittestsandsourcecodewithintheARMIrepository. *
- goalsofARMI. *
- implementationsinthesourcecodeorconfiguration.Ideally ,eachrequirementwill
- sdid *
- srsd *
- str *
- ARMItreatsdimensionsandmaterialpropertiesasfunctionsoftemperature.However ,apurephysicalanalogyischallengingforseveralreasons.Thesereasonsandtheimplementationdetailsareexplainedhere.
- Anothererrorpreventiontoolisthecustomizabilityofindividualsettings.Asmentionedpreviously ,acompleteunderstandingofthecomplexmeaninginvolvedinsettingvaluescan
- Asmutableobjectsareencompassedinthelistofsupporteddatatypes ,itbecameimportanttopreventtheperversionoftheircontainedvalueswithalterationsthatwouldbypasstheprotectivemethodsonsettingobjectsentirely.Suchanexamplewouldbewhenalistisreturnedfromtheappropriatelistsettingobject,andsomethingisappendedtoit.Thiswouldbypassallerrorpreventionmethodologyinplace.Theeasiestfixforthiswastoreturnadeepcopyofthecontainedvalue,andonlyreassignthecontainedvalueonanexplicitvalueassignmentstatement
- Ateachlevelofthehierarchy ,thestatecanbefoundasastatevariablecalleda
- Averagingoverchildren *
- BecauseARMIiswritteninPython ,there
- BlueprintsDesign *
- CalculationOfVolumeFractions *
- ComputingHomogenizedNumberDensities *
- Design *
- Dictionary-likebehavior *
- Eachsettingisintendedtopresentawayofansweringaquestiontotheuserfromthesystem.Forexample ,manysettingsaskquestionslikewhatexternalcodeenginetoutilizeforadvancedcalculations,orwhattemperaturetoapplytoaparticularcomponent.Thesequestionsarenotopen
- Foratypical *
- Forexampleit *
- Foruserconvenience ,thedimensionsofonecomponentmaybeleftundefinedininput.Ifoneandonlyone
- Hotandinputdimensions *
- Improvesafetyaroundsettingserrors *
- Keeptheuser *
- Memberobjectsofthe *
- Non-dynamicdatatyping *
- NowthereareafinitesetofallowablesettingtypeswhichlooselymirrorthePythonprimitivedatatypes ,namely
- Objectscancomputehomogenizednumberdensitiesofeachnuclideasrequiredinmanynuclearsimulations *
- OnespecificcategoryofsafetyinthesettingssystemstemsfromthenatureofdatavariablesinPython. *
- Overview *
- ReactorDesign *
- ReactorOverview *
- RequirementsReview *
- Settingandgettingstatevariables *
- SettingsDesign *
- SettingsOverview *
- Similarly ,
- SoftwareDesignandImplementationDocument *
- SpatialArrangements *
- TODO *
- The *
- Thecomponentscontainedineachblockhaveheterogeneouscompositionsanddimensionsthatmustbesmearedinto *
- Thecustomizabilityofsettings *
- Thelookupfashionedas *
- Themaindesignprinciplesforthesettingssystemare *
- Thephysicalhierarchytypicalinanuclearreactorisreflectedinthedesignofthereactorpackage. *
- Thesekindsofhardtotrackmistakeswereresolvedbycreatingamoreobjectorienteddivisionofsettingswithtypeprotectionsurroundingthesetting *
- Thesettingspackageisalong-timefeatureofARMI.Itwasmadetofillthenicheofgatheringuserinputonwhatshouldbesimulatedandwhatresultsshouldbegenerated. *
- ThesettingssystemfunctionsmuchlikeaPythondictionaryformostofitsinteractions. *
- Thesettingssystemiswritteninadefensivefashion ,asit
- Thesettingsystemisdesignedtobeextensible ,sodevelopersmayaddfurthersettingvalidationspecifictothesettingstheyadd.
- Thetwoobjectstonoteinthisinterplayarethe *
- Thiscalculationisperformedin *
- Thisistheprincipledesignrestraintforthesettingspackage.Thesettingsmustbeeasytouse ,human
- Thisisusefulforcollectinginformationatlevelsnecessaryformeaningfulanalysis ,forexample
- Thus ,homogenizednumberdensitiesareequaltoheterogeneousnumberdensitiesmultipliedbythecomponentvolume
- Tohomogenizenumberdensities ,conservationofatomsisapplied.Consideraacollectionof
- Tosupportthehomogenizationresponsibility ,the
- Whenusersperformlookupsandvalueassignmentstoakeyonthesettingsobject ,ithidesabitoftheworkbehindthescenesofapplyingsettingrules.
- Whilesimplicityremainsaprincipleconcern ,someallotmentforerrorpreventionhastobeallowed.Abasicsystemthatcanbemisusedwildlyisinherentlymorecomplexthanonewithalittleoverheadthatworkstokeepnastysurprisesatbay.
- ahomogeneousblock ,asshowninFigure1.
- areaiscomputedusingthelargestpitch *
- aresatisfiedbytheobjectsinthishierarchy. *
- component *
- componenthasundefinedarea ,thentheblockwillcomputetheareaautomatically.Thisisuseful,forexample,
- figuringoutacore-averagedtemperatureorforhomogenizingregionsinpreparationofneutronicsmodels. *
- fraction. *
- grid.Inparticular ,
- heterogeneousnumberdensity *
- howtheobjectitselfbehaves.AprimeexampleofthisistheGUI. *
- iscomputedas *
- nuclidesinastructureand *
- ofatoms. *
- ofcomponent *
- otherlevelsofthehierarchysimplyhavetoevaluatethesimpleformula ,
- part-wholehierarchies.Inotherwords ,aReactoristypicallymadeofAssemblies,whicharemadeofBlocks,
- returnsthesettingobjectitself.Onlymorecomplexrelationshipswithcoupledcodetoolswillbeconcernedwith *
- systemisdesignedandimplementedtosatisfytherequirementsrelatedtostoringandupdatingadynamicstate. *
- totalvolume *
- whenacomplexshapeexistsforthecoolantmaterialbetweenallpins.Inthisscenario ,themaximumblock
- whicharemadeofComponents ,andsoon.Requirementsregardingtherepresentationofauser
- willonlyreturnthecurrentvalueofthesettingstoredunder *
- 1.GeneratecrosssectionsforasetofnuclideswiththexsID =AA1.GeneratecrosssectionsforasetofnuclideswiththexsID=AB1.Generatecrosssectionswithtworegionsusinganinputfilecontainingthenuclidesoftheabovetwocases.
- ARMIhasaconceptof *
- ARMIshallallowforthemodelingofareactorovermultiplecycles. *
- ARMIshallallowtheuserspecificationoftranslationpathwaysforcertainobjectsto *
- ARMIshallautomaticallycomputeandappliedthermalexpansionandcontraction *
- ARMIshallcheckitsinputforcertainobviouserrorsincludingunphysicaldensitiesandproperfit. *
- ARMIshallsupportregular ,repeatingmeshesinhexagonal,radial
- ARMIshallsupportsymmetricmodelsincluding1 *
- ARMIshallsupportthefollowingbasicshapes *
- AnytwoARMIrunswiththesameinputfilemustproducethesameresults. *
- Appendices *
- ApplicableDocuments *
- Asthereportpackageisalightweightinterfacetowritedataouttoatextbasedformat ,andrenderafewimages,theperformancecostsareentirelynegligibleandshouldnotburdentherun,northeuser
- Basedonusersettings ,theordering,initialization,andcallstootherpluginsshallbecoordinatedbytheoperatorpackage.Theoperatorpackagemustthereforebeawareofdependenciesofeachplugin.
- BusinessImpact *
- DLAYXSfilescontaindelayedneutrondata ,suchasprecursordecayconstantsandnumberofneutronsemitted,
- Dummynuclides ,typicallywritteninallcapitalsas
- EachsettingsfileisonlygenuinelyvalidwiththeversionofARMIthatgeneratedthefile ,assettingsmightchangebetweenversions.Asasafegaurdofthis,thesettingssystemshallalerttheuseriftheversionofthesettingsfiledoesnotmatchtheversionofARMIin
- Forcoupledphysics *
- Forperformance ,manyphysicscalculationsaredoneinparallel.Thereactormustbeabletosynchronize
- FunctionalRequirements *
- GAMISOfilesaregeneratedbyMCC-v3 ,andarethesameformatasanISOTXSfile.Thefilecontainsphotoninteractioncrosssectionsinsteadofneutroncrosssections.
- Giventhefunctionalrequirementsofthereportpackage ,newdevelopersshouldbeabletounderstandhowtocontributetoareportnighinstantly.NonewtechnologiesshouldbeintroducedtothesystemasHTMLandASCIIarebothpurelytext
- GiventheubiquityofPython *
- Givenuserinputdescribingareactor ,ARMIshallconstructwithequivalentfidelityasoftwaremodelofthereactor.Inparticular,ARMIshallappropriatelyrepresenttheshape,arrangement,connectivity,dimensions,materials
- ISOTXSfilescontainthemulti-groupmicroscopiccrosssections ,andothernucleardata,foreachnuclidebeingmodeled.Themulti
- Inadditiontothedecaychain ,nuclidesmaytransmutethroughinteractionsintoothernuclides.ThenucDirectoryshallcontaintransmutationsincluding
- Inordertocalculatetheuncertaintiesofourmethodologyintroducedbynucleardatauncertainty ,itisnecessarytobeabletoperturb
- InterfaceI *
- Itshallbepossibletosupportavalidlistorrangeofvaluesforanygivensetting. *
- Lumpednuclidesarebulkdefinednuclidesthataretypicallyusedwhenmodelingfissionproducts.Lumpingthenuclidesduringburnupcalculationslowerstheproblemsizewithouthavingasignificantimpactontheresults.Consequently ,theydonotalwaysneedtobemodeledindividually,butcanbegrouped.
- Manyanalysistasksrequirehighperformancecomputing *
- Manyofthesettingswillnotbealteredbytheuserofarun ,andtherewilllikelybetoomanyforausertodealwithonanindividualbasis.Therefore,mostsettingswillneedtofunctionsensiblywiththeirdefaultvalue.Thisdefaultvalueshallalwaysbeaccessiblethroughouttherunslifecycle.
- Notwosettingsmaysharenames. *
- Often ,apluginisreplacedwithanewpluginfulfillingsomenewrequirement.Whenthishappens,theoperatorpackageshallisolaterequiredchangestothenewplugin.Forexample,ifafuelperformancepluginneedstemperaturesbutthetemperature
- Open-ItemsandAssumptions *
- OtherphysicscodesusethenameAm-242forthemetastablestateofAm-242 ,anduseAm
- PMATRXfilescontainthegammaproductionmatrixresultingfromfissionorcaptureevents.Givenaneutronfluxdistribution ,andaPMATRXfile,thegammasourcecanbecomputedandthenusedtodeterminegammatransportandheating.
- PerformanceRequirements *
- Settingsdefinedinthesystemmusthaveboththeintendeddatatypeanddefaultvaluedefined ,oritisconsideredincompleteandthereforeinvalid.Additionallythesystemshallnotacceptmultipledefinitionsofthesamename.
- Settingsshallexistexclusivelyasawell-defineddatatype ,aschosenbythesettingdefinition.
- SoftwareAttributes *
- SoftwareDesignConstraints *
- SoftwareRequirementSpecificationDocument *
- TODO *
- TestingRequirements *
- Thedatabaseimplementationshalluselosslesscompressiontoreducethedatabasesize. *
- Thedatabaseshallfaithfullyrepresentthepossessedinformationandnotalteritscontents ,retrievingthedataexactlyasinput.
- Thedecaychainisanimportantstepinperformingburn-upcalculations.ThenucDirectoryshallcontainnecessarydecaymechanisms *
- ThenucDirectorypackageshallcontainthefollowinggeneralinformationforeachnuclide *
- ThenucDirectorypackageshallnotusedatadataretrievedfromonlinesources.Theintenthereistopreventinadvertentsecurityrisks. *
- ThenucDirectoryshallcontainthehalf-life ,decaymode
- ThenucDirectoryshallcontainthetransmutationmechanism ,branchratio,andproductnuclidesofeachtransmutationbeingmodeled.ThenucDirectoryshallnotcontainthecrosssections,asthesearecalculatedusinglatticephysicscodes,suchasMCC.Sinceitispossiblefortheusertodefinespecificnuclidestobemodeled,thenucDirectoryshallallowoptionaldaughternuclides.
- ThenucleardatafilescreatedbyphysicscodessuchasMCCandDIF3DmaynotnecessarycorrespondtothenameusedwithinARMI ,itwillbenecessarytoloadnuclideinformationbasedonanon
- Thenucleardatalibrariesavailableinversions2and3ofMCCdonotalwaysallowfornuclideinput ,andsomematerialsaregroupedintoelementalnuclides.IronisanexampleofthisinMCCversion2.Consequently,ARMIneedstobeabletomodelelementalnuclideswhichrepresenttheentireelement,aswellastheindividualnuclides.
- Thenuclidesnamesshallbeunique ,andconsistofthenuclide
- TheoperatorpackageshallreceiveoutputfromcalculationPluginsandstoretheresultsonawell-definedcentralmodel.Acompositepatternshallbeused ,withaReactorcontainingAssembliescontainingBlocks,etc.
- Thereactorpackageshallcheckitsinputsforcertainobviouserrorsincludingunphysicalquantities.Atadeeplevel ,thereactorpackagewillnotattempttofullyvalidatesubtleengineeringaspectsofthereactor
- Thereactorstateshalebemadeavailabletousersandplugins ,whichmayinturnmodifythestate.ARMIshallfullydefinehowallaspectsofstatemaybeaccessedandmodifiedandshallreflectanynewstateafteritisapplied.
- Thereactorstateshallberepresentedasevolvingeitherthroughtime *
- Thereportpackageshallnotmodifyorsubvertdataintegrityasitreportstheinformationouttotheuser. *
- Thesettingpackageshallaccomodatetheintroductionofnewsettings ,renamingofoldsettings,andsupportthecomplexdeprecationbehaviorsofsettings.
- Thesoftwareshallbecapablemergingmultiplefilesofthesametype *
- ThesoftwareshallbecapableofreadingaDLAYXSfileintomemory ,andwritingitoutintoafilethatisexactlythesameastheoriginal.
- ThesoftwareshallbecapableofreadingaGAMISOfileintomemory ,andwritingitoutintoafilethatisexactlythesameastheoriginal.
- ThesoftwareshallbecapableofreadinganISOTXSfileintomemory ,andwritingitouttoafilethatisexactlythesameastheoriginal.
- Thesoftwareshallbemadeflexiblesuchthatthedefinitionofspecificnuclidesavailable *
- ThesoftwareshallmakethenucleardataprovidedinISOTXS ,GAMISO,PMATRXandDLAYXSavailableintheformofPythonobjects,suchthatitcanbeusedelsewhereinthecode,suchasinthedepletion,nuclearuncertaintyquantification,and
- Thestateinformationrepresentingasnearaspossibletheentiretyoftherunwhenthedatabasewritewasexecuted ,shallberetrievabletorestorethepreviouscasetoaparticularpointintimeforfurtherusebyanalysts.
- ThethirdMCC-v3casewillproduceamergedISOTXSfilewhichcanbecomparedtoanISOTXSfilegeneratedbymergingtheoutputISOTXSfromcases1and2. *
- Theusermustbeabletoreadandedittheirsettingsfileasplaintextinbroadlyanytypicaltexteditor. *
- Theusersuppliesthenuclidestobemodeledinthesimulation *
- Thiscanbecoveredinaunittestwhichruns3MCC-v3cases. *
- Tomaintainconsistencywiththephysicalreactorbeingmodeled ,ARMIshallmaintainahierarchicaldefinitionofitscomponents.Forexample,allthefuelpinsinasinglefuelassemblyinasolid
- UtilizingthedocumentationoftheARMIprojectthesettingssystemshallcontributeapagecontainingatablesummaryofthesettingsincludedinthesystem. *
- Versions2and3ofMCCallowforunique6characterlabelstobeusedtoreferencenuclides.Twocharactersneedtobeusedtodescribethedifferentcrosssectionsetsusedbytheproblem.Therefore ,everynuclideinARMIneedstohaveaunique4characterrepresentationtouseinMCCandthedownstreamglobalfluxsolver.
- Whenausercreatesasettingtwice ,itshallbedetectedasanerrorwhichisraisedtotheuser.
- Whennucleardatafilesareread ,theyshouldbemadeavailableinacontainerobject,suchasadictionary,andkeyedonthenuclidelabel
- couldpropagateandinvalidateresultsderivedfromARMItoperformdesignandanalysis.Therefore ,the
- follow ,tosupportmovingcontrolmechanisms.
- ofmaterials. *
- thestateonmultipleprocessorsefficiently. *
- ARMIVersiontested *
- Acceptabiltiy *
- Actiontakeninconnectionwithanydeviationsnoted *
- Computer *
- Dateofthetest *
- InputandOutputData *
- Introduction *
- Overview ,Assumptions,andResults
- Resultsandapplicablility *
- RuntimeEnvironment *
- Simulationmodelused *
- SoftwareTestReport *
- TODO *
- TestAutomation *
- Testequipmentandcalibration *
- Tester *
- Tests ,Requirements,andImplementation
- ValidationPlan *
- VerificationPlan *
- VerificationandValidationPlan *