Allowing Dirichlet BCs to take state - needed for limiters Refs idaho…

…lab#29145
tanoret · Nov 26, 2024 · 460817c · 460817c
1 parent 2a74993
commit 460817c
Show file tree

Hide file tree

Showing 30 changed files with 52 additions and 57 deletions.
diff --git a/framework/include/fvbcs/FVDirichletBC.h b/framework/include/fvbcs/FVDirichletBC.h
@@ -21,7 +21,7 @@ class FVDirichletBC : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   const Real & _val;

diff --git a/framework/include/fvbcs/FVDirichletBCBase.h b/framework/include/fvbcs/FVDirichletBCBase.h
@@ -23,5 +23,5 @@ class FVDirichletBCBase : public FVBoundaryCondition
 
   static InputParameters validParams();
 
-  virtual ADReal boundaryValue(const FaceInfo & fi) const = 0;
+  virtual ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const = 0;
 };
diff --git a/framework/include/fvbcs/FVFunctionDirichletBC.h b/framework/include/fvbcs/FVFunctionDirichletBC.h
@@ -21,7 +21,7 @@ class FVFunctionDirichletBC : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   const Function & _function;

diff --git a/framework/include/fvbcs/FVFunctorDirichletBC.h b/framework/include/fvbcs/FVFunctorDirichletBC.h
@@ -19,7 +19,7 @@ class FVFunctorDirichletBCTempl : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   /// The value for this BC

diff --git a/framework/include/fvbcs/FVPostprocessorDirichletBC.h b/framework/include/fvbcs/FVPostprocessorDirichletBC.h
@@ -18,7 +18,7 @@ class FVPostprocessorDirichletBC : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   /// The value for this BC

diff --git a/framework/src/fvbcs/FVDirichletBC.C b/framework/src/fvbcs/FVDirichletBC.C
@@ -26,7 +26,7 @@ FVDirichletBC::FVDirichletBC(const InputParameters & parameters)
 }
 
 ADReal
-FVDirichletBC::boundaryValue(const FaceInfo & /*fi*/) const
+FVDirichletBC::boundaryValue(const FaceInfo & /*fi*/, const Moose::StateArg & /*state*/) const
 {
   return _val;
 }
diff --git a/framework/src/fvbcs/FVFunctionDirichletBC.C b/framework/src/fvbcs/FVFunctionDirichletBC.C
@@ -29,7 +29,7 @@ FVFunctionDirichletBC::FVFunctionDirichletBC(const InputParameters & parameters)
 }
 
 ADReal
-FVFunctionDirichletBC::boundaryValue(const FaceInfo & fi) const
+FVFunctionDirichletBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & /*state*/) const
 {
   return _function.value(_t, fi.faceCentroid());
 }
diff --git a/framework/src/fvbcs/FVFunctorDirichletBC.C b/framework/src/fvbcs/FVFunctorDirichletBC.C
@@ -52,17 +52,18 @@ FVFunctorDirichletBCTempl<is_ad>::FVFunctorDirichletBCTempl(const InputParameter
 
 template <bool is_ad>
 ADReal
-FVFunctorDirichletBCTempl<is_ad>::boundaryValue(const FaceInfo & fi) const
+FVFunctorDirichletBCTempl<is_ad>::boundaryValue(const FaceInfo & fi,
+                                                const Moose::StateArg & state) const
 {
   auto sfa = singleSidedFaceArg(&fi);
   if (!_use_other_side)
-    return _functor(sfa, determineState());
+    return _functor(sfa, state);
   else if (fi.elemPtr() == sfa.face_side)
     return _functor({&fi, Moose::FV::LimiterType::CentralDifference, true, false, fi.neighborPtr()},
-                    determineState());
+                    state);
   else
     return _functor({&fi, Moose::FV::LimiterType::CentralDifference, true, false, fi.elemPtr()},
-                    determineState());
+                    state);
 }
 
 template class FVFunctorDirichletBCTempl<false>;

diff --git a/framework/src/fvbcs/FVPostprocessorDirichletBC.C b/framework/src/fvbcs/FVPostprocessorDirichletBC.C
@@ -27,7 +27,8 @@ FVPostprocessorDirichletBC::FVPostprocessorDirichletBC(const InputParameters & p
 }
 
 ADReal
