Models

Core data types for beam, target, and result specifications.

models

Data models for HYRR.

Beam, Element, Layer, TargetStack, DepthPoint, and result types.

ProjectileType module-attribute

ProjectileType = Literal['p', 'd', 't', 'h', 'a']

PROJECTILE_A module-attribute

PROJECTILE_A: dict[str, int] = {'p': 1, 'd': 2, 't': 3, 'h': 3, 'a': 4}

PROJECTILE_Z module-attribute

PROJECTILE_Z: dict[str, int] = {'p': 1, 'd': 1, 't': 1, 'h': 2, 'a': 2}

Beam dataclass

Incident beam specification.

projectile_obj property

projectile_obj: Projectile

Resolved projectile definition.

particles_per_second property

particles_per_second: float

Number of incident particles per second.

direction_array property

direction_array: NDArray[float64]

Direction as a normalized numpy array. Defaults to (0, 0, 1).

position_array property

position_array: NDArray[float64]

Position as numpy array. Defaults to origin.

Element dataclass

Element with isotopic composition.

Layer dataclass

Single target layer specification.

Exactly one of thickness_cm, areal_density_g_cm2, or energy_out_MeV must be set.

average_atomic_mass property

average_atomic_mass: float

Weighted average atomic mass [u].

TargetStack dataclass

Ordered stack of target layers traversed by the beam.

DepthPoint dataclass

Single point in a depth profile.

IsotopeResult dataclass

Production result for a single isotope.

LayerResult dataclass

Full result for a single layer.

StackResult dataclass

Full result for all layers in a stack.