`depletion` – Read Tripoli-4 depletion results

Module to deal with ROOT outputs from Tripoli-4 in depletion mode.

This module is an interface with Tripoli-4 depletion results, stored as ROOT files, see the Tripoli-4 user guide and the ROOT website for more details.

The available results match the usual Tripoli-4 results from depletion:

k_eff as kcoll, ktrack, kstep;
β_:sub:eff from prompt and Nauchi, called beff_prompt and beff_nauchi;
renormalisation factor, called renorm
total power
power
local burnup
flux: fast neutron flux (fast_flux), thermal neutron flux (therm_flux) and total flux (flux)
mass
concentration
activity
reaction rates: for fast neutrons (fast_reaction_rate), for thermal neutrons (thermal_reaction_rate) and for one group (reaction_rate). The thermal group only gives non-zero results for fission rate.

Some of these results can be accessed from valjean using the DepletionReader class from this module. In some cases, it is necessary to provide keyword for the composition name (componame), the isotope name (isotope) or the reaction name (reaction).

Results can be obtained at a given depletion step (so a scalar value) or for all available steps, giving in both cases a Dataset. The access method of the array ends with _time if the required quantity is given in function of time and _burnup if it is in function of burnup.

A typical example of use of this module is the following:

from valjean.eponine.tripoli4.depletion import DepletionReader
depr = DepletionReader.from_evolution_steps(
    'evolution_1.root', 'evolution_2.root',
    root_build='/path/where/to/build/root/libraries')
# get kstep at step 1
kstep = depr.kstep(1)
# get kstep as a function of burnup
akstep = depr.kstep_burnup()
# get total power as a function of time
atotpow = depr.total_power_time()
# get U238 concentration in composition COMPO1 at step 5
conc_u238 = depr.concentration(step=5, componame='COMPO1', isotope='U238')
# get U238 fission reaction rate in composition COMP1 as a function of time
reac_u238 = depr.reaction_rate_time(componame='COMP1', isotope='U238',
                                    reaction='REAMT18')

Some helper methods provide the list of compositions, the list of isotopes in a given composition or the reaction rates associated to a given isotope in a given composition.

valjean.eponine.tripoli4.depletion.title_to_snake_case(word)[source]

Convert word from title case to snake case.

>>> title_to_snake_case('ThisIsATitle')
'this_is_a_title'

valjean.eponine.tripoli4.depletion.generic_docstrings(res_type, *list_params)[source]: Define generic docstrings for the access functions of depleted results.

valjean.eponine.tripoli4.depletion.add_accessors(dict_res)[source]: Automatic construction of result accessors.

class valjean.eponine.tripoli4.depletion.DepletionReader(mbr)[source]

Class to use depletion results from Tripoli-4

__init__(mbr)[source]

Initialisation of DepletionReader.

Parameters:: mbr – MeanBurnupResult

static init_postscripts(root_build='')[source]

Initialize postscripts from ROOT macros.

ROOT macros are in the resources/depletion folder. They are compiled in the __t4depletion__ folder to used afterwards.

classmethod from_evolution_steps(*fnames, root_build='')[source]

Initialisation from evolution.root files (one per simulation).

Parameters:: fnames (str) – ROOT files

classmethod from_mbr(fname, mbr_name, root_build='')[source]

Initialisation from ROOT file containing a MeanBurnupResults class.

Parameters:

fname (str) – ROOT file name
mbr_name (str) – name of the MeanBurnupResults object in the file

save_mbr(name)[source]

Save the MeanBurnupResults in a ROOT file.

Parameters:: name (str) – name of the output ROOT file name

nb_simu()[source]

Return the number of independent simulations.

Return type:: int

nb_compositions()[source]

Return the number of compositions.

:rtype; int

nb_steps()[source]

Return the number of steps.

Return type:: int

burnup(step)[source]

Return burnup from MeanBurnupResults object.

Parameters:: step (int) – calculation step to use to get the value
Returns:: burnup value and error
Return type:: Dataset

burnup_array()[source]

Return burnup array from MeanBurnupResults object.

Returns:: burnup value and error by step
Return type:: Dataset

time(step)[source]

Return time from MeanBurnupResults object.

Parameters:: step (int) – calculation step to use to get the value
Returns:: time value and error
Return type:: Dataset

time_array()[source]

Return time array from MeanBurnupResults object.

Returns:: time value and error by step
Return type:: Dataset

composition_names()[source]

Return the list of composition names.

Return type:: list(str)

isotope_names(step, componame)[source]

Return the list of isotopes in the given composition at the given step.

Parameters:

step (int) – calculation step to use to get the value
componame (str) – composition name in which list of isotopes is required

Returns:

list of available isotopes

Return type:

list(str)

reaction_names(step, componame, isotope)[source]

Get reaction names in composition for the given isotope.

Parameters:

step (int) – calculation step to use to get the value
componame (str) – composition name where reaction is required
isotope (str) – isotope name for which reaction is required

Returns:

list of available reactions

Return type:

list(str)

isotope_reaction_names(step, componame)[source]

Get dictionary of reactions per isotope for the given step and composition.

Parameters:

step (int) – calculation step to use to get the value
componame (str) – composition name where reactions per isotope are required

Returns:

reactions by isotopes

Return type:

dict(str, list(str))

dump_global_results(step)[source]

Print results for a given step.

This includes compositions.

activity(step, **kwargs)

Return the value of Activity from the MeanBurnupResults object.

Parameters:

step (int) – the index of the calculation step
componame (str) – composition name for Activity
isotope (str) – isotope which Activity is required

Returns:

Activity and error for the given step

Return type:

depletion – Read Tripoli-4 depletion results

`depletion` – Read Tripoli-4 depletion results