onix.Cell¶

class onix.Cell(cell_id, name)[source]¶

Cells (or BUCells), represent burnup regions and contain a unique onix.Passlist object with a specific list of nuclides.

Parameters

cell_id (int) – The id number of the BUCell
name (str) – The name of the BUCell

property bu_sec_conv_factor¶: Returns the conversion factor to go from time (seconds) to burnup (MWd/kg) for the BUCell.

check_act_presence()[source]¶: Check whether actinides are present in the material of the BUCell.

property decay_a_lib¶: Returns an absolute decay dictionnary where keys are nuclides’ names and entries are decay sub-dictionnaries. The keys of these sub-dictionnaries are the names of the decay reactions and the entries are the absolute values of the corresponding decay constant in \(s^{-1}\).

property decay_b_lib¶: Returns a fractionnal decay dictionnary where keys are nuclides’ names and entries are decay sub-dictionnaries. The keys of these sub-dictionnaries are the names of the decay reactions and the entries are the fractions of the corresponding decay constant over the total decay constant.

property fy_lib¶: Returns a dictionnary where keys are fission products’ names and entries are fission yield sub-dictionnaries. The keys of these sub-dictionnaries are fissionning parents’ z-a-m id and the entries are the value the corresponding fission yield in percent (values between 0 to 100).

get_act_passport_list()[source]¶: Returns a list of Passport objects of all actinides present in the BUCell.

get_avt_passport_list()[source]¶: Returns a list of Passport objects of all activation products present in the BUCell.

property get_decay_nucl¶: Returns the list of nuclides for which decay data exists in the provided decay library.

get_fp_passport_list()[source]¶: Returns a list of Passport objects of all fission products present in the BUCell.

get_fy_nucl()[source]¶: Returns the list of fission products for which fission yields data exists in the provided fission yield data library.

get_fy_parent_nucl()[source]¶: Returns the list of fissioning parents for which data exist in the fission yield library.

get_hm()[source]¶: Returns the current heavy metal mass contained in the BUCell (g).

get_lib_nucl()[source]¶

Returns the full list of nuclides for which there are data in the nuclear libraries (deay, cross section or fission yield). This is the full list of nuclides modelled in the depletion network.

This command does not work when the mode for cross sections is set to ‘constant lib’.

get_nucl_ao(nucl_id)[source]¶

Returns the atom fraction of a nuclide over the total number of atoms in the BUCell.

Parameters: nucl_id (str) – The z-a-m id or the name of the nuclide

get_nucl_list()[source]¶: Gets the list of nuclides contained in the Passlist object of the BUCell.

get_nucl_subao(nucl_id, nucl_list)[source]¶

Returns the atom fraction of a nuclide over the number of atoms of a sub-set of nuclides in the BUCell.

Parameters

nucl_id (str) – The z-a-m id or the name of the nuclide
nucl_list (list) – The list of nuclides that constitute the sub-set of nuclides

get_nuclide(nuclide_id)[source]¶

Returns the Passport object of a nuclide.

Parameters: nuclide_id (str) – Name or z-a-m id of a nuclide

get_subtotal_dens(nucl_list)[source]¶

Returns the total density of sub-set of nuclides in the BUCell in \(10^{24}cm^{-3}\).

Parameters: nucl_list (list) – A list of nuclides’ names

get_total_dens()[source]¶: Returns the total density of all nuclides in the BUCell in \(10^{24}cm^{-3}\).

property get_tree¶

Gets the generation tree for the BUCell. This returns a dictionnary where keys are the z-a-m id of initial nuclides of the BUCell. The entry for each initial nuclide is a list of generations. Each element of this list represents a generation of daughter nuclides (they are themselves lists of all the daughters from one generation).

Daughters of generation n will be located in the nth list. There are separated by n-1 intermediate nuclides from the initial nuclide.

This method is very useful to see which nuclides will be produced from an initial nuclide. It requires, however, that nuclear data libraries are set to the BUCell (this can be a problem in coupled simulation as cross section data are only produced after OpenMC simulations).

property get_xs_nucl¶: Returns the list of nuclides for which cross section data exists in the provided cross section library.

property hm_vol¶: Returns the volume of the heavy metal regions of the BUCell in \(cm^{-3}\).

property id¶: Returns number id of BUCell

property ihm¶: Returns the initial heavy metal (IHM) mass contained in the BUCell (g).

property initial_nucl¶: Returns the initial list of nuclides.

property name¶: Returns name of BUCell

property passlist¶: Returns the Passlist object of the BUCell.

set_decay(decay_object)[source]¶

