Deal with deprecation and add tests

Author: tophmatthews

framework/src/kernels/ConservativeAdvection.C

@@ -40,10 +40,7 @@ ConservativeAdvectionTempl<false>::validParams()
 {
   InputParameters params = generalParams();
   params.addCoupledVar("velocity", "Velocity vector");
-  params.renameCoupledVar("velocity",
-                          "velocity_variable",
-                          "Velocity vector given as a variable. 'velocity' is deprecated and will "
-                          "be removed on 12/31/2025. Please use velocity_variable.");
+  params.deprecateCoupledVar("velocity", "velocity_variable ", "12/31/2025");
   return params;
 }
 
@@ -52,18 +49,23 @@ InputParameters
 ConservativeAdvectionTempl<is_ad>::validParams()
 {
   InputParameters params = generalParams();
-  params.addParam<MaterialPropertyName>("velocity", "Velocity vector");
-  params.renameParam("velocity",
-                     "velocity_material",
-                     "Velocity vector given as a material. 'velocity' is deprecated and will be "
-                     "removed on 12/31/2025. Please use velocity_material.");
+  params.addDeprecatedParam<MaterialPropertyName>(
+      "velocity",
+      "Velocity vector given as a material",
+      "The velocity parameter in ADConservativeAdvection will be removed on 12/31/2025. Use "
+      "velocity_material or velocity_variable instead.");
   return params;
 }
 
 template <bool is_ad>
 ConservativeAdvectionTempl<is_ad>::ConservativeAdvectionTempl(const InputParameters & parameters)
   : GenericKernel<is_ad>(parameters),
