py_utils.input_data.InputData Class Reference

Collaboration diagram for py_utils.input_data.InputData:

Public Member Functions
	__init__ (self, excel_file=INPUT_FILE, I=None, V=None, solver_mode=None, physics_option=None, N=None, M=None)
	I (self)
	V (self)
	N (self)
	N (self, val)
	M (self)
	M (self, val)
	i_mobile (self)
	v_mobile (self)
	i_discrete (self)
	v_discrete (self)
	I_bin (self)
	V_bin (self)
	L_He_max (self)
	solver_mode (self)
	physics_option (self)
	equations (self)
	cascade (self)
	alpha_He (self)
	shape_function (self)
	display_parameters (self)

Public Attributes
	excel_file
	production_fission
	production_fusion
	energetics
	diffusion
	dissociation
	reactions
	derived
	physics_option

Protected Member Functions
	_load_data (self)
	_calculate_derived (self)
	_validate (self)

Static Protected Member Functions
	_sheet_to_dict (df)
	_production_to_dict (df)
	_apply_aliases (d)

Detailed Description

Material, irradiation, and model parameters for RadCluster_2_1.

Reads from the 5-sheet Excel workbook.  Call display_parameters() to
inspect all loaded values.

Parameters
----------
excel_file     : path-like, optional
I              : int, optional  — override max SIA cluster size
V              : int, optional  — override max vacancy cluster size
solver_mode    : str, optional  — override solver mode
physics_option : str, optional  — override physics option

Definition at line 134 of file input_data.py.

Constructor & Destructor Documentation

__init__()

py_utils.input_data.InputData.__init__	(		self,
			excel_file = INPUT_FILE,
			I = None,
			V = None,
			solver_mode = None,
			physics_option = None,
			N = None,
			M = None
	)

Definition at line 150 of file input_data.py.

Member Function Documentation

_apply_aliases()

py_utils.input_data.InputData._apply_aliases (   d )

staticprotected

Translate old key names to new convention (in-place).

Definition at line 225 of file input_data.py.

_calculate_derived()

py_utils.input_data.InputData._calculate_derived (   self )

protected

Compute all derived physics quantities.

Definition at line 274 of file input_data.py.

_load_data()

py_utils.input_data.InputData._load_data (   self )

protected

Read all five Excel worksheets.

Definition at line 231 of file input_data.py.

_production_to_dict()

py_utils.input_data.InputData._production_to_dict (   df )

staticprotected

Read Production sheet — returns fission and fusion sub-dicts.

Definition at line 208 of file input_data.py.

_sheet_to_dict()

py_utils.input_data.InputData._sheet_to_dict (   df )

staticprotected

Convert Symbol/Value sheet to dict.  Skips header rows (no symbol).

Definition at line 185 of file input_data.py.

_validate()

py_utils.input_data.InputData._validate (   self )

protected

Definition at line 470 of file input_data.py.

alpha_He()

py_utils.input_data.InputData.alpha_He

(

self

)

Definition at line 608 of file input_data.py.

cascade()

py_utils.input_data.InputData.cascade

(

self

)

Cascade type: 'fission' or 'fusion' (derived from physics_option).

Definition at line 603 of file input_data.py.

display_parameters()

py_utils.input_data.InputData.display_parameters

(

self

)

Definition at line 618 of file input_data.py.

equations()

py_utils.input_data.InputData.equations

(

self

)

Equation system: 'full_CD' or 'bin_moment' (derived from physics_option).

Definition at line 598 of file input_data.py.

I()

py_utils.input_data.InputData.I

(

self

)

Max SIA cluster size.

Definition at line 503 of file input_data.py.

I_bin()

py_utils.input_data.InputData.I_bin

(

self

)

Number of SIA bin-moment equations beyond i_discrete.
Defaults to ceil(log(I/i_discrete)/log(2)) if not specified.

Definition at line 556 of file input_data.py.

i_discrete()

py_utils.input_data.InputData.i_discrete

(

self

)

Max discrete SIA size (individually tracked). Defaults to i_mobile.

Definition at line 540 of file input_data.py.

i_mobile()

py_utils.input_data.InputData.i_mobile

(

self

)

Max mobile SIA cluster size.

Definition at line 530 of file input_data.py.

L_He_max()

py_utils.input_data.InputData.L_He_max

(

self

)

Definition at line 582 of file input_data.py.

M() [1/2]

py_utils.input_data.InputData.M

(

self

)

Definition at line 522 of file input_data.py.

M() [2/2]

py_utils.input_data.InputData.M	(		self,
			val
	)

Definition at line 526 of file input_data.py.

N() [1/2]

py_utils.input_data.InputData.N

(

self

)

Definition at line 514 of file input_data.py.

N() [2/2]

py_utils.input_data.InputData.N	(		self,
			val
	)

Definition at line 518 of file input_data.py.

physics_option()

py_utils.input_data.InputData.physics_option

(

self

)

Definition at line 594 of file input_data.py.

shape_function()

py_utils.input_data.InputData.shape_function

(

self

)

Intra-bin shape function: 'constant', 'linear', or 'lognormal'.

Definition at line 612 of file input_data.py.

solver_mode()

py_utils.input_data.InputData.solver_mode

(

self

)

Definition at line 589 of file input_data.py.

V()

py_utils.input_data.InputData.V

(

self

)

Max vacancy cluster size.

Definition at line 508 of file input_data.py.

V_bin()

py_utils.input_data.InputData.V_bin

(

self

)

Number of VAC bin-moment equations beyond v_discrete.
Defaults to ceil(log(V/v_discrete)/log(2)) if not specified.

Definition at line 569 of file input_data.py.

v_discrete()

py_utils.input_data.InputData.v_discrete

(

self

)

Max discrete vacancy size (individually tracked). Defaults to v_mobile.

Definition at line 548 of file input_data.py.

v_mobile()

py_utils.input_data.InputData.v_mobile

(

self

)

Max mobile vacancy cluster size.

Definition at line 535 of file input_data.py.

Member Data Documentation

derived

py_utils.input_data.InputData.derived

Definition at line 418 of file input_data.py.

diffusion

py_utils.input_data.InputData.diffusion

Definition at line 246 of file input_data.py.

dissociation

py_utils.input_data.InputData.dissociation

Definition at line 247 of file input_data.py.

energetics

py_utils.input_data.InputData.energetics

Definition at line 245 of file input_data.py.

excel_file

py_utils.input_data.InputData.excel_file

Definition at line 160 of file input_data.py.

physics_option

py_utils.input_data.InputData.physics_option

Definition at line 600 of file input_data.py.

production_fission

py_utils.input_data.InputData.production_fission

Definition at line 242 of file input_data.py.

production_fusion

py_utils.input_data.InputData.production_fusion

Definition at line 242 of file input_data.py.

reactions

py_utils.input_data.InputData.reactions

Definition at line 248 of file input_data.py.

---

The documentation for this class was generated from the following file:

• radcluster_code/py_utils/input_data.py