onix.Passport¶

class onix.Passport(nuc_id)[source]¶

Passport stores all the relevant data of indivudual nuclides and offers methods to extract information on them.

The passport class is individually instantiated for each nuclide. It contains two types of information: constant and variable data. Constant data, such as the atomic mass, decay constant or the element’s family (actinide or fission products) do not change over the course of a simulation. Variable data such as cross sections or fission yields do vary during a simulation and need to be updated regularly during a simulation. Some of the data are created at the time of the instantiation of the class such as the element’s family or the nuclide’s neutron reaction daughters. Other type of data, typically large in size such as cross sections and decay constants, are to be explicitly set or loaded by the code or by the user.

Parameters: nuc_id (str) – Name or z-a-m id of the nuclide.

property all_child¶: Returns all daughter products of the nuclide.

property all_parent¶: Returns all parents of the nuclide

property allreacs_dic¶: Returns an aggregated dictionnary with production and destruction terms of the nuclide

property allreacs_dic_list¶: Returns a list of aggregated dictionnaries with production and destruction terms of the nuclide. One dictionnary per microstep

property creation_dic¶

Returns a dictionnary of all the production terms of the nuclide.

The keys are the parent nuclides’ names with the reaction in parenthesis The entries are the reaction rates of the reactions in \(barn^{-1}cm^{-1}s^{-1}\)

property current_dens¶: Returns the current density of the nuclide in atom per \(cm^{3}\)

property current_xs¶: Returns the current cross sections dictionnary of the nuclide

property decay_a¶: Returns the absolute values of the decay constant of the nuclide

property decay_b¶: Returns the fraction percent values of the decay constant of the nuclide

property decay_child¶: Returns the daughter products of the nuclide via decay reactions

property decay_parent¶: Returns the parents of the nuclide via decay reactions

property dens_seq¶: Returns the macro sequence of densities of the nuclide in atom per \(cm^{3}\)

property dens_subseq_mat¶: Returns the list of micro sequences of densities (one per macro step)

property destruction_dic¶

Returns a dictionnary of all the destruction terms of the nuclide.

The keys are the reactions’ names The entries are the reaction rates of the reactions in \(barn^{-1}cm^{-1}s^{-1}\)

property fission_E¶: Returns the fission energy of the nuclide

property fission_child¶: Returns daughter products of the nuclide via fission reactions.

property fy¶

Returns the fission yields dictionnary.

Fission yield dictionnary are defined per fission product. Each key of the dictionnary is the zamid of one of the fission parents and the corresponding entry is the fission yield normalized to 1 (value between 0 and 1)

get_FAM()[source]¶: Returns the family of a nuclide (AVT= Activation, FP= Fission Product, ACT= Actinide)

property get_a¶: Returns the mass number of the nuclide

get_all_non0_child()[source]¶: Gets all daughter products of the nuclide produced via reactions that are non-zero (i.e., the reaction cross section or decay constant is not null) in the library used in the simulation

get_current_dens_subseq()[source]¶: Returns the current micro sequence of densities (i.e. micro sequence corresponding to the current macro step)

get_dens_subseq(s)[source]¶: Returns the micro sequence of densities number s (i.e. micro sequence corresponding to the macro step number s)

get_natural_abundance()[source]¶: Gets the natural abundance of the nuclide normalized to 1 (value between 0 and 1)

property get_z¶: Returns the atomic number of the nuclide

load_decay()[source]¶

Loads the decay constant value of the nuclide.

This method directly fetches the decay constant values (absolute and fractional) from the decay library and automatically sets it to the passport object

load_fy()[source]¶

Load the fission yields dictionnary of the nuclide

This method directly fetches the fission yields data from the fission yield library and automatically sets it to the passport object

If the nuclide for which the fission yields data are being loaded is not a fission product, the error onix.Not_a_Fission_Product will be raised

load_mass()[source]¶

Loads the atomic mass of the nuclide in gram.

This method directly fetches the atomic mass from the mass library and automatically sets it to the passport object

load_xs()[source]¶

Loads the cross sections data of the nuclide.

This method directly fetches the cross sections data from the cross section library and automatically sets it to the passport object

property mass¶: Returns the atomic mass of the nuclide in grams

property name¶: Returns the name of the nuclide

set_decay(decay_a, decay_b)[source]¶: Sets the absolute and fracional values of the decay constant of the nuclide

property sorted_allreacs_tuple_mat¶

Returns a list of tuples that contains destruction and production terms

For destruction terms, the first element is the reaction name and the second element is the reaction rate in \(barn^{-1}cm^{-1}s^{-1}\) For production terms, the first element is the parent nuclide witht the reaction name in parenthesis and the second element is the reactio rate in \(barn^{-1}cm^{-1}s^{-1}\) These tuples are ranked from lower reaction rate to higher reaction rate

property state¶: Return the excitation state of the nuclide (excited or ground state)

property xs_child¶: Returns the daughter products of the nuclide via neutron-induced rections

property xs_parent¶: Returns the parents of the nuclide via neutron-induced reactions

property xs_seq¶: Returns the sequence of cross section dictionnaries of the nuclide

property zamid¶: Returns the z-a-m-id of the nuclide