-    _velocity(isParamValid("velocity_material")
+    _velocity(this->isParamValid("velocity")
+                  ? (is_ad ? &this->template getGenericMaterialProperty<RealVectorValue, is_ad>(
+                                      "velocity")
+                                  .get()
+                           : &this->template coupledGenericVectorValue<is_ad>("velocity"))
+              : this->isParamValid("velocity_material")
                   ? &this->template getGenericMaterialProperty<RealVectorValue, is_ad>(
                              "velocity_material")
                          .get()
@@ -84,10 +86,13 @@ ConservativeAdvectionTempl<is_ad>::ConservativeAdvectionTempl(const InputParamet
     paramError(
         "advected_quantity",
         "Upwinding is not compatable with an advected quantity that is not the primary variable.");
-  if ((!this->isParamValid("velocity_variable") && !isParamValid("velocity_material")) ||
-      (this->isParamValid("velocity_variable") && isParamValid("velocity_material")))
+
+  if (!_velocity || (this->isParamValid("velocity") && this->isParamValid("velocity_material")) ||
+      (this->isParamValid("velocity_variable") && this->isParamValid("velocity_material")) ||
+      (this->isParamValid("velocity") && this->isParamValid("velocity_variable")))
     paramError("velocity_variable",
-               "Either velocity_variable or velocity_material must be specificied, not both.");
+               "Either velocity_variable or velocity_material must be specificied, not both, nor "
+               "velocity.");
 }
 
 template <bool is_ad>

test/tests/kernels/conservative_advection/ad_no_upwinding_1D.i

@@ -0,0 +1,54 @@
+# ADConservativeAdvection with upwinding_type = None
+# Apply a velocity = (1, 0, 0) and see a pulse advect to the right
+# Note there are overshoots and undershoots
+[Mesh]
+  type = GeneratedMesh
+  dim = 1
+  nx = 10
+[]
+
+[Variables]
+  [u]
+  []
+[]
+
+[BCs]
+  [u_injection_left]
+    type = InflowBC
+    boundary = left
+    variable = u
+    velocity = '1 0 0'
+    inlet_conc = 1
+  []
+[]
+
+[Materials]
+  [v]
+    type = ADGenericConstantVectorMaterial
+    prop_names = v
+    prop_values = '1 0 0'
+  []
+[]
+
+[Kernels]
+  [udot]
+    type = ADTimeDerivative
+    variable = u
+  []
+  [advection]
+    type = ADConservativeAdvection
+    variable = u
+  []
+[]
+
+[Executioner]
+  type = Transient
+  solve_type = LINEAR
+  dt = 0.1
+  end_time = 1
+  l_tol = 1E-14
+[]
+
+[Outputs]
+  exodus = true
+[]

test/tests/kernels/conservative_advection/gold/ad_no_upwinding_1D_mat_out.e

@@ -0,0 +1 @@
+no_upwinding_1D_out.e

test/tests/kernels/conservative_advection/gold/ad_no_upwinding_1D_out.e

@@ -0,0 +1 @@
+no_upwinding_1D_out.e

test/tests/kernels/conservative_advection/gold/no_upwinding_1D_mat_out.e

@@ -0,0 +1 @@
+no_upwinding_1D_out.e

test/tests/kernels/conservative_advection/no_upwinding_1D.i

@@ -8,30 +8,29 @@
 []
 
 [Variables]
-  [./u]
-  [../]
+  [u]
+  []
 []
 
 [BCs]
-  [./u_injection_left]
+  [u_injection_left]
     type = InflowBC
     boundary = left
     variable = u
     velocity = '1 0 0'
     inlet_conc = 1
-  [../]
+  []
 []
 
 [Kernels]
-  [./udot]
+  [udot]
     type = TimeDerivative
     variable = u
-  [../]
-  [./advection]
+  []
+  [advection]
     type = ConservativeAdvection
     variable = u
-    velocity = '1 0 0'
-  [../]
+  []
 []
 
 [Executioner]

test/tests/kernels/conservative_advection/tests

@@ -2,6 +2,38 @@
   design = 'ConservativeAdvection.md'
   issues = '#11852'
 
+  [error]
+    requirement = 'The system shall handle unique cases when trying to compute conservative advection '
+    [no_velocity]
+      type = RunException
+      input = no_upwinding_1D.i
+      detail = 'by throwing an error when no velocity is given,'
+      expect_err = "Either velocity_variable or velocity_material must be specificied, not both, nor velocity."
+    []
+    [ad_no_velocity]
+      type = RunException
+      input = ad_no_upwinding_1D.i
+      detail = 'by throwing an error when no velocity is given when using AD,'
+      expect_err = "Either velocity_variable or velocity_material must be specificied, not both, nor velocity."
+    []
+    [deprecated_velocity]
+      type = RunException
+      input = no_upwinding_1D.i
+      detail = 'by throwing a deprecation warning when no velocity is given when using AD,'
+      cli_args = "Kernels/advection/velocity='1 0 0'"
+      allow_deprecated = False
+      expect_err = "'velocity' has been deprecated and will be removed on 12/31/2025. Please use 'velocity_variable ' instead."
+    []
+    [ad_deprecated_velocity]
+      type = RunException
+      input = ad_no_upwinding_1D.i
+      detail = 'by throwing a deprecation warning when velocity is given when using AD,'
+      cli_args = "Kernels/advection/velocity=v Materials/v/type=ADGenericConstantVectorMaterial Materials/v/prop_names=v Materials/v/prop_values='1 0 0'"
+      allow_deprecated = False
+      expect_err = "The velocity parameter in ADConservativeAdvection will be removed on 12/31/2025. Use velocity_material or velocity_variable instead."
+    []
+  []
+
   [upwinding]
     requirement = 'The system shall include the ability to compute the residual contribution from '
                   'the conservative form of the advection operator'
@@ -11,63 +43,82 @@
       input = no_upwinding_jacobian.i
       ratio_tol = 1E-7
       difference_tol = 1E-7
-
-      detail = 'without upwinding in 3D,'
+      detail = 'and compute a perfect jacobian without upwinding in 3D,'
     []
     [full_upwinding_jacobian]
       type = PetscJacobianTester
       input = full_upwinding_jacobian.i
       ratio_tol = 1E-7
       difference_tol = 1E-7
-
-      detail = 'with upwinding in 3D,'
+      detail = 'and compute a perfect jacobian with upwinding in 3D,'
     []
     [no_upwinding_1D]
       type = Exodiff
       input = no_upwinding_1D.i
       exodiff = no_upwinding_1D_out.e
       abs_zero = 1E-7
-
-      detail = 'without upwinding in 1D,'
+      cli_args = "Kernels/advection/velocity_variable='1 0 0'"
+      detail = 'without upwinding in 1D, with velocity given as a variable,'
+    []
+    [no_upwinding_1D_mat]
+      type = Exodiff
+      input = no_upwinding_1D.i
+      prereq = upwinding/no_upwinding_1D
+      exodiff = no_upwinding_1D_mat_out.e
+      abs_zero = 1E-7
+      cli_args = "Outputs/file_base=no_upwinding_1D_mat_out Kernels/advection/velocity_material=v Materials/v/type=GenericConstantVectorMaterial Materials/v/prop_names=v Materials/v/prop_values='1 0 0'"
+      detail = 'without upwinding in 1D, with velocity given as a material,'
+    []
+    [ad_no_upwinding_1D]
+      type = Exodiff
+      input = ad_no_upwinding_1D.i
+      exodiff = ad_no_upwinding_1D_out.e
+      abs_zero = 1E-7
+      cli_args = "Kernels/advection/velocity_variable='1 0 0'"
+      detail = 'without upwinding in 1D, with velocity given as a variable, using AD,'
+    []
+    [ad_no_upwinding_1D_mat]
+      type = Exodiff
+      input = ad_no_upwinding_1D.i
+      prereq = upwinding/ad_no_upwinding_1D
+      exodiff = ad_no_upwinding_1D_mat_out.e
+      abs_zero = 1E-7
+      cli_args = "Outputs/file_base=ad_no_upwinding_1D_mat_out Kernels/advection/velocity_material=v Materials/v/type=ADGenericConstantVectorMaterial Materials/v/prop_names=v Materials/v/prop_values='1 0 0'"
+      detail = 'without upwinding in 1D, with velocity given as a material, using AD,'
     []
     [full_upwinding_1D]
       type = Exodiff
       input = full_upwinding_1D.i
       exodiff = full_upwinding_1D_out.e
       abs_zero = 1E-7
-
       detail = 'with upwinding in 1D,'
     []
     [no_upwinding_2D]
       type = Exodiff
       input = no_upwinding_2D.i
       exodiff = no_upwinding_2D_out.e
       abs_zero = 1E-7
-
       detail = 'without upwinding in 2D,'
     []
     [full_upwinding_2D]
       type = Exodiff
       input = full_upwinding_2D.i
       exodiff = full_upwinding_2D_out.e
       abs_zero = 1E-7
-
       detail = 'with upwinding in 2D,'
     []
     [none_in_all_out]
       type = Exodiff
       input = none_in_all_out.i
       exodiff = none_in_all_out_out.e
       abs_zero = 1E-7
-
       detail = 'with upwinding and an outflow boundary condition, and'
     []
     [none_in_none_out]
       type = CSVDiff
       input = none_in_none_out.i
       csvdiff = none_in_none_out_out.csv
       abs_zero = 1E-7
-
       detail = 'without any outflow boundary conditions.'
     []
   []