-FVPostprocessorDirichletBC::boundaryValue(const FaceInfo & /*fi*/) const
+FVPostprocessorDirichletBC::boundaryValue(const FaceInfo & /*fi*/,
+                                          const Moose::StateArg & /*state*/) const
 {
   return _postprocessor_value;
 }
diff --git a/framework/src/variables/MooseVariableFV.C b/framework/src/variables/MooseVariableFV.C
@@ -489,16 +489,12 @@ MooseVariableFV<OutputType>::isDirichletBoundaryFace(const FaceInfo & fi,
 
 template <typename OutputType>
 ADReal
-MooseVariableFV<OutputType>::getDirichletBoundaryFaceValue(
-    const FaceInfo & fi,
-    const Elem * const libmesh_dbg_var(elem),
-    const Moose::StateArg & libmesh_dbg_var(state)) const
+MooseVariableFV<OutputType>::getDirichletBoundaryFaceValue(const FaceInfo & fi,
+                                                           const Elem * const libmesh_dbg_var(elem),
+                                                           const Moose::StateArg & state) const
 {
   mooseAssert(isDirichletBoundaryFace(fi, elem, state),
               "This function should only be called on Dirichlet boundary faces.");
-  mooseAssert(state.state == 0,
-              "getDirichletBoundaryFaceValue currently only supports evaluating at the current "
-              "time/iteration state");
 
   const auto & diri_pr = getDirichletBC(fi);
 
@@ -507,7 +503,7 @@ MooseVariableFV<OutputType>::getDirichletBoundaryFaceValue(
 
   const FVDirichletBCBase & bc = *diri_pr.second;
 
-  return ADReal(bc.boundaryValue(fi));
+  return ADReal(bc.boundaryValue(fi, state));
 }
 
 template <typename OutputType>
@@ -736,12 +732,7 @@ MooseVariableFV<OutputType>::evaluate(const FaceArg & face, const StateArg & sta
   const FaceInfo * const fi = face.fi;
   mooseAssert(fi, "The face information must be non-null");
   if (isDirichletBoundaryFace(*fi, face.face_side, state))
-  {
-    mooseAssert(state.state == 0,
-                "We have not yet added support for evaluating Dirichlet boundary conditions at "
-                "states other than the current solution state (e.g. current time)");
     return getDirichletBoundaryFaceValue(*fi, face.face_side, state);
-  }
   else if (isExtrapolatedBoundaryFace(*fi, face.face_side, state))
   {
     bool two_term_boundary_expansion = _two_term_boundary_expansion;

diff --git a/modules/navier_stokes/include/fvbcs/INSFVInletIntensityTKEBC.h b/modules/navier_stokes/include/fvbcs/INSFVInletIntensityTKEBC.h
@@ -19,7 +19,7 @@ class INSFVInletIntensityTKEBC : public FVDirichletBCBase
 public:
   static InputParameters validParams();
   INSFVInletIntensityTKEBC(const InputParameters & params);
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 protected:
   /// x-velocity

diff --git a/modules/navier_stokes/include/fvbcs/INSFVMixingLengthTKEDBC.h b/modules/navier_stokes/include/fvbcs/INSFVMixingLengthTKEDBC.h
@@ -19,7 +19,7 @@ class INSFVMixingLengthTKEDBC : public FVDirichletBCBase
 public:
   static InputParameters validParams();
   INSFVMixingLengthTKEDBC(const InputParameters & params);
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 protected:
   /// C-mu closure coefficient

diff --git a/modules/navier_stokes/include/fvbcs/INSFVOutletPressureBC.h b/modules/navier_stokes/include/fvbcs/INSFVOutletPressureBC.h
@@ -23,7 +23,8 @@ class INSFVOutletPressureBCTempl : public FVDirichletBCBase, public T
   static InputParameters validParams();
   INSFVOutletPressureBCTempl(const InputParameters & params);
 
-  ADReal boundaryValue(const FaceInfo & /* fi */) const override;
+  ADReal boundaryValue(const FaceInfo & /* fi */,
+                       const Moose::StateArg & /* state */) const override;
 
 protected:
   /// AD Functor that gives the distribution of pressure on the boundary

diff --git a/modules/navier_stokes/include/fvbcs/INSFVSwitchableOutletPressureBC.h b/modules/navier_stokes/include/fvbcs/INSFVSwitchableOutletPressureBC.h
@@ -23,7 +23,8 @@ class INSFVSwitchableOutletPressureBC : public INSFVOutletPressureBCTempl<INSFVF
   static InputParameters validParams();
   INSFVSwitchableOutletPressureBC(const InputParameters & params);
 
-  ADReal boundaryValue(const FaceInfo & /* fi */) const override;
+  ADReal boundaryValue(const FaceInfo & /* fi */,
+                       const Moose::StateArg & /* state */) const override;
 
 private:
   /// Boolean switch to turn boundary condition on/off

diff --git a/modules/navier_stokes/include/fvbcs/INSFVTKEDWallFunctionBC.h b/modules/navier_stokes/include/fvbcs/INSFVTKEDWallFunctionBC.h
@@ -24,7 +24,7 @@ class INSFVTKEDWallFunctionBC : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   /// the dimension of the domain

diff --git a/modules/navier_stokes/include/fvbcs/INSFVTurbulentViscosityWallFunction.h b/modules/navier_stokes/include/fvbcs/INSFVTurbulentViscosityWallFunction.h
@@ -23,7 +23,7 @@ class INSFVTurbulentViscosityWallFunction : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
 private:
   /// the dimension of the domain

diff --git a/modules/navier_stokes/include/fvbcs/WCNSFVInletTemperatureBC.h b/modules/navier_stokes/include/fvbcs/WCNSFVInletTemperatureBC.h
@@ -23,7 +23,7 @@ class WCNSFVInletTemperatureBC : public FVDirichletBCBase, public INSFVFlowBC
   WCNSFVInletTemperatureBC(const InputParameters & params);
 
 protected:
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
   /// Scaling factor
   const Real _scaling_factor;

diff --git a/modules/navier_stokes/include/fvbcs/WCNSFVInletVelocityBC.h b/modules/navier_stokes/include/fvbcs/WCNSFVInletVelocityBC.h
@@ -23,7 +23,7 @@ class WCNSFVInletVelocityBC : public FVDirichletBCBase, public INSFVFlowBC
   WCNSFVInletVelocityBC(const InputParameters & params);
 
 protected:
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
   /// Scaling factor
   const Real _scaling_factor;

diff --git a/modules/navier_stokes/include/fvbcs/WCNSFVSwitchableInletVelocityBC.h b/modules/navier_stokes/include/fvbcs/WCNSFVSwitchableInletVelocityBC.h
@@ -24,7 +24,7 @@ class WCNSFVSwitchableInletVelocityBC : public WCNSFVInletVelocityBC
   WCNSFVSwitchableInletVelocityBC(const InputParameters & params);
 
 protected:
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
   /// Boolean switch to turn boundary condition on/off
   const bool & _switch_bc;

diff --git a/modules/navier_stokes/src/fvbcs/INSFVInletIntensityTKEBC.C b/modules/navier_stokes/src/fvbcs/INSFVInletIntensityTKEBC.C
@@ -40,10 +40,9 @@ INSFVInletIntensityTKEBC::INSFVInletIntensityTKEBC(const InputParameters & param
 }
 
 ADReal
-INSFVInletIntensityTKEBC::boundaryValue(const FaceInfo & fi) const
+INSFVInletIntensityTKEBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const
 {
   const auto boundary_face = singleSidedFaceArg(&fi);
-  const auto state = determineState();
 
   ADRealVectorValue velocity(_u(boundary_face, state));
   if (_v)

diff --git a/modules/navier_stokes/src/fvbcs/INSFVMixingLengthTKEDBC.C b/modules/navier_stokes/src/fvbcs/INSFVMixingLengthTKEDBC.C
@@ -36,10 +36,9 @@ INSFVMixingLengthTKEDBC::INSFVMixingLengthTKEDBC(const InputParameters & params)
 }
 
 ADReal
-INSFVMixingLengthTKEDBC::boundaryValue(const FaceInfo & fi) const
+INSFVMixingLengthTKEDBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const
 {
   const auto boundary_face = singleSidedFaceArg(&fi);
-  const auto state = determineState();
 
   return std::pow(_C_mu(boundary_face, state), 0.75) * std::pow(_k(boundary_face, state), 1.5) /
          (0.07 * _characteristic_length(boundary_face, state));

diff --git a/modules/navier_stokes/src/fvbcs/INSFVOutletPressureBC.C b/modules/navier_stokes/src/fvbcs/INSFVOutletPressureBC.C
@@ -50,10 +50,11 @@ INSFVOutletPressureBCTempl<T>::INSFVOutletPressureBCTempl(const InputParameters
 
 template <class T>
 ADReal
-INSFVOutletPressureBCTempl<T>::boundaryValue(const FaceInfo & fi) const
+INSFVOutletPressureBCTempl<T>::boundaryValue(const FaceInfo & fi,
+                                             const Moose::StateArg & state) const
 {
   if (_functor)
-    return (*_functor)(singleSidedFaceArg(&fi), determineState());
+    return (*_functor)(singleSidedFaceArg(&fi), state);
   else if (_function)
     return _function->value(_t, fi.faceCentroid());
   else

diff --git a/modules/navier_stokes/src/fvbcs/INSFVSwitchableOutletPressureBC.C b/modules/navier_stokes/src/fvbcs/INSFVSwitchableOutletPressureBC.C
@@ -38,10 +38,11 @@ INSFVSwitchableOutletPressureBC::INSFVSwitchableOutletPressureBC(const InputPara
 }
 
 ADReal
-INSFVSwitchableOutletPressureBC::boundaryValue(const FaceInfo & fi) const
+INSFVSwitchableOutletPressureBC::boundaryValue(const FaceInfo & fi,
+                                               const Moose::StateArg & state) const
 {
   if (_switch_bc)
-    return INSFVOutletPressureBCTempl<INSFVFlowBC>::boundaryValue(fi) * _face_limiter;
+    return INSFVOutletPressureBCTempl<INSFVFlowBC>::boundaryValue(fi, state) * _face_limiter;
   else
     // The two-term expansion = false piece is critical as it prevents infinite recursion that would
     // occur with a Green-Gauss gradient calculation which would call back to this "Dirichlet"
@@ -50,6 +51,6 @@ INSFVSwitchableOutletPressureBC::boundaryValue(const FaceInfo & fi) const
                                                  /*two_term_expansion=*/false,
                                                  /*correct_skewness=*/false,
                                                  fi.elemPtr(),
-                                                 determineState()) *
+                                                 state) *
            _face_limiter;
 }
diff --git a/modules/navier_stokes/src/fvbcs/INSFVTKEDWallFunctionBC.C b/modules/navier_stokes/src/fvbcs/INSFVTKEDWallFunctionBC.C
@@ -50,11 +50,10 @@ INSFVTKEDWallFunctionBC::INSFVTKEDWallFunctionBC(const InputParameters & params)
 }
 
 ADReal
-INSFVTKEDWallFunctionBC::boundaryValue(const FaceInfo & fi) const
+INSFVTKEDWallFunctionBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const
 {
   const Real dist = std::abs((fi.elemCentroid() - fi.faceCentroid()) * fi.normal());
   const Elem & _current_elem = fi.elem();
-  const auto state = determineState();
   const auto mu = _mu(makeElemArg(&_current_elem), state);
   const auto rho = _rho(makeElemArg(&_current_elem), state);
 

diff --git a/modules/navier_stokes/src/fvbcs/INSFVTurbulentViscosityWallFunction.C b/modules/navier_stokes/src/fvbcs/INSFVTurbulentViscosityWallFunction.C
@@ -52,7 +52,8 @@ INSFVTurbulentViscosityWallFunction::INSFVTurbulentViscosityWallFunction(
 }
 
 ADReal
-INSFVTurbulentViscosityWallFunction::boundaryValue(const FaceInfo & fi) const
+INSFVTurbulentViscosityWallFunction::boundaryValue(const FaceInfo & fi,
+                                                   const Moose::StateArg & /* state */) const
 {
   const Real wall_dist = std::abs((fi.elemCentroid() - fi.faceCentroid()) * fi.normal());
   const Elem & _current_elem = fi.elem();

diff --git a/modules/navier_stokes/src/fvbcs/WCNSFVInletTemperatureBC.C b/modules/navier_stokes/src/fvbcs/WCNSFVInletTemperatureBC.C
@@ -82,9 +82,8 @@ WCNSFVInletTemperatureBC::WCNSFVInletTemperatureBC(const InputParameters & param
 }
 
 ADReal
-WCNSFVInletTemperatureBC::boundaryValue(const FaceInfo & fi) const
+WCNSFVInletTemperatureBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const
 {
-  const auto state = determineState();
 
   if (_area_pp)
     if (MooseUtils::absoluteFuzzyEqual(*_area_pp, 0))

diff --git a/modules/navier_stokes/src/fvbcs/WCNSFVInletVelocityBC.C b/modules/navier_stokes/src/fvbcs/WCNSFVInletVelocityBC.C
@@ -57,7 +57,7 @@ WCNSFVInletVelocityBC::WCNSFVInletVelocityBC(const InputParameters & params)
 }
 
 ADReal
-WCNSFVInletVelocityBC::boundaryValue(const FaceInfo & fi) const
+WCNSFVInletVelocityBC::boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const
 {
   if (_area_pp)
     if (MooseUtils::absoluteFuzzyEqual(*_area_pp, 0))
@@ -67,7 +67,7 @@ WCNSFVInletVelocityBC::boundaryValue(const FaceInfo & fi) const
     return _scaling_factor * (*_velocity_pp);
   else
   {
-    ADReal rho = (*_rho)(singleSidedFaceArg(&fi), determineState());
+    ADReal rho = (*_rho)(singleSidedFaceArg(&fi), state);
 
     return _scaling_factor * (*_mdot_pp) / (*_area_pp * rho);
   }

diff --git a/modules/navier_stokes/src/fvbcs/WCNSFVSwitchableInletVelocityBC.C b/modules/navier_stokes/src/fvbcs/WCNSFVSwitchableInletVelocityBC.C
@@ -39,10 +39,11 @@ WCNSFVSwitchableInletVelocityBC::WCNSFVSwitchableInletVelocityBC(const InputPara
 }
 
 ADReal
-WCNSFVSwitchableInletVelocityBC::boundaryValue(const FaceInfo & fi) const
+WCNSFVSwitchableInletVelocityBC::boundaryValue(const FaceInfo & fi,
+                                               const Moose::StateArg & state) const
 {
   if (_switch_bc)
-    return WCNSFVInletVelocityBC::boundaryValue(fi) * _face_limiter;
+    return WCNSFVInletVelocityBC::boundaryValue(fi, state) * _face_limiter;
   else
     // The two-term expansion = false piece is critical as it prevents infinite recursion that would
     // occur with a Green-Gauss gradient calculation which would call back to this "Dirichlet"
@@ -51,6 +52,6 @@ WCNSFVSwitchableInletVelocityBC::boundaryValue(const FaceInfo & fi) const
                                                  /*two_term_expansion=*/false,
                                                  /*correct_skewness=*/false,
                                                  fi.elemPtr(),
-                                                 determineState()) *
+                                                 state) *
            _face_limiter;
 }
diff --git a/test/include/fvbcs/FVUseFunctorSideForSsfDirichletBC.h b/test/include/fvbcs/FVUseFunctorSideForSsfDirichletBC.h
@@ -19,7 +19,7 @@ class FVUseFunctorSideForSsfDirichletBCTempl : public FVDirichletBCBase
 
   static InputParameters validParams();
 
-  ADReal boundaryValue(const FaceInfo & fi) const override;
+  ADReal boundaryValue(const FaceInfo & fi, const Moose::StateArg & state) const override;
 
   bool hasFaceSide(const FaceInfo & fi, bool fi_elem_side) const override;
 

diff --git a/test/src/fvbcs/FVUseFunctorSideForSsfDirichletBC.C b/test/src/fvbcs/FVUseFunctorSideForSsfDirichletBC.C
@@ -33,10 +33,10 @@ FVUseFunctorSideForSsfDirichletBCTempl<is_ad>::FVUseFunctorSideForSsfDirichletBC
 
 template <bool is_ad>
 ADReal
-FVUseFunctorSideForSsfDirichletBCTempl<is_ad>::boundaryValue(const FaceInfo & fi) const
+FVUseFunctorSideForSsfDirichletBCTempl<is_ad>::boundaryValue(const FaceInfo & fi,
+                                                             const Moose::StateArg & state) const
 {
-  return _functor(makeFace(fi, Moose::FV::LimiterType::CentralDifference, true, false),
-                  Moose::currentState());
+  return _functor(makeFace(fi, Moose::FV::LimiterType::CentralDifference, true, false), state);
 }
 
 template <bool is_ad>