Apply suggestions from code review ref idaholab#21258

Co-authored-by: Guillaume Giudicelli <guillaume.giudicelli@gmail.com>
crb3874 · Jun 27, 2022 · 44a1074 · 44a1074
1 parent 636038d
commit 44a1074
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 36 deletions.
diff --git a/...rk/doc/content/source/userobject/NearestPointLayeredSideDiffusiveFluxAverage.md b/...rk/doc/content/source/userobject/NearestPointLayeredSideDiffusiveFluxAverage.md
@@ -0,0 +1,16 @@
+# NearestPointLayeredSideDiffusiveFluxAverage
+
+The domain is virtually divided into a number of layered subdivision according
+to the nearest points and the layering direction provided by users. And then
+the layered side average diffusive flux is computed for the sides on each
+individual subdivision separately.
+
+!syntax description /UserObjects/NearestPointLayeredSideDiffusiveFluxAverage
+
+!syntax parameters /UserObjects/NearestPointLayeredSideDiffusiveFluxAverage
+
+!syntax inputs /UserObjects/NearestPointLayeredSideDiffusiveFluxAverage
+
+!syntax children /UserObjects/NearestPointLayeredSideDiffusiveFluxAverage
+
+!bibtex bibliography
diff --git a/framework/doc/content/source/userobject/NearestPointLayeredSideFluxAverage.md b/framework/doc/content/source/userobject/NearestPointLayeredSideFluxAverage.md
diff --git a/...ject/NearestPointLayeredSideFluxAverage.h → ...estPointLayeredSideDiffusiveFluxAverage.h b/...ject/NearestPointLayeredSideFluxAverage.h → ...estPointLayeredSideDiffusiveFluxAverage.h
@@ -21,11 +21,11 @@
  * Given a list of points this object computes the layered average flux
  * closest to each one of those points.
  */
-class NearestPointLayeredSideFluxAverage
+class NearestPointLayeredSideDiffusiveFluxAverage
   : public NearestPointBase<LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject>
 {
 public:
   static InputParameters validParams();
 
-  NearestPointLayeredSideFluxAverage(const InputParameters & parameters);
+  NearestPointLayeredSideDiffusiveFluxAverage(const InputParameters & parameters);
 };
diff --git a/...ject/NearestPointLayeredSideFluxAverage.C → ...estPointLayeredSideDiffusiveFluxAverage.C b/...ject/NearestPointLayeredSideFluxAverage.C → ...estPointLayeredSideDiffusiveFluxAverage.C
@@ -7,24 +7,28 @@
 //* Licensed under LGPL 2.1, please see LICENSE for details
 //* https://www.gnu.org/licenses/lgpl-2.1.html
 
-#include "NearestPointLayeredSideFluxAverage.h"
+#include "NearestPointLayeredSideDiffusiveFluxAverage.h"
 #include "LayeredSideDiffusiveFluxAverage.h"
 
-registerMooseObject("MooseApp", NearestPointLayeredSideFluxAverage);
+registerMooseObject("MooseApp", NearestPointLayeredSideDiffusiveFluxAverage);
+registerMooseObjectRenamed("MooseApp",
+                           NearestPointLayeredSideFluxAverage,
+                           "12/31/2022 24:00",
+                           NearestPointLayeredSideDiffusiveFluxAverage);
 
 InputParameters
-NearestPointLayeredSideFluxAverage::validParams()
+NearestPointLayeredSideDiffusiveFluxAverage::validParams()
 {
   InputParameters params = NearestPointBase<LayeredSideDiffusiveFluxAverage,
                                             SideIntegralVariableUserObject>::validParams();
 
   params.addClassDescription(
-      "Compute layered side flux averages for nearest-point based subdomains");
+      "Compute layered side diffusive flux averages for nearest-point based subdivisions");
 
   return params;
 }
 
-NearestPointLayeredSideFluxAverage::NearestPointLayeredSideFluxAverage(
+NearestPointLayeredSideDiffusiveFluxAverage::NearestPointLayeredSideDiffusiveFluxAverage(
     const InputParameters & parameters)
   : NearestPointBase<LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject>(parameters)
 {

diff --git a/..._side_diffusive_flux_average/gold/nearest_point_layered_side_diffusive_flux_average_out.e b/..._side_diffusive_flux_average/gold/nearest_point_layered_side_diffusive_flux_average_out.e
diff --git a/...nearest_point_layered_side_flux_average.i → ...int_layered_side_diffusive_flux_average.i b/...nearest_point_layered_side_flux_average.i → ...int_layered_side_diffusive_flux_average.i
@@ -1,9 +1,9 @@
 [Mesh]
   type = GeneratedMesh
   dim = 3
-  nx = 40
-  ny = 10
-  nz = 10
+  nx = 10
+  ny = 4
+  nz = 4
 []
 
 [Variables]
@@ -37,7 +37,7 @@
 
 [UserObjects]
   [./nplsfa]
-    type = NearestPointLayeredSideFluxAverage
+    type = NearestPointLayeredSideDiffusiveFluxAverage
     direction = x
     points='0.25 0 0.25 0.75 0 0.25 0.25 0 0.75 0.75 0 0.75'
     num_layers = 10

diff --git a/test/tests/userobjects/nearest_point_layered_side_diffusive_flux_average/tests b/test/tests/userobjects/nearest_point_layered_side_diffusive_flux_average/tests
@@ -0,0 +1,10 @@
+[Tests]
+  [./test]
+    type = 'Exodiff'
+    input = 'nearest_point_layered_side_diffusive_flux_average.i'
+    exodiff = 'nearest_point_layered_side_diffusive_flux_average_out.e'
+    requirement = 'The system shall compute layered side averages of the diffusive flux that are computed based on the flux values closest to a list of points'
+    design = 'NearestPointLayeredSideDiffusiveFluxAverage.md'
+    issues = '#21258'
+  [../]
+[]
diff --git a/...earest_point_layered_side_flux_average/gold/nearest_point_layered_side_flux_average_out.e b/...earest_point_layered_side_flux_average/gold/nearest_point_layered_side_flux_average_out.e
diff --git a/test/tests/userobjects/nearest_point_layered_side_flux_average/tests b/test/tests/userobjects/nearest_point_layered_side_flux_average/tests