saltproc.abc module

class saltproc.abc.Depcode(codename, exec_path, template_input_file_path, geo_files=None, npop=50, active_cycles=20, inactive_cycles=20)

Bases: ABC

Abstract class for interfacing with monte-carlo particle transport codes. Contains information about input, output, geometry, and template files for running depletion simulations. Also contains neutron population, active, and inactive cycles. Contains methods to read template and output files, and write new input files for the depletion code.

param

Holds depletion step parameter information. Parameter names are keys and parameter values are values.

Type

dict of str to type

sim_info

Holds simulation settings information. Setting names are keys and setting values are values.

Type

dict of str to type

iter_inputfile

Path to depletion code input file for depletion code rerunning.

Type

str

iter_matfile

Path to iterative, rewritable material file for depletion code rerunning. This file is modified during the simulation.

Type

str

__init__(codename, exec_path, template_input_file_path, geo_files=None, npop=50, active_cycles=20, inactive_cycles=20)

Initializes the Depcode object.

Parameters

• codename (str) – Name of depletion code.

• exec_path (str) – Path to depletion code executable.

• template_input_file_path (str or dict of str to str) – Path(s) to depletion code input file(s), or a dictionary where the input type (e.g. material, geometry, settings, etc.) as a string are keys, and the path to the input file are values. Type depends on depletion code in use.

• geo_files (str or list, optional) – Path to file that contains the reactor geometry. List of str if reactivity control by switching geometry is On or just str otherwise.

• npop (int, optional) – Size of neutron population per cycle for Monte Carlo.

• active_cycles (int, optional) – Number of active cycles.

• inactive_cycles (int, optional) – Number of inactive cycles.

abstract read_dep_comp(read_at_end=False)

Reads the depleted material data from the depcode simulation and returns a dictionary with a Materialflow object for each burnable material.

Parameters

read_at_end (bool, optional) – Controls at which moment in the depletion step to read the data. If True, the function reads data at the end of the depletion step. Otherwise, the function reads data at the beginning of the depletion step.

Returns

mats – Dictionary that contains Materialflow objects.

key

Name of burnable material.

value

Materialflow object holding composition and properties.

Return type

dict of str to Materialflow

abstract read_depcode_info()

Parses initial depletion code info data from depletion code output and stores it in the Depcode object’s sim_info attribute.

abstract read_depcode_step_param()

Parses data from depletion code output for each step and stores it in Depcode object’s param attributes.

abstract run_depcode(cores, nodes)

Runs depletion code as a subprocess with the given parameters.

Parameters

• cores (int) – Number of cores to use for depletion code run.

• nodes (int) – Number of nodes to use for depletion code run.

abstract switch_to_next_geometry()

Changes the geometry used in the depletion code simulation to the next geometry file in geo_files

abstract write_depcode_input(reactor, dep_step, restart)

Writes prepared data into depletion code input file(s).

Parameters

• reactor (Reactor) – Contains information about power load curve and cumulative depletion time for the integration test.

• dep_step (int) – Current depletion time step.

• restart (bool) – Is the current simulation restarted?

abstract write_mat_file(dep_dict, dep_end_time)

Writes the iteration input file containing the burnable materials composition used in depletion runs and updated after each depletion step.

Parameters

• dep_dict (dict of str to Materialflow) –

  Dictionary that contains Materialflow objects.

  key

  Name of burnable material.

  value

  Materialflow object holding composition and properties.

• dep_end_time (float) – Current time at the end of the depletion step (d).