XGC1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
deprecated_and_removed_inputs.hpp
Go to the documentation of this file.
1 /* Deprecated and removed input parameters
2  *
3  * Provide specific instructions for users to handle these!
4  *
5  * Format:
6  * deprecate("namelist name", "parameter name", "instructions")
7  *
8  * */
9 
10 // Deprecated - give warning
11 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.)");
12 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.");
13 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.");
14 deprecate("sml_param", "sml_machine", "Remove");
15 deprecate("sml_param", "sml_adjust_eden", "Remove; the feature this input controlled has already been removed");
16 deprecate("sml_param", "sml_adj_eden_zero_axis", "Remove");
17 deprecate("sml_param", "sml_adj_eden_vd_max", "Remove");
18 deprecate("sml_param", "sml_adj_eden_axis_decay_width", "Remove");
19 deprecate("sml_param", "sml_adj_eden_sep_decay_width", "Remove");
20 deprecate("sml_param", "sml_adj_eden_obd_psi", "Remove");
21 deprecate("sml_param", "sml_adj_eden_include_sol", "Remove");
22 deprecate("sml_param", "sml_special", "Use sml_load_single_ptl to load a single particle. Set sml_field_solver=.false. as well. Other special options are not available");
23 deprecate("coupling_param", "sml_coupling_on", "The old coupling method has been removed. Remove coupling_param entirely");
24 deprecate("ptl_param", "ptl_maxnum", "Remove");
25 deprecate("ptl_param", "ptl_lost_nummax", "Remove");
26 deprecate("neu_param", "neu_monte_num", "Remove");
27 deprecate("smooth_param", "smooth_r1_d0_in", "Remove - smooth_r no longer exists");
28 deprecate("smooth_param", "smooth_r1_n_in", "Remove - smooth_r no longer exists");
29 deprecate("smooth_param", "smooth_r1_type_in", "Remove - smooth_r no longer exists");
30 
31 remove("eq_param", "eq_den_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
32 remove("eq_param", "eq_den_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
33 remove("eq_param", "eq_den_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
34 remove("eq_param", "eq_tempi_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
35 remove("eq_param", "eq_flowi_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
36 remove("eq_param", "eq_flowi_type", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
37 remove("eq_param", "eq_tempi_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
38 remove("eq_param", "eq_tempi_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
39 remove("eq_param", "eq_flowi_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
40 remove("eq_param", "eq_flowi_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
41 remove("eq_param", "eq_tempe_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
42 remove("eq_param", "eq_flowe_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
43 remove("eq_param", "eq_flowe_type", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
44 remove("eq_param", "eq_tempe_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
45 remove("eq_param", "eq_tempe_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
46 remove("eq_param", "eq_flowe_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
47 remove("eq_param", "eq_flowe_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
48 remove("eq_param", "eq_den_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
49 remove("eq_param", "eq_tempi_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
50 remove("eq_param", "eq_tempe_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
51 remove("eq_param", "eq_flowi_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
52 remove("eq_param", "eq_flowe_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens, eq_temp, and eq_flow instead.");
53 remove("eq_param", "eq_den_diff_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
54 remove("eq_param", "eq_flowi_diff_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
55 remove("eq_param", "eq_flowe_diff_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
56 remove("eq_param", "eq_ti_diff_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
57 remove("eq_param", "eq_te_diff_file", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
58 remove("eq_param", "eq_den_diff_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
59 remove("eq_param", "eq_flowi_diff_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
60 remove("eq_param", "eq_flowe_diff_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
61 remove("eq_param", "eq_ti_diff_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
62 remove("eq_param", "eq_te_diff_shape", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
63 remove("eq_param", "eq_den_diff_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
64 remove("eq_param", "eq_flowi_diff_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
65 remove("eq_param", "eq_flowe_diff_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
66 remove("eq_param", "eq_ti_diff_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
67 remove("eq_param", "eq_te_diff_v1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
68 remove("eq_param", "eq_den_diff_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
69 remove("eq_param", "eq_flowi_di_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
70 remove("eq_param", "eq_flowe_diff_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
71 remove("eq_param", "eq_ti_diff_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
72 remove("eq_param", "eq_te_diff_x1", "MULTISPECIES_INPUT=On is deprecated. Use eq_dens_diff, eq_t_diff, and eq_flow_diff instead.");
73 
74 
75 // Removed - give error
76 remove("sml_param", "sml_mode_select_mres", "Remove or replace with sml_mode_select_mres_q");
77 remove("diag_param", "diag_2d_on", "Removed to consolidate with XGC1 diagnostics. Use diag_3d_on instead");
78 remove("diag_param", "diag_2d_more", "Removed to consolidate with XGC1 diagnostics. Use diag_3d_more instead");
79 remove("diag_param", "diag_f2d_period", "Removed to consolidate with XGC1 diagnostics. Use diag_f3d_period instead");
80 remove("diag_param", "diag_rmp_period", "Removed - this diagnostic no longer exists");
81 remove("sml_param", "sml_invert_B", "Removed - instead, set sml_bp_sign = (sml_invert_B ? -1 : 1)");
82 remove("sml_param", "sml_co_cur_bt", "Removed - instead, set sml_bt_sign = sml_bp_sign*(sml_co_cur_bt ? -1 : 1)");
83 remove("col_param", "col_imp_on", "Removed - this col method no longer exists.");
84 remove("col_param", "col_imp_charge", "Removed - this col method no longer exists.");
85 remove("col_param", "col_imp_mass", "Removed - this col method no longer exists.");
86 remove("col_param", "col_2_pin", "Removed - this col method no longer exists.");
87 remove("col_param", "col_2_pout", "Removed - this col method no longer exists.");
88 remove("col_param", "col_2_iteration_method", "Removed - this col method no longer exists.");
89 remove("col_param", "col_den_imp_edge", "Removed - this col method no longer exists.");
90 remove("col_param", "col_den_imp_out", "Removed - this col method no longer exists.");
91 remove("col_param", "col_den_imp_ped_c", "Removed - this col method no longer exists.");
92 remove("col_param", "col_den_imp_ped_width", "Removed - this col method no longer exists.");
93 remove("col_param", "col_3_npsi", "Removed - this col method no longer exists.");
94 remove("col_param", "col_3_ntheta", "Removed - this col method no longer exists.");
95 remove("col_param", "col_3_nvr", "Removed - this col method no longer exists.");
96 remove("col_param", "col_3_nvz", "Removed - this col method no longer exists.");
97 remove("col_param", "col_3_npsi_sol", "Removed - this col method no longer exists.");
98 remove("col_param", "col_3_ntheta_sol", "Removed - this col method no longer exists.");
99 remove("neu_param", "neu_mode2_period", "Removed - this neutrals method no longer exists.");
100 remove("sml_param", "sml_deltaf_f0_mode", "Removed - profiles option (formerly labeled '-2') is now only option.");
101 remove("sml_param", "sml_f0_1_Ln", "Removed - this method no longer exists");
102 remove("sml_param", "sml_f0_1_Lt", "Removed - this method no longer exists");
103 remove("sml_param", "sml_f0_1_Lt_e", "Removed - this method no longer exists");
104 remove("ptb_3db_param", "ptb_3db_on", "Removed - use sml_3db_on instead");
105 remove("ptb_3db_param", "ptb_3db_diag_mn_inpsi", "Removed - this parameter no longer exists");
106 remove("ptb_3db_param", "ptb_3db_diag_mn_outpsi", "Removed - this parameter no longer exists");
107 remove("ptb_3db_param", "ptb_3db_diag_dA_inpsi", "Removed - this parameter no longer exists");
108 remove("ptb_3db_param", "ptb_3db_diag_dA_outpsi", "Removed - this parameter no longer exists");
109 remove("ptb_3db_param", "ptb_3db_jpar_avg_period", "Removed - this parameter no longer exists");
110 remove("ptb_3db_param", "ptb_3db_field_update_period", "Removed - this parameter no longer exists");
111 remove("ptb_3db_param", "ptb_3db_field_update_period", "Removed - this parameter no longer exists");
112 remove("ptb_3db_param", "ptb_3db_field_update_period", "Removed - this parameter no longer exists");
113 remove("ptb_3db_param", "ptb_3db_solve_mn_inpsi", "Removed - this parameter no longer exists");
114 remove("ptb_3db_param", "ptb_3db_solve_mn_outpsi", "Removed - this parameter no longer exists");
115 remove("ptb_3db_param", "ptb_3db_solve_mpol_max", "Removed - this parameter no longer exists");
116 remove("ptb_3db_param", "ptb_3db_solve_mpol_min", "Removed - this parameter no longer exists");
117 remove("ptb_3db_param", "ptb_3db_dA_inpsi", "Removed - this parameter no longer exists");
118 remove("ptb_3db_param", "ptb_3db_dA_outpsi", "Removed - this parameter no longer exists");
119 remove("ptb_3db_param", "ptb_3db_force_symmetric_f", "Removed - this parameter no longer exists");
120 remove("ptb_3db_param", "ptb_3db_div_clean_on", "Removed - this parameter no longer exists");
121 remove("ptb_3db_param", "ptb_3db_rampup_interval", "Removed - this parameter no longer exists");
122 remove("ptb_3db_param", "ptb_3db_mpol_min", "Removed - this parameter no longer exists");
123 remove("sml_param", "sml_initial_flow", "Removed - this is always true. Use zero flow to use steady Maxwelliean");
124 remove("sml_param", "sml_00_poisson", "Removed - this parameter no longer exists");
125 remove("sml_param", "sml_turb_poisson", "Removed - this parameter no longer exists");
126 remove("sml_param", "sml_turb_poisson_n0_only", "Removed - this parameter no longer exists");
127 remove("sml_param", "sml_veclen", "Removed - this parameter no longer exists");
128 remove("smooth_param", "smooth_nearx_d0", "Removed - smooth_nearx no longer exists");
129 remove("smooth_param", "smooth_nearx_dr", "Removed - smooth_nearx no longer exists");
130 remove("smooth_param", "smooth_nearx_dz", "Removed - smooth_nearx no longer exists");
131 remove("smooth_param", "smooth_nearx_nsmth", "Removed - smooth_nearx no longer exists");
132 
133 //remove("", "", "Removed - this parameter no longer exists");
134 
deprecate
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.)")
Generated by   doxygen 1.8.5