Sets the decay library from an ONIX decay object defined by the user for the BUCell.

Parameters: object (onix.utils.decay_lib) – A decay library object constructed by the user with onix.utils.decay_lib.

set_decay_lib(decay_lib_path)[source]¶

Sets the decay library for the BUCell.

This function will add all nuclides for which there are decay data in the library but which are not yet in the onix.Passlist object of the BUCell. This means that the depletion system will be significantly enlarged.

Parameters: decay_lib_path (str) – Path to the decay library provided by the user

set_default_decay_lib()[source]¶

Sets the decay library to the default one (ENDF/B-VIII.0) for the BUCell.

This function will add all nuclides for which there are decay data in the library but which are not yet in the onix.Passlist object of the BUCell. This means that the depletion system will be significantly enlarged.

set_default_decay_lib_no_add()[source]¶

Sets the decay library to the default one (ENDF/B-VIII.0) for the BUCell.

This function will only take nuclear decay data for nuclides that are already in the onix.Passlist object of the BUCell. This enables to run simulation where the depletion system is not enlarged when adding decay data.

set_default_fy_lib()[source]¶

Sets the fission yield library to the default one (ENDF/B-VIII.0) for the BUCell.

This function will add all nuclides for which there are fission yield data in the library but which are not yet in the onix.Passlist object of the BUCell. This means that the depletion system will be significantly enlarged.

set_default_fy_lib_no_add()[source]¶

Sets the fission yield library to the default one (ENDF/B-VIII.0) for the BUCell.

This function will only take fission yield data for nuclides that are already in the onix.Passlist object of the BUCell. This enables to run simulation where the depletion system is not enlarged when adding fission yield data.

set_default_xs_lib()[source]¶: Sets the cross section library to the default one. The default cross section library in ONIX has been obtained by computing middle-burnup one-group cross section for a coupled simumation of a LWR fuel pin-cell. Therefore, this library is only adapted for LWR reactors.

set_default_xs_lib_no_add()[source]¶

Sets the cross section library to the default one. The default cross section library in ONIX has been obtained by computing middle-burnup one-group cross section for a coupled simumation of a LWR fuel pin-cell. Therefore, this library is only adapted for LWR reactors.

This function will only take nuclear decay data for nuclides that are already in the onix.Passlist object of the BUCell. This enables to run simulation where the depletion system is not enlarged when adding cross section data.

set_fy(fy_object)[source]¶

Sets the fission yield library from an ONIX fission yield object defined by the user for the BUCell.

Parameters: object (onix.utils.fy_lib) – A fission yield library object constructed by the user with onix.utils.fy_lib.

set_fy_lib(fy_lib_path, complete)[source]¶

Sets the fission yield library for the BUCell.

This function will add all nuclides for which there are fission yield data in the library but which are not yet in the onix.Passlist object of the BUCell. This means that the depletion system will be significantly enlarged.

Setting the complete parameter to True allows ONIX to complement the data of the provided library with additional data found in ENDF/B-VIII.0.

Parameters

fy_lib_path (str) – Path to the fission yield library provided by the user
complete (bool) – Indicates to ONIX whether or not to complement the provided library with additional fission yields from ENDF:B-VIII.0 library.

set_initial_dens(dens_dict)[source]¶

Sets the initial densities of nuclides in \(10^{24}cm^{-3}\).

Parameters: dens_dict (dict) – A dictionnary where keys are nuclides’ names and entries are densities in \(10^{24}cm^{-3}\)

set_passlist(nucl_list)[source]¶

Creates and sets a Passlist object to the BUCell using the provided nuclides list.

Parameters: nucl_list (list) – List of nuclides to create a Passlist object for the BUCell

set_xs(xs_object)[source]¶

Sets the cross section data from an ONIX cross section object defined by the user for a specific BUCell.

Parameters: object (onix.utils.xs_lib) – A cross section library object constructed by the user with onix.utils.xs_lib.

set_xs_lib(xs_lib_path)[source]¶

Sets the cross section library for the BUCell.

This function will add all nuclides for which there are cross section data in the library but which are not yet in the onix.Passlist object of the BUCell. This means that the depletion system will be significantly enlarged.

Parameters: xs_lib_path (str) – Path to the cross section library provided by the user

property vol¶: Returns the volume of the BUCell in \(cm^{-3}\).

property xs_lib¶: Returns a dictionnary where keys are nuclides’ names and entries are cross section sub-dictionnaries. The keys of these sub-dictionnaries are neutron-induced reactions names and the entries are the value the corresponding cross sections in barn.