Added vector version of NaNInterface::getNaN

Refs #12234
idaholab · Apr 24, 2020 · bffd8c9 · bffd8c9
1 parent 82245fb
commit bffd8c9
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 4 deletions.
diff --git a/modules/fluid_properties/include/interfaces/NaNInterface.h b/modules/fluid_properties/include/interfaces/NaNInterface.h
@@ -40,10 +40,23 @@ class NaNInterface
   const enum NaNMessage _emit_on_nan;
 
   /**
-   * Produces errors, warnings, or just quiet NaNs
+   * Throws an error or returns a NaN with or without a warning, with a default message
    */
   Real getNaN() const { return getNaN("A NaN was produced."); }
 
+  /**
+   * Throws an error or returns NaNs with or without a warning, with a default message
+   *
+   * @param[in] n   Vector size
+   */
+  std::vector<Real> getNaNVector(const unsigned int & n) const
+  {
+    return getNaNVector(n, "A NaN was produced.");
+  }
+
+  /**
+   * Throws an error or returns a NaN with or without a warning
+   */
   template <typename... Args>
   Real getNaN(Args &&... args) const
   {
@@ -61,4 +74,27 @@ class NaNInterface
     // return a quiet NaN
     return std::nan("");
   }
+
+  /**
+   * Throws an error or returns NaNs with or without a warning
+   *
+   * @param[in] n   Vector size
+   */
+  template <typename... Args>
+  std::vector<Real> getNaNVector(const unsigned int & n, Args &&... args) const
+  {
+    switch (_emit_on_nan)
+    {
+      case (NAN_MESSAGE_WARNING):
+        mooseWarning(_moose_object->name(), ": ", std::forward<Args>(args)...);
+        break;
+      case (NAN_MESSAGE_ERROR):
+        mooseError(_moose_object->name(), ": ", std::forward<Args>(args)...);
+        break;
+      default:
+        break;
+    }
+    // return quiet NaNs
+    return std::vector<Real>(n, std::nan(""));
+  }
 };
diff --git a/modules/fluid_properties/test/include/userobjects/NaNInterfaceTestFluidProperties.h b/modules/fluid_properties/test/include/userobjects/NaNInterfaceTestFluidProperties.h
@@ -26,5 +26,10 @@ class NaNInterfaceTestFluidProperties : public SinglePhaseFluidProperties, publi
 
   virtual Real p_from_v_e(Real v, Real e) const override;
   virtual void p_from_v_e(Real v, Real e, Real & p, Real & dp_dv, Real & dp_de) const override;
+
+  /**
+   * Returns a NaN vector of size 2
+   */
+  std::vector<Real> returnNaNVector() const;
 };
 #pragma GCC diagnostic pop
diff --git a/modules/fluid_properties/test/src/kernels/NaNInterfaceTestKernel.C b/modules/fluid_properties/test/src/kernels/NaNInterfaceTestKernel.C
@@ -19,6 +19,7 @@ NaNInterfaceTestKernel::validParams()
 
   params.addRequiredParam<UserObjectName>("nan_interface_test_fp",
                                           "NaNInterfaceTestFluidProperties user object name");
+  params.addParam<bool>("test_vector_version", false, "Test getNaNVector? Else, test getNaN");
 
   params.addClassDescription("Kernel to test NaNInterface using NaNInterfaceTestFluidProperties");
 
@@ -34,5 +35,11 @@ NaNInterfaceTestKernel::NaNInterfaceTestKernel(const InputParameters & parameter
 Real
 NaNInterfaceTestKernel::computeQpResidual()
 {
-  return _nan_interface_test_fp.p_from_v_e(0, 0);
+  if (getParam<bool>("test_vector_version"))
+  {
+    const std::vector<Real> nan_vector = _nan_interface_test_fp.returnNaNVector();
+    return nan_vector[0];
+  }
+  else
+    return _nan_interface_test_fp.p_from_v_e(0, 0);
 }
diff --git a/modules/fluid_properties/test/src/userobjects/NaNInterfaceTestFluidProperties.C b/modules/fluid_properties/test/src/userobjects/NaNInterfaceTestFluidProperties.C
@@ -33,3 +33,9 @@ void
 NaNInterfaceTestFluidProperties::p_from_v_e(Real, Real, Real &, Real &, Real &) const
 {
 }
+
+std::vector<Real>
+NaNInterfaceTestFluidProperties::returnNaNVector() const
+{
+  return getNaNVector(2);
+}
diff --git a/modules/fluid_properties/test/tests/interfaces/nan_interface/tests b/modules/fluid_properties/test/tests/interfaces/nan_interface/tests
@@ -1,13 +1,26 @@
 [Tests]
-  [./quiet_nan]
+  [./quiet_nan_scalar]
     type = 'RunException'
     input = 'nan_interface.i'
     cli_args = 'Modules/FluidProperties/fp/emit_on_nan=warning'
     allow_test_objects = True
     method = 'DBG'
     threading = '!pthreads'
 
-    requirement = 'The system should produce a warning when a NaN is produced and user required that the execution would not terminate'
+    requirement = 'The system should produce a warning when a scalar NaN is produced and user required that the execution would not terminate'
+    expect_err = "fp: A NaN was produced."
+    design = '/NaNInterface.md'
+    issues = '#12234 #12350'
+  [../]
+  [./quiet_nan_vector]
+    type = 'RunException'
+    input = 'nan_interface.i'
+    cli_args = 'Modules/FluidProperties/fp/emit_on_nan=warning Kernels/test_kernel/test_vector_version=true'
+    allow_test_objects = True
+    method = 'DBG'
+    threading = '!pthreads'
+
+    requirement = 'The system should produce a warning when a vector NaN is produced and user required that the execution would not terminate'
     expect_err = "fp: A NaN was produced."
     design = '/NaNInterface.md'
     issues = '#12234 #12350'