py_utils.input_data Namespace Reference

Classes
class	_D1DFunction
class	InputData

Functions
	make_physics_option (equations, cascade)
	split_physics_option (po)

Variables
float	_kB = 8.617333262e-5
	BASE_DIR = Path(__file__).parent.parent
str	INPUT_FILE = BASE_DIR / 'input' / 'input_parameters.xlsx'
tuple	_SOLVER_MODES = ('full_system', 'active_window')
dict	_SOLVER_MODE_ALIASES
tuple	_PHYSICS_OPTIONS
tuple	_EQUATIONS = ('discrete', 'bin_moment')
tuple	_CASCADES = ('fission', 'fusion')
dict	_EQUATIONS_ALIASES
tuple	_SHAPE_FUNCTIONS = ('constant', 'linear', 'lognormal')
dict	_KEY_ALIASES

Detailed Description

input_data.py — InputData class for RadCluster_2_1.

Reads material, irradiation, and model parameters from a 5-sheet Excel
workbook (radcluster_code/input/input_parameters.xlsx) and computes
all derived quantities needed by the ODE system.

Sheet layout
------------
Production    — cascade production parameters (fission vs. fusion)
Energetics    — lattice constants, migration/formation energies, He EOS
Diffusion     — diffusion pre-factors, EUROFER solute trapping
Dissociation  — binding energy parameters, trap mutation barriers
Reactions     — rate constant prefactors, sink parameters, solver settings

Physics reference
-----------------
Ghoniem, N.M. (2026), "A Cluster Dynamics Model for Radiation Damage
Evolution in Ferritic-Martensitic Steels" (Rate_Equations.pdf).

Naming convention
-----------------
I           — max SIA cluster size
V           — max vacancy cluster size
i_mobile    — max mobile SIA cluster size
v_mobile    — max mobile vacancy cluster size
i_discrete  — max discrete SIA size (individually tracked; default = i_mobile)
v_discrete  — max discrete vacancy size (individually tracked; default = v_mobile)
I_bin       — number of SIA bin-moment equations beyond i_discrete
V_bin       — number of VAC bin-moment equations beyond v_discrete
i_cascade   — max SIA cluster size from cascade
v_cascade   — max vacancy cluster size from cascade

All units: SI (lengths in m, concentrations dimensionless as atom fractions,
energies in eV, time in s).

Function Documentation

make_physics_option()

py_utils.input_data.make_physics_option	(		equations,
			cascade
	)

Combine an (equations, cascade) pair into the canonical physics_option string.

equations : 'discrete' | 'bin_moment'   (legacy 'full_CD' also accepted)
cascade   : 'fission'  | 'fusion'

Definition at line 92 of file input_data.py.

split_physics_option()

py_utils.input_data.split_physics_option

(

po

)

Reverse of make_physics_option: return (equations, cascade).

The 'full_CD_*' physics_option prefix maps back to the user-facing
equations name 'discrete'.

Definition at line 108 of file input_data.py.

Variable Documentation

_CASCADES

tuple py_utils.input_data._CASCADES = ('fission', 'fusion')

protected

Definition at line 82 of file input_data.py.

_EQUATIONS

tuple py_utils.input_data._EQUATIONS = ('discrete', 'bin_moment')

protected

Definition at line 81 of file input_data.py.

_EQUATIONS_ALIASES

dict py_utils.input_data._EQUATIONS_ALIASES

protected

Initial value:

=  {
    'full_CD': 'discrete',
}

Definition at line 87 of file input_data.py.

_kB

float py_utils.input_data._kB = 8.617333262e-5

protected

Definition at line 43 of file input_data.py.

_KEY_ALIASES

dict py_utils.input_data._KEY_ALIASES

protected

Initial value:

=  {
    'N':       'I',
    'M':       'V',
    'n_max_i': 'i_mobile',
    'm_max_v': 'v_mobile',
    'm1':      'i_cascade',
    'n1':      'v_cascade',
}

Definition at line 124 of file input_data.py.

_PHYSICS_OPTIONS

tuple py_utils.input_data._PHYSICS_OPTIONS

protected

Initial value:

=  ('full_CD_fission', 'full_CD_fusion',
                    'bin_moment_CD_fission', 'bin_moment_CD_fusion')

Definition at line 77 of file input_data.py.

_SHAPE_FUNCTIONS

tuple py_utils.input_data._SHAPE_FUNCTIONS = ('constant', 'linear', 'lognormal')

protected

Definition at line 119 of file input_data.py.

_SOLVER_MODE_ALIASES

dict py_utils.input_data._SOLVER_MODE_ALIASES

protected

Initial value:

=  {
    'cpp_full':       'full_system',
    'sliding_OpenMP': 'active_window',
}

Definition at line 73 of file input_data.py.

_SOLVER_MODES

tuple py_utils.input_data._SOLVER_MODES = ('full_system', 'active_window')

protected

Definition at line 67 of file input_data.py.

BASE_DIR

py_utils.input_data.BASE_DIR = Path(__file__).parent.parent

Definition at line 63 of file input_data.py.

INPUT_FILE

str py_utils.input_data.INPUT_FILE = BASE_DIR / 'input' / 'input_parameters.xlsx'

Definition at line 64 of file input_data.py.