Dict of obsolete vars and their new names for the input validator, and dict of help messages for certain obsolete vars.
This is used by the input_validator module to find any obsolete variables in the
input file (which have since been renamed in the current version of the source).
If the input validator finds an obsolete var, it can then suggest the new name
of that variable, based on this dictionary. This should make migration of old
input files easier, and variable renaming less painful.
Each key is an obsolete var, the value is either the new var name or None if the
var is deprecated.
Note: this is now relied upon by Blueprint, pending implementing a proper API.
OBS_VARS = {'snull': 'i_single_null', 'tfno': 'n_tf_coils', 'itfsup': 'i_tf_sup', 'r_tf_inleg_mid': 'r_tf_inboard_mid', 'rtot': 'r_tf_outboard_mid', 'a_tf_inboard': 'a_tf_inboard_total', 'tfareain': 'a_tf_inboard_total', 'r_tf_inleg_in': 'r_tf_inleg_in', 'r_tf_inleg_out': 'r_tf_inleg_out', 'a_tf_wp': 'a_tf_wp_with_insulation', 'sigttf': 'sig_tf_t', 'sigtcon': 'sig_tf_t', 'sigrtf': 'sig_tf_r', 'sigrcon': 'sig_tf_r', 'sigvert': 'sig_tf_z', 'sig_vmises_case': 'sig_tf_vmises', 'sig_vmises_cond': 'sig_tf_vmises', 'sig_tresca_case': 's_shear_tf', 'sig_tresca_cond': 's_shear_tf', 'sigver': None, 'sigrad': None, 'poisson': 'poisson_steel', 'eywp': 'eyoung_winding', 'eyins': 'eyoung_ins', 'eystl': 'eyoung_steel', 'isumattf': 'i_tf_sc_mat', 'turnstf': 'n_tf_coil_turns', 'a_tf_wp_no_insulation': 'a_tf_wp', 'dr_tf_case_in': 'dr_tf_nose_case', 'f_tf_case_out': 'f_dr_tf_plasma_case', 'dr_tf_case_out': 'dr_tf_plasma_case', 'eyoung_reinforced_al': 'eyoung_nibron', 'thkwp': 'dr_tf_wp_with_insulation', 'leni': 'dx_tf_turn_cable_space_average', 'leno': 't_turn', 'conductor_width': 't_conductor', 'deltf': 'dr_tf_shld_gap', 'ddwi': 'dr_vv_outboard', 'pnuccp': 'pnuc_cp', 'nuc_pow_dep_tot': 'pnuc_tot_blk_sector', 't_turn': 'dx_tf_turn_general', 'ratecdol': 'discount_rate', 'strtf1': 'sig_tf_case', 'strtf2': 'sig_tf_wp', 'alstrtf': ['sig_tf_case_max', 'sig_tf_wp_max'], 'strtf0': 'sig_tf_cs_bucked', 'eyoung_winding': ['eyoung_cond_axial', 'eyoung_cond_trans'], 'i_tf_plane_stress': 'i_tf_stress_model', 'windstrain': 'strncon_tf', 'eyzwp': 'eyoung_wp_z_eff', 'strncon_cs': 'str_cs_con_res', 'strncon_pf': 'str_pf_con_res', 'strncon_tf': 'str_tf_con_res', 'i_strain_wp': 'i_str_wp', 'strain_wp_max': 'str_wp_max', 'strain_wp': 'str_wp', 'rad_fraction': 'rad_fraction_total', 'pcoreradmw': 'p_plasma_inner_rad_mw', 'pedgeradmw': 'p_plasma_outer_rad_mw', 'rad_fraction_core': '', 'thshield': ['dr_shld_thermal_inboard', 'dr_shld_thermal_outboard', 'dz_shld_thermal'], 'igeom': None, 'fgamp': None, 'divleg_profile_inner': None, 'divleg_profile_outer': None, 'iprimnloss': None, 'rho_ecrh': None, 'ifispact': None, 'fmsbc': None, 'fmsbl': None, 'fmsdwe': None, 'fmsdwi': None, 'fmsfw': None, 'fmsoh': None, 'fmssh': None, 'fmstf': None, 'quench_detection_ef': None, 'farc4tf': None, 'impvar': None, 'fimpvar': None, 'sigvvall': 'max_vv_stress', 'fradmin': None, 'ftr': 'f_plasma_fuel_tritium', 'iculdl': 'idensl', 'iiter': None, 'ires': None, 'fjtfc': None, 'bcylth': None, 'itfmod': None, 'jcrit_model': None, 'f_j_cs_start_end_flat_top': None, 'fvolbi': 'fhole', 'fvolbo': 'fhole', 'fvolcry': None, 'idhe3': 'f_plasma_fuel_helium3', 'blnktth': None, 'dz_blkt_upper': None, 'theat': 't_plant_pulse_fusion_ramp', 'ieped': None, 'eped_sf': None, 'icurr': 'i_plasma_current', 'idia': 'i_diamagnetic_current', 'ibss': 'i_bootstrap_current', 'ips': 'i_pfirsch_schluter_current', 'bootipf': 'f_c_plasma_bootstrap', 'bscfmax': 'f_c_plasma_bootstrap_max', 'vgap2': 'dz_shld_vv_gap', 'vgap': 'dz_xpoint_divertor', 'ftritbm': 'f_tritium_bream', 'enbeam': 'e_beam_kev', 'fdeut': 'f_plasma_fuel_deuterium', 'ftrit': 'f_plasma_fuel_tritium', 'fhe3': 'f_plasma_fuel_helium3', 'falpha': 'f_p_alpha_plasma_deposited', 'idensl': 'i_density_limit', 'tbrnmn': 't_burn_min', 'tohs': 't_plant_pulse_plasma_current_ramp_up', 'tdwell': 't_plant_pulse_dwell', 'tramp': 't_plant_pulse_coil_precharge', 'tqnch': 't_plant_pulse_plasma_current_ramp_down', 'tburn': 't_plant_pulse_burn', 'pdivmax/rmajor': 'pdivmax_over_rmajor', 'pdivtbt/qar': 'pdivtbt_over_qar', 'betpmx': 'beta_poloidal_max', 'iculbl': 'i_beta_component', 'epbetmax': 'beta_poloidal_eps_max', 'dnbeta': 'beta_norm_max', 'ifalphap': 'i_beta_fast_alpha', 'betalim': 'beta_vol_avg_max', 'betalim_lower': 'beta_vol_avg_min', 'cvol': 'f_vol_plasma', 'cwrmax': 'f_r_conducting_wall', 'ishape': 'i_plasma_geometry', 'iscrp': 'i_plasma_wall_gap', 'peakfactrad': 'f_fw_rad_max', 'nimp': 'n_impurities', 'ssync': 'f_sync_reflect', 'rnbeam': 'f_nd_beam_electron', 'ralpne': 'f_nd_alpha_electron', 'protium': 'f_nd_protium_electrons', 'clhsf': 'f_z_cryostat', 'ddwex': 'dr_cryostat', 'clh1': 'dz_tf_cryostat', 'rpf2dewar': 'dr_pf_cryostat', 'shldoth': 'dr_shld_outboard', 'fwoth': 'dr_fw_outboard', 'vvblgap': 'dr_shld_blkt_gap', 'thshield_ib': 'dr_shld_thermal_inboard', 'thshield_ob': 'dr_shld_thermal_outboard', 'iprecomp': 'i_cs_precomp', 'tfcth': 'dr_tf_inboard', 'tftsgap': 'dr_tf_shld_gap', 'bore': 'dr_bore', 'scrapli': 'dr_fw_plasma_gap_inboard', 'blnkoth': 'dr_blkt_outboard', 'blnkith': 'dr_blkt_inboard', 'ohcth': 'dr_cs', 'gapoh': 'dr_cs_tf_gap', 'scraplo': 'dr_fw_plasma_gap_outboard', 'gapds': 'dr_shld_vv_gap_inboard', 'fwith': 'dr_fw_inboard', 'shldith': 'dr_shld_inboard', 'd_vv_in': 'dr_vv_inboard', 'd_vv_out': 'dr_vv_outboard', 'iblnkith': 'i_blkt_inboard', 'taulimit': 'f_alpha_energy_confinement_min', 'isc': 'i_confinement_time', 'iradloss': 'i_rad_loss', 'iinvqd': None, 'rhotfleg': 'rho_tf_leg', 'n_tf': 'n_tf_coils', 'tcpav': 'temp_cp_average', 'jbus': 'j_tf_bus', 'fcoolleg': 'f_a_tf_cooil_outboard', 'rhotfbus': 'rho_tf_bus', 'ilhthresh': 'i_l_h_threshold', 'rli': 'ind_plasma_internal_norm', 'gamma': 'ejima_coeff', 'lpulse': 'i_pulsed_plant', 'q': 'q95', 'fwcoolant': 'i_fw_coolant_type', 'pitch': 'dx_fw_module', 'iblanket': 'i_blanket_type', 'fw_wall': 'dr_fw_wall', 'fwpressure': 'pres_fw_coolant', 'fwoutlet': 'temp_fw_coolant_out', 'afw': 'radius_fw_channel', 'peaking_factor': 'f_fw_peak', 'fwinlet': 'temp_fw_coolant_in', 'tfwmatmax': 'temp_fw_max', 'fw_channel_length': 'len_fw_channel', 'denw': None, 's_tresca_oh': 's_shear_cs_peak', 'sig_tf_tresca_max': 's_shear_tf_peak', 's_tresca_cond_cear': 's_shear_cea_tf_cond', 'sig_tf_tresca': 's_shear_tf', 'rjconpf': 'j_pf_coil_wp_peak', 'oh_steel_frac': 'f_a_cs_turn_steel', 'vf': 'f_a_pf_coil_void', 'coheof': 'j_cs_flat_top_end', 'ipfres': 'i_pf_conductor', 'fcohbop': 'f_j_cs_start_pulse_end_flat_top', 'ohhghf': 'f_z_cs_tf_internal', 'vfohc': 'f_a_cs_void', 'isumatoh': 'i_cs_superconductor', 'ngrpmx': 'n_pf+groups_max', 'ngrp': 'n_pf_coil_groups', 'isumatpf': 'i_pf_superconductor', 'pfclres': 'rho_pf_coil', 'bmaxcs_lim': 'b_cs_limit_max', 'ncls': 'n_pf_coils_in_group', 'cptdin': 'c_pf_coil_turn_peak_input', 'ipfloc': 'i_pf_location', 'tf_in_cs': 'i_tf_inside_cs', 'shldtth': 'dz_shld_upper', 'shldlth': 'dz_shld_lower', 'vgap_vv_thermalshield': 'dz_shld_vv_gap', 'thshield_vb': 'dz_shld_thermal', 'vgaptop': 'dz_fw_plasma_gap', 'vgap_xpoint_divertor': 'dz_xpoint_divertor', 'd_vv_top': 'dz_vv_upper', 'd_vv_bot': 'dz_vv_lower', 'divfix': 'dz_divertor', 'coreradius': 'radius_plasma_core_norm', 'maxradwallload': 'pflux_fw_rad_max', 'fdiv': 'f_ster_div_single', 'fhcd': 'f_a_fw_outboard_hcd', 'nblktmodti': 'n_blkt_inboard_modules_toroidal', 'nblktmodpo': 'n_blkt_outboard_modules_poloidal', 'nblktmodpi': 'n_blkt_inboard_modules_poloidal', 'inlet_temp': 'temp_blkt_coolant_in', 'outlet_temp': 'temp_blkt_coolant_out', 'blpressure': 'pres_blkt_coolant', 'primary_pumping': 'i_p_coolant_pumping', 'secondary_cycle': 'i_thermal_electric_conversion', 'fwbsshape': 'i_fw_blkt_vv_shape', 'li6enrich': 'f_blkt_li6_enrichment', 'nblktmodto': 'n_blkt_outboard_modules_toroidal', 'i_bb_liq': 'i_blkt_liquid_breeder_type', 'icooldual': 'i_blkt_dual_coolant', 'ifci': 'i_blkt_liquid_breeder_channel_type', 'ipump': 'i_fw_blkt_shared_coolant', 'coolwh': 'i_blkt_coolant_type', 'iblanket_thickness': None, 'bpsout': None, 'c1div': None, 'c2div': None, 'c3div': None, 'c4div': None, 'c5div': None, 'c6div': None, 'delld': None, 'fdfs': None, 'fdivcol': None, 'fififi': None, 'frrp': None, 'ksic': None, 'omegan': None, 'rlenmax': None, 'xparain': None, 'zeffdiv': None, 'divdum': None, 'casths': 'dx_tf_side_case_min', 'thkcas': 'dr_tf_nose_case', 'tmpcry': 'temp_tf_cryo', 'beam_energy': 'e_beam_kev', 'bootstrap_current_fraction_max': 'f_c_plasma_bootstrap_max', 'etaech': 'eta_ecrh_injector_wall_plug', 'etalh': 'eta_lowhyb_injector_wall_plug', 'etanbi': 'eta_beam_injector_wall_plug', 'f_tritium_beam': 'f_beam_tritium', 'forbitloss': 'f_p_beam_orbit_loss', 'gamma_ecrh': 'eta_cd_norm_ecrh', 'harnum': 'n_ecrh_harmonic', 'nbshield': 'dx_beam_shield', 'nbshinefmax': 'f_p_beam_shine_through_max', 'pheat': 'p_hcd_primary_extra_heat_mw', 'pinjalw': 'p_hcd_injected_max', 'pinjfixmw': 'p_hcd_secondary_injected_mw', 'iefrf': 'i_hcd_primary', 'iefrffix': 'i_hcd_secondary', 'irfcd': 'i_hcd_calculations', 'wave_mode': 'i_ecrh_wave_mode', 'pheatfix': 'p_hcd_secondary_extra_heat_mw', 'ftar': 'f_p_div_lower', 'beta_div': 'deg_div_field_plate', 'divclfr': 'f_vol_div_coolant', 'divdens': 'den_div_structure', 'divplt': 'dx_div_plate', 'flux_exp': 'f_div_flux_expansion', 'hldiv': 'pflux_div_heat_load_mw', 'hldivlim': 'pflux_div_heat_load_max_mw', 'pdivtlim': 'p_plasma_separatrix_min_mw', 'i_hldiv': 'i_div_heat_load', 'ignite': 'i_plasma_ignited', 'iprofile': None, 'powfmax': 'p_fusion_total_max_mw', 'roughness': 'roughness_fw_channel', 'casthi_is_fraction': 'i_f_dr_tf_plasma_case', 'casthi_fraction': 'f_dr_tf_plasma_case', 'casthi': 'dr_tf_plasma_case', 'htpmw_blkt': 'p_blkt_coolant_pump_mw', 'htpmw_div': 'p_div_coolant_pump_mw', 'htpmw_fw': 'p_fw_coolant_pump_mw', 'htpmw_shld': 'p_shld_coolant_pump_mw', 'htpmw_min': None, 'baseel': 'p_plant_electric_base', 'crypmw_max': 'p_cryo_plant_electric_max_mw', 'etath': 'eta_turbine', 'trithtmw': 'p_tritium_plant_electric_mw', 'iprimshld': 'i_shld_primary_heat', 'cpttf': 'c_tf_turn', 'emult': 'f_p_blkt_multiplication', 'auxmin': 'p_hcd_injected_min_mw', 'etahtp': 'eta_coolant_pump_electric', 'pwpm2': 'pflux_plant_floor_electric', 'iscenr': 'i_pf_energy_storage_source', 'dhecoil': 'dia_tf_turn_coolant_channel', 'n_tf_turn': 'n_tf_coil_turns', 'thicndut': 'dx_tf_turn_insulation', 'thwcndut': 'dx_tf_turn_steel', 'dr_tf_wp': 'dr_tf_wp_with_insulation', 'tfinsgap': 'dx_tf_wp_insertion_gap', 'tinstf': 'dx_tf_wp_insulation', 'vftf': 'f_a_tf_turn_cable_space_extra_void', 'beamwd': 'dx_beam_duct', 'frbeam': 'f_radius_beam_tangency_rmajor', 'pinjmax': None, 'f_alpha_plasma': 'f_p_alpha_plasma_deposited', 'bmxlim': 'b_tf_inboard_max', 'cpttf_max': 'c_tf_turn_max', 'gammax': 'eta_cd_norm_hcd_primary_max', 'pnetelin': 'p_plant_electric_net_required_mw', 'tbeamin': 'n_beam_decay_lengths_core_required', 'tcycmn': 't_cycle_min', 'walalw': 'pflux_fw_neutron_max_mw', 'dx_tf_side_case': 'dx_tf_side_case_min', 'bigqmin': 'big_q_plasma_min', 'fpsep': None, 'ptempalw': 'temp_cp_max', 'tmax_croco': 'temp_croco_quench_max', 'vdalw': 'v_tf_coil_dump_quench_max_kv', 'vvhealw': None, 'zeffmax': 'zeff_max', 'f_a_fw_hcd': 'f_a_fw_outboard_hcd', 'fpumpblkt': 'f_p_blkt_coolant_pump_total_heat', 'fpumpshld': 'f_p_shld_coolant_pump_total_heat', 'fpumpfw': 'f_p_fw_coolant_pump_total_heat', 'fpumpdiv': 'f_p_div_coolant_pump_total_heat', 'ims': 'i_blkt_module_segmentation', 'i_coolant_pumping': 'i_p_coolant_pumping', 'vfblkt': 'f_a_blkt_cooling_channels', 'dalu': 'den_aluminium', 'dcase': 'den_tf_coil_case', 'dcondins': 'den_tf_wp_turn_insulation', 'dcopper': 'den_copper', 'denstl': 'den_steel', 'ripmax': 'ripple_b_tf_plasma_edge_max', 'n_layer': 'n_tf_wp_layers', 'n_pancake': 'n_tf_wp_pancakes', 'fimp': 'f_nd_impurity_electrons', 'initialpressure': 'pres_vv_chamber_dwell_start', 'pbase': 'pres_vv_chamber_base', 'prdiv': 'pres_div_chamber_burn', 'pumpareafraction': 'f_a_vac_pump_port_plasma_surface', 'pumpspeedfactor': 'f_volflow_vac_pumps_impedance', 'pumpspeedmax': 'volflow_vac_pumps_max', 'pumptp': 'molflow_vac_pumps', 'rat': 'outgrat_fw', 'tn': 'temp_vv_chamber_gas_burn_end', 'dwell_pump': 'i_vac_pump_dwell', 'ntype': 'i_vacuum_pump_type', 'vacuum_model': 'i_vacuum_pumping', 'fcutfsu': 'f_a_tf_turn_cable_copper', 'tdmptf': 't_tf_superconductor_quench', 'tmaxpro': 'temp_tf_conductor_quench_max', 'coreradiationfraction': 'f_p_plasma_core_rad_reduction', 'routr': 'dr_pf_tf_outboard_out_offset', 'rpf1': 'dr_pf_cs_middle_offset', 'i_sup_pf_shape': 'i_r_pf_outside_tf_placement', 'nfxfh': 'n_cs_current_filaments', 'bt': 'b_plasma_toroidal_on_axis', 'dene': 'nd_plasma_electrons_vol_avg', 'fgwped': 'f_nd_plasma_pedestal_greenwald', 'fgwsep': 'f_nd_plasma_separatrix_greenwald', 'neped': 'nd_plasma_pedestal_electron', 'nesep': 'nd_plasma_separatrix_electron', 'rhopedn': 'radius_plasma_pedestal_density_norm', 'rhopedt': 'radius_plasma_pedestal_temp_norm', 'taumax': 't_plasma_energy_confinement_max', 'te': 'temp_plasma_electron_vol_avg_kev', 'teped': 'temp_plasma_pedestal_kev', 'tesep': 'temp_plasma_separatrix_kev', 'ti': 'temp_plasma_ion_vol_avg_kev', 'tratio': 'f_temp_plasma_ion_electron', 'ipedestal': 'i_plasma_pedestal', 'iwalld': 'i_pflux_fw_neutron', 'ld_ratio_cst': 'f_dr_dz_cs_turn', 'f_a_cs_steel': 'f_a_cs_turn_steel', 't_structural_radial': 'dr_cs_turn_conduit', 't_structural_vertical': 'dz_cs_turn_conduit', 't_cable_tf': 'dx_tf_turn_cable_space_general', 't_turn_tf': 'dx_tf_turn_general', 'copper_thick': 'dx_hts_tape_copper', 'croco_thick': 'dx_croco_strand_copper', 'hastelloy_thickness': 'dx_hts_tape_hastelloy', 'rebco_thickness': 'dx_hts_tape_rebco', 'tape_thickness': 'dx_hts_tape_total', 'tape_width': 'dr_hts_tape', 'beta': 'beta_total_vol_avg', 'beta_max': 'beta_vol_avg_max', 'beta_min': 'beta_vol_avg_min', 'f_deuterium': 'f_plasma_fuel_deuterium', 'f_tritium': 'f_plasma_fuel_tritium', 'f_helium3': 'f_plasma_fuel_helium3', 't_fusion_ramp': 't_plant_pulse_fusion_ramp', 't_current_ramp_up': 't_plant_pulse_plasma_current_ramp_up', 't_ramp_down': 't_plant_pulse_plasma_current_ramp_down', 't_between_pulse': 't_plant_pulse_dwell', 't_precharge': 't_plant_pulse_coil_precharge', 't_burn': 't_plant_pulse_burn', 'tfootfi': 'f_dr_tf_outboard_inboard', 'cfactr': 'f_t_plant_available', 'tbktrepl': 't_blkt_replace_yrs', 'tdivrepl': 't_div_replace_yrs', 'tlife': 'life_plant', 'iavail': 'i_plant_availability', 'tcoolin': 'temp_cp_coolant_inlet', 'vcool': 'vel_cp_coolant_midplane', 'rcool': 'radius_cp_coolant_channel', 'fl_h_threshold': None}
module-attribute
OBS_VARS_HELP = {'iculdl': '(use IDENSL=3 for equivalent model to ICULDL=0). ', 'dz_blkt_upper': 'WARNING. BLNKTTH is now always calculated rather than input - please remove it from the input file. ', 'iprofile': 'Use i_beta_norm_max, i_alphaj and i_ind_plasma_internal_norm instead. See docs for setup. ', 'fl_h_threshold': 'fl_h_threshold has been replaced by f_h_mode_margin/f_l_mode_margin please check the docstring for constraint 15/22 to find the appropriate variable'}
module-attribute
kallenbach_list = ['target_spread', 'lambda_q_omp', 'lcon_factor', 'netau_sol', 'kallenbach_switch', 'kallenbach_tests', 'kallenbach_test_option', 'kallenbach_scan_switch', 'kallenbach_scan_var', 'kallenbach_scan_start', 'kallenbach_scan_end', 'kallenbach_scan_num', 'targetangle', 'ttarget', 'qtargettotal', 'impurity_enrichment', 'fractionwidesol', 'abserr_sol', 'relerr_sol', 'mach0', 'neratio']
module-attribute
kallenbach_message = 'The Kallenbach model is currently not included in PROCESS. See issue #1886 for more information on the use of the Kallenbach model. '
module-attribute
fvalues_list = ['fp_hcd_injected_min_mw', 'fbeta_poloidal_eps', 'fbeta_poloidal', 'fbeta_max', 'fbeta_min', 'fc_tf_turn_max', 'fr_conducting_wall', 'fdtmp', 'fecrh_ignition', 'fflutf', 'fp_fusion_total_max_mw', 'feta_cd_norm_hcd_primary_max', 'fpflux_div_heat_load_mw', 'fipir', 'fjprot', 'fmva', 'fnbshinef', 'fncycle', 'fnesep', 'foh_stress', 'fb_tf_inboard_max', 'fp_hcd_injected_max', 'fp_plant_electric_net_required_mw', 'fradius_beam_tangency', 'fpsepbqar', 'fpsepr', 'fptemp', 'fptfnuc', 'fq95_min', 'fbig_q_plasma_min', 'fpflux_fw_rad_max', 'freinke', 'frminor', 'fstrcase', 'fstrcond', 'fstr_wp', 'fmaxvvstress', 'ftbr', 'ft_burn_min', 'ft_cycle_min', 'ftmargoh', 'ftmargtf', 'ft_current_ramp_up', 'ftemp_fw_max', 'fvdump', 'fvs_plasma_total_required', 'fvvhe', 'fpflux_fw_neutron_max_mw', 'fzeff_max', 'falpha_energy_confinement', 'fniterpump', 'fpoloidalpower', 'ftemp_croco_quench_max']
module-attribute