irradiapy.enums module

Module containing enumerations used globally.

class irradiapy.enums.CustomEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Base class for custom enumerations.

classmethod from_int(value)

Get the enum member from its integer value.

Parameters:

value (int) – The integer value of the enum member.

Returns:

The corresponding enum member.

Return type:

CustomEnum

Raises:

ValueError – If the integer value does not correspond to any enum member.

to_int()

Get the integer value of the enum member.

Returns:

The integer value of the enum member.

Return type:

int

class irradiapy.enums.DamageEnergyMode(*values)

Bases: CustomEnum

Enumeration of damage energy calculation modes.

LINDHARD = 1

SRIM = 2

class irradiapy.enums.DisplacementMode(*values)

Bases: CustomEnum

Enumeration of displaced atoms calculation modes.

References

NRT : https://doi.org/10.1016/0029-5493(75)90035-7 ARC : https://doi.org/10.1038/s41467-018-03415-5 FERARC : https://doi.org/10.1103/PhysRevMaterials.5.073602

ARC = 2

FERARC = 3

NRT = 1

class irradiapy.enums.Phases(*values)

Bases: CustomEnum

Enumeration of material phases.

GAS = 2

LIQUID = 3

SOLID = 1