Deprecates old BC parameters

contributes to closing issue shannon-lab#223

src/bcs/EconomouDielectricBC.C

@@ -19,19 +19,6 @@ EconomouDielectricBC::validParams()
   params.addRequiredParam<Real>("dielectric_constant", "The dielectric constant of the material.");
   params.addRequiredParam<Real>("thickness", "The thickness of the material.");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-
-  params.addRequiredCoupledVar("mean_en", "The mean energy.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
-  params.addRequiredCoupledVar("potential_ion", "The ion potential");
-  params.deprecateCoupledVar("potential_ion", "ion_potentials", "06/01/2024");
-  params.addParam<std::vector<std::string>>(
-      "users_gamma", "A secondary electron emission coeff. only used for this BC.");
-  params.deprecateParam("users_gamma", "emission_coeffs", "06/01/2024");
-
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density. In log form");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");

src/bcs/ElectronTemperatureDirichletBC.C

@@ -17,8 +17,6 @@ ElectronTemperatureDirichletBC::validParams()
 {
   InputParameters params = ADNodalBC::validParams();
   params.addRequiredParam<Real>("value", "Value of the BC");
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addParam<Real>("penalty_value", 1.0, "The penalty value for the Dirichlet BC.");
   params.addClassDescription("Electron temperature boundary condition");

src/bcs/FieldEmissionBC.C

@@ -18,8 +18,6 @@ FieldEmissionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs",
@@ -36,7 +34,7 @@ FieldEmissionBC::FieldEmissionBC(const InputParameters & parameters)
 
     _r_units(1. / getParam<Real>("position_units")),
     _r(getParam<Real>("r")),
-    _num_ions(coupledComponents("ip")),
+    _num_ions(coupledComponents("ions")),
     // Coupled Variables
     _grad_potential(adCoupledGradient("potential")),
 

src/bcs/HagelaarElectronBC.C

@@ -18,8 +18,6 @@ HagelaarElectronBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("mean_en", "The mean energy.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
 
   params.addRequiredParam<Real>("position_units", "Units of position.");

src/bcs/HagelaarEnergyAdvectionBC.C

@@ -18,8 +18,6 @@ HagelaarEnergyAdvectionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs",

src/bcs/HagelaarEnergyBC.C

@@ -18,8 +18,6 @@ HagelaarEnergyBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   return params;
@@ -32,7 +30,7 @@ HagelaarEnergyBC::HagelaarEnergyBC(const InputParameters & parameters)
 
     // Coupled Variables
     _grad_potential(adCoupledGradient("potential")),
-    _em(adCoupledValue("em")),
+    _em(adCoupledValue("electrons")),
 
     _massem(getMaterialProperty<Real>("massem")),
     _e(getMaterialProperty<Real>("e")),

src/bcs/LymberopoulosElectronBC.C

@@ -17,15 +17,10 @@ LymberopoulosElectronBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("ks", "The recombination coefficient");
-  params.addRequiredParam<std::vector<Real>>("gamma", "The secondary electron coefficient");
-  params.deprecateParam("gamma", "emission_coeffs", "06/01/2024");
   params.addRequiredParam<std::vector<Real>>(
       "emission_coeffs", "The species-dependent secondary electron emission coefficients");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("ion", "The ion density.");
-  params.deprecateCoupledVar("ion", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
-
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addClassDescription("Simpified kinetic electron boundary condition"
                              "(Based on DOI: https://doi.org/10.1063/1.352926)");
@@ -55,10 +50,10 @@ LymberopoulosElectronBC::LymberopoulosElectronBC(const InputParameters & paramet
   // refers to a single ion species.
   for (unsigned int i = 0; i < _num_ions; ++i)
   {
-    _ion_var[i] = getVar("ion", i);
-    _ion[i] = &adCoupledValue("ion", i);
-    _muion[i] = &getADMaterialProperty<Real>("mu" + (*getVar("ion", i)).name());
-    _sgnion[i] = &getMaterialProperty<Real>("sgn" + (*getVar("ion", i)).name());
+    _ion_var[i] = getVar("ions", i);
+    _ion[i] = &adCoupledValue("ions", i);
+    _muion[i] = &getADMaterialProperty<Real>("mu" + (*getVar("ions", i)).name());
+    _sgnion[i] = &getMaterialProperty<Real>("sgn" + (*getVar("ions", i)).name());
   }
 }
 

src/bcs/NeumannCircuitVoltageMoles_KV.C

@@ -24,19 +24,9 @@ NeumannCircuitVoltageMoles_KV::validParams()
       "data_provider",
       "The name of the UserObject that can provide some data to materials, bcs, etc.");
 
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log-molar form");
-
-  params.addRequiredCoupledVar("em", "The log of the electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
-
-  params.addRequiredCoupledVar(
-      "mean_en", "The log of the product of the mean energy and the electron density.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
-
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs",
       "The secondary electron emission coefficient for each ion provided in `ions`");
@@ -107,7 +97,7 @@ NeumannCircuitVoltageMoles_KV::NeumannCircuitVoltageMoles_KV(const InputParamete
   for (unsigned int i = 0; i < _ip.size(); ++i)
   {
     _ip[i] = &adCoupledValue("ions", i);
-    _grad_ip[i] = &adCoupledGradient("ip", i);
+    _grad_ip[i] = &adCoupledGradient("ions", i);
     _T_heavy[i] = &getADMaterialProperty<Real>("T" + (*getVar("ions", i)).name());
     _muip[i] = &getADMaterialProperty<Real>("mu" + (*getVar("ions", i)).name());
     _Dip[i] = &getADMaterialProperty<Real>("diff" + (*getVar("ions", i)).name());

src/bcs/PenaltyCircuitPotential.C

@@ -31,19 +31,9 @@ PenaltyCircuitPotential::validParams()
   params.addRequiredParam<UserObjectName>(
       "data_provider",
       "The name of the UserObject that can provide some data to materials, bcs, etc.");
-
-  params.addRequiredCoupledVar("em", "The electron variable.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form.");
-
-  params.addRequiredCoupledVar("ip", "The ion variable.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "The ion density in log form.");
-
-  params.addRequiredCoupledVar("mean_en", "The mean electron energy density in log form.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form.");
-
   params.addParam<Real>("area", "Must be provided when the number of dimensions equals 1.");
   params.addRequiredParam<std::string>("potential_units", "The potential units.");
   params.addRequiredParam<Real>("position_units", "Units of position.");

src/bcs/SakiyamaElectronDiffusionBC.C

@@ -16,8 +16,6 @@ InputParameters
 SakiyamaElectronDiffusionBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
-  params.addRequiredCoupledVar("mean_en", "The mean energy.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addClassDescription("Kinetic electron boundary condition"

src/bcs/SakiyamaEnergyDiffusionBC.C

@@ -16,8 +16,6 @@ InputParameters
 SakiyamaEnergyDiffusionBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addClassDescription("Kinetic advective electron energy boundary condition"

src/bcs/SakiyamaEnergySecondaryElectronBC.C

@@ -16,26 +16,16 @@ InputParameters
 SakiyamaEnergySecondaryElectronBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
-  params.addRequiredParam<std::vector<std::string>>("se_coeff",
-                                                    "The secondary electron coefficient");
-  params.deprecateParam("se_coeff", "emission_coeffs", "06/01/2024");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs",
       "The secondary electron emission coefficient for each ion provided in `ions`");
   params.addRequiredParam<bool>(
       "Tse_equal_Te", "The secondary electron temperature equal the electron temperature in eV");
   params.addParam<Real>(
-      "user_se_energy", 1.0, "The user's value of the secondary electron temperature in eV");
-  params.deprecateParam("user_se_energy", "secondary_electron_energy", "06/01/2024");
-  params.addParam<Real>("secondary_electron_energy", "The secondary electron temperature in eV");
+      "secondary_electron_energy", 1.0, "The secondary electron temperature in eV");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
-
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addClassDescription(
       "Kinetic secondary electron for mean electron energy boundary condition"
@@ -54,7 +44,7 @@ SakiyamaEnergySecondaryElectronBC::SakiyamaEnergySecondaryElectronBC(
     // Coupled Variables
     _grad_potential(adCoupledGradient("potential")),
 
-    _em(adCoupledValue("em")),
+    _em(adCoupledValue("electrons")),
 
     _user_se_energy(getParam<Real>("secondary_electron_energy")),
     _a(0.5),

src/bcs/SakiyamaSecondaryElectronBC.C

@@ -17,13 +17,8 @@ SakiyamaSecondaryElectronBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addRequiredParam<std::vector<std::string>>(
-      "users_gamma", "A secondary electron emission coeff. only used for this BC.");
-  params.deprecateParam("users_gamma", "emission_coeffs", "06/01/2024");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs", "A list of species-dependent secondary electron emission coefficients");
   params.addClassDescription("Kinetic secondary electron boundary condition"

src/bcs/SchottkyEmissionBC.C

@@ -18,11 +18,7 @@ SchottkyEmissionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("mean_en", "The mean energy.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/204");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs",

src/bcs/SecondaryElectronBC.C

@@ -19,11 +19,7 @@ SecondaryElectronBC::validParams()
   params.addRequiredParam<Real>("r", "The reflection coefficient of the electrons.");
   params.addParam<Real>("r_ion", 0, "The reflection coefficient of the ions.");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("mean_en", "The mean energy.");
-  params.deprecateCoupledVar("mean_en", "electron_energy", "06/01/2024");
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addRequiredParam<std::vector<std::string>>(

src/bcs/SecondaryElectronEnergyBC.C

@@ -19,12 +19,7 @@ SecondaryElectronEnergyBC::validParams()
   params.addRequiredParam<Real>("r", "The reflection coefficient of the electrons.");
   params.addParam<Real>("r_ion", 0, "The reflection coefficient of the ions.");
   params.addRequiredCoupledVar("potential", "The electric potential");
-  params.addRequiredCoupledVar("em", "The electron density.");
-  params.deprecateCoupledVar("em", "electrons", "06/01/2024");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
-
-  params.addRequiredCoupledVar("ip", "The ion density.");
-  params.deprecateCoupledVar("ip", "ions", "06/01/2024");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addRequiredParam<std::vector<std::string>>(