deprecated_and_removed_inputs.hpp File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	deprecate ("sml_param","sml_f0_grid","Use species-specific input ptl_dynamic_f0. ptl_dynamic_f0 is true by default if ptl_marker_type is 'TotalF' for that species. (Use ptl_marker_type='None' for Species 0 for adiabatic electrons.)")
	deprecate ("sml_param","sml_deltaf","The functionality of this input is now split up and species-specific. Use ptl_marker_type = 'TotalF' or 'ReducedDeltaF' for ions to replace sml_deltaf=true; the default behavior will be the same as before. Use new inputs 'ptl_f_analytic_shape' and 'ptl_weight_evo_eq' to manually control non-default combinations of these behaviors.")
	deprecate ("sml_param","sml_deltaf_elec","The functionality of this input is now split up and species-specific. Use ptl_marker_type = 'TotalF' or 'ReducedDeltaF' for electrons to replace sml_deltaf_elec=true; the default behavior will be the same as before. Use new inputs 'ptl_f_analytic_shape' and 'ptl_weight_evo_eq' to manually control non-default combinations of these behaviors.")
	deprecate ("sml_param","sml_machine","Remove")
	deprecate ("sml_param","sml_adjust_eden","Remove; the feature this input controlled has already been removed")
	deprecate ("sml_param","sml_adj_eden_zero_axis","Remove")
	deprecate ("sml_param","sml_adj_eden_vd_max","Remove")
	deprecate ("sml_param","sml_adj_eden_axis_decay_width","Remove")
	deprecate ("sml_param","sml_adj_eden_sep_decay_width","Remove")
	deprecate ("sml_param","sml_adj_eden_obd_psi","Remove")
	deprecate ("sml_param","sml_adj_eden_include_sol","Remove")
	deprecate ("coupling_param","sml_coupling_on","The old coupling method has been removed. Remove coupling_param entirely")
	deprecate ("ptl_param","ptl_maxnum","Remove")
	deprecate ("ptl_param","ptl_lost_nummax","Remove")
	deprecate ("neu_param","neu_monte_num","Remove")
	remove ("eq_param","eq_den_shape","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_den_v1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_den_x1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempi_shape","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowi_shape","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowi_type","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempi_v1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempi_x1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowi_v1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowi_x1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempe_shape","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowe_shape","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowe_type","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempe_v1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempe_x1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowe_v1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowe_x1","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_den_file","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempi_file","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_tempe_file","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowi_file","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("eq_param","eq_flowe_file","MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.")
	remove ("sml_param","sml_mode_select_mres","Remove or replace with sml_mode_select_mres_q")
	remove ("diag_param","diag_2d_on","Removed to consolidate with XGC1 diagnostics. Use diag_3d_on instead")
	remove ("diag_param","diag_2d_more","Removed to consolidate with XGC1 diagnostics. Use diag_3d_more instead")
	remove ("diag_param","diag_f2d_period","Removed to consolidate with XGC1 diagnostics. Use diag_f3d_period instead")
	remove ("diag_param","diag_rmp_period","Removed - this diagnostic no longer exists")
	remove ("sml_param","sml_invert_B","Removed - instead, set sml_bp_sign = (sml_invert_B ? -1 : 1)")
	remove ("sml_param","sml_co_cur_bt","Removed - instead, set sml_bt_sign = sml_bp_sign*(sml_co_cur_bt ? -1 : 1)")
	remove ("col_param","col_imp_on","Removed - this col method no longer exists.")
	remove ("col_param","col_imp_charge","Removed - this col method no longer exists.")
	remove ("col_param","col_imp_mass","Removed - this col method no longer exists.")
	remove ("col_param","col_2_pin","Removed - this col method no longer exists.")
	remove ("col_param","col_2_pout","Removed - this col method no longer exists.")
	remove ("col_param","col_2_iteration_method","Removed - this col method no longer exists.")
	remove ("col_param","col_den_imp_edge","Removed - this col method no longer exists.")
	remove ("col_param","col_den_imp_out","Removed - this col method no longer exists.")
	remove ("col_param","col_den_imp_ped_c","Removed - this col method no longer exists.")
	remove ("col_param","col_den_imp_ped_width","Removed - this col method no longer exists.")
	remove ("col_param","col_3_npsi","Removed - this col method no longer exists.")
	remove ("col_param","col_3_ntheta","Removed - this col method no longer exists.")
	remove ("col_param","col_3_nvr","Removed - this col method no longer exists.")
	remove ("col_param","col_3_nvz","Removed - this col method no longer exists.")
	remove ("col_param","col_3_npsi_sol","Removed - this col method no longer exists.")
	remove ("col_param","col_3_ntheta_sol","Removed - this col method no longer exists.")
	remove ("neu_param","neu_mode2_period","Removed - this neutrals method no longer exists.")
	remove ("sml_param","sml_deltaf_f0_mode","Removed - profiles option (formerly labeled '-2') is now only option.")
	remove ("sml_param","sml_f0_1_Ln","Removed - this method no longer exists")
	remove ("sml_param","sml_f0_1_Lt","Removed - this method no longer exists")
	remove ("sml_param","sml_f0_1_Lt_e","Removed - this method no longer exists")
	remove ("ptb_3db_param","ptb_3db_diag_mn_inpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_diag_mn_outpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_diag_dA_inpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_diag_dA_outpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_jpar_avg_period","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_field_update_period","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_solve_mn_inpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_solve_mn_outpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_solve_mpol_max","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_solve_mpol_min","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_dA_inpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_dA_outpsi","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_force_symmetric_f","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_div_clean_on","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_rampup_interval","Removed - this parameter no longer exists")
	remove ("ptb_3db_param","ptb_3db_mpol_min","Removed - this parameter no longer exists")
	remove ("sml_param","sml_initial_flow","Removed - this is always true. Use zero flow to use steady Maxwelliean")
	remove ("sml_param","sml_00_poisson","Removed - this parameter no longer exists")
	remove ("sml_param","sml_turb_poisson","Removed - this parameter no longer exists")
	remove ("sml_param","sml_turb_poisson_n0_only","Removed - this parameter no longer exists")
	remove ("sml_param","sml_veclen","Removed - this parameter no longer exists")

Function Documentation

deprecate	(	"sml_param"	,
		"sml_f0_grid"	,
		"Use species-specific input ptl_dynamic_f0. ptl_dynamic_f0 is true by default if ptl_marker_type is 'TotalF' for that species. (Use ptl_marker_type='None' for Species 0 for adiabatic electrons.)"
	)

deprecate	(	"sml_param"	,
		"sml_deltaf"
	)

deprecate	(	"sml_param"	,
		"sml_deltaf_elec"
	)

deprecate	(	"sml_param"	,
		"sml_machine"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adjust_eden"	,
		"Remove; the feature this input controlled has already been removed"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_zero_axis"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_vd_max"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_axis_decay_width"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_sep_decay_width"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_obd_psi"	,
		"Remove"
	)

deprecate	(	"sml_param"	,
		"sml_adj_eden_include_sol"	,
		"Remove"
	)

deprecate	(	"coupling_param"	,
		"sml_coupling_on"	,
		"The old coupling method has been removed. Remove coupling_param entirely"
	)

deprecate	(	"ptl_param"	,
		"ptl_maxnum"	,
		"Remove"
	)

deprecate	(	"ptl_param"	,
		"ptl_lost_nummax"	,
		"Remove"
	)

deprecate	(	"neu_param"	,
		"neu_monte_num"	,
		"Remove"
	)

remove	(	"eq_param"	,
		"eq_den_shape"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_den_v1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_den_x1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempi_shape"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowi_shape"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowi_type"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempi_v1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempi_x1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowi_v1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowi_x1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempe_shape"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowe_shape"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowe_type"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempe_v1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempe_x1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowe_v1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowe_x1"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_den_file"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempi_file"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_tempe_file"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowi_file"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"eq_param"	,
		"eq_flowe_file"	,
		"	MULTISPECIES_INPUT = On is deprecated. Use eq_dens,
		eq_temp	,
		and eq_flow instead."
	)

remove	(	"sml_param"	,
		"sml_mode_select_mres"	,
		"Remove or replace with sml_mode_select_mres_q"
	)

remove	(	"diag_param"	,
		"diag_2d_on"	,
		"Removed to consolidate with XGC1 diagnostics. Use diag_3d_on instead"
	)

remove	(	"diag_param"	,
		"diag_2d_more"	,
		"Removed to consolidate with XGC1 diagnostics. Use diag_3d_more instead"
	)

remove	(	"diag_param"	,
		"diag_f2d_period"	,
		"Removed to consolidate with XGC1 diagnostics. Use diag_f3d_period instead"
	)

remove	(	"diag_param"	,
		"diag_rmp_period"	,
		"Removed - this diagnostic no longer exists"
	)

remove	(	"sml_param"	,
		"sml_invert_B"	,
		"Removed -	instead
	)

remove	(	"sml_param"	,
		"sml_co_cur_bt"	,
		"Removed -	instead
	)

remove	(	"col_param"	,
		"col_imp_on"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_imp_charge"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_imp_mass"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_2_pin"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_2_pout"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_2_iteration_method"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_den_imp_edge"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_den_imp_out"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_den_imp_ped_c"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_den_imp_ped_width"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_npsi"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_ntheta"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_nvr"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_nvz"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_npsi_sol"	,
		"Removed - this col method no longer exists."
	)

remove	(	"col_param"	,
		"col_3_ntheta_sol"	,
		"Removed - this col method no longer exists."
	)

remove	(	"neu_param"	,
		"neu_mode2_period"	,
		"Removed - this neutrals method no longer exists."
	)

remove	(	"sml_param"	,
		"sml_deltaf_f0_mode"	,
		"Removed - profiles option (formerly labeled '-2') is now only option."
	)

remove	(	"sml_param"	,
		"sml_f0_1_Ln"	,
		"Removed - this method no longer exists"
	)

remove	(	"sml_param"	,
		"sml_f0_1_Lt"	,
		"Removed - this method no longer exists"
	)

remove	(	"sml_param"	,
		"sml_f0_1_Lt_e"	,
		"Removed - this method no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_diag_mn_inpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_diag_mn_outpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_diag_dA_inpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_diag_dA_outpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_jpar_avg_period"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_field_update_period"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_solve_mn_inpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_solve_mn_outpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_solve_mpol_max"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_solve_mpol_min"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_dA_inpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_dA_outpsi"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_force_symmetric_f"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_div_clean_on"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_rampup_interval"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"ptb_3db_param"	,
		"ptb_3db_mpol_min"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"sml_param"	,
		"sml_initial_flow"	,
		"Removed - this is always true. Use zero flow to use steady Maxwelliean"
	)

remove	(	"sml_param"	,
		"sml_00_poisson"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"sml_param"	,
		"sml_turb_poisson"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"sml_param"	,
		"sml_turb_poisson_n0_only"	,
		"Removed - this parameter no longer exists"
	)

remove	(	"sml_param"	,
		"sml_veclen"	,
		"Removed - this parameter no longer exists"
	)