onix.System¶

class onix.System(system_id)[source]¶

The system oject contains and organizes the ensemble of BUCells.

When running a standalone simulation, the system object is the the object with which the user can set certain attributes and parameters for the simulation (nuclear data libraries, burnup sequence, new BUCells). In a coupled simulation, the class onix.couple.Couple_openmc fullfills that role and passes-on directives to the system object.

Parameters: system_id (int) – Number id for the system object

add_bucell(new_bucell)[source]¶

Adds a new BUCell to System.

Parameters: new_BUCell (onix.Cell) –

property bounding_box¶: Returns the bounding box defined by the user for the system

property bucell_dict¶: Returns a dictionnary where keys are BUCell number ids and entries are corresponding BUCells objects

burn()[source]¶: Launches a standalone simulation.

get_bucell(name)[source]¶

Returns the BUCell object with corresponding name.

Parameters: name (str) – Name of the BUCell

get_bucell_list()[source]¶: Returns a list of the BUCell objects

get_tot_hm()[source]¶: Returns the current total heavy metal mass contained in System (g).

get_tot_ihm()[source]¶: Returns the total initial heavy metal (IHM) mass contained in System (g).

property id¶: Returns the number id of the system object.

reac_rank_on()[source]¶: Calling this method will tell ONIX to produce production and destrubtion reaction rates ranking for each nuclide and print the data for each BUCells. By default ONIX does not produce reaction rates ranking as it takes a lot of memory.

property sequence¶: Returns the sequence object associated with System

set_decay_for_all(decay_lib_path)[source]¶

Sets the decay library for all BUCells.

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 BUCells. 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_for_all()[source]¶

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

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 BUCells. This means that the depletion system will be significantly enlarged.

set_default_decay_for_all_no_add()[source]¶

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

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

set_default_fy_for_all()[source]¶

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

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

set_default_fy_for_all_no_add()[source]¶

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

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

set_default_xs_for_all()[source]¶

Sets the cross section library to the default one for all BUCells.

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_fy_for_all(fy_lib_path, complete)[source]¶

Sets the fission yield library for all BUCells. 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.

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

Parameters

decay_lib_path (str) – Path to the decay 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_sequence(sequence, mode='stand alone')[source]¶

Sets a sequence object to the System and distributes unique copies of the sequence object to each BUCells.

Parameters: sequence (onix.Sequence) – ONIX sequence object defined by the user

set_xs_for_all(xs_lib_path)[source]¶

Sets the cross section library for all BUCells.

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

property total_vol¶

Returns the total volume of the system. The total volume of the system is the volume of all BUCells plus the volume of regions that are not depleted (moderator for instance if no BUCell is created for the moderator).

In standalone mode, the total volume will simply be the addition of all BUCells’ volume as all regions should be depleted.