f4enix.core.irradiation.Nuclide#

class f4enix.core.irradiation.Nuclide(zaid: int | str | None = None, element: str | None = None, isotope: int | str | None = None, metastable: bool = False, IRS_active: bool = False, lib: str | None = None)#

Bases: object

A general nuclide. Supports metastable, libraries and IRS flags. As a minimum, either the zaid number or element and isotope must be provided.

Parameters:

  • zaid (int | str | None) – ZAID number of the nuclide (e.g. 3003 for Li-3).

  • element (str | None, optional) – Element symbol of the nuclide (e.g. “Li” for Lithium), by default None

  • isotope (int | str | None, optional) – Isotope number of the nuclide (e.g. 3 for Li-3), by default None

  • metastable (bool, optional) – true if the nuclide is metastable, by default False

  • IRS_active (bool, optional) – true if the IRS flag is active, by default False

  • lib (str | None, optional) – library identifier, by default None

Methods

__init__([zaid, element, isotope, ...])

A general nuclide.

from_formula(zaid_str)

Create a Nuclide object starting from a formula that looks like "Li3".

from_int_string(zaid_int_string)

Create a nuclide object starting from an integer string that looks like "3003".

write_to_formula()

Return the formula string representation of the nuclide.

write_to_int_string()

Return the integer string representation of the nuclide.

Attributes

element

isotope

zaid

classmethod from_formula(zaid_str: str) → Nuclide#

Create a Nuclide object starting from a formula that looks like “Li3”. Metastables are supported with an ‘m’ and IRS flags with the ‘irs’ tag at the beginning of the string. MCNP libraries are also supported using ‘.XXc’. A complete example looks like “irsLi3m.99c”.

Parameters:

zaid_str (str) – string describing the nuclide as documented.

Returns:

the created Nuclide object.

Return type:

Nuclide

classmethod from_int_string(zaid_int_string: str) → Nuclide#

Create a nuclide object starting from an integer string that looks like “3003”. Metastables are supported with a ‘900’ suffix and IRS flags with a ‘999’ prefix. MCNP libraries are also supported using ‘.XXc’. A complete example looks like “9993003900.99c”.

Parameters:

zaid_int_string (str) – string describing the nuclide as documented.

Returns:

the created Nuclide object.

Return type:

Nuclide

write_to_formula() → str#

Return the formula string representation of the nuclide. E.g. “irsLi3m.99c”.

write_to_int_string() → str#

Return the integer string representation of the nuclide. E.g. “9993003900.99c”.