Address Guillaume review

- Fix typos - Remove unnecessary include - Better class descriptions - Remove unnecessary design specification Co-authored-by: Guillaume Giudicelli <guillaume.giudicelli@gmail.com>
oanaoana · Oct 19, 2023 · 30a14e6 · 30a14e6
1 parent ff1fb60
commit 30a14e6
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/framework/doc/content/source/kernels/ADConservativeAdvection.md b/framework/doc/content/source/kernels/ADConservativeAdvection.md
@@ -10,7 +10,7 @@ The `ADConservativeAdvection` kernel implements the same advection term as
   propagation of derivatives for automatic differentiation
 - No upwinding option is currently implemented. In that vein this object may be
   best used within a discontinuous Galerkin scheme with [ADDGConvection.md].
-- A [!param](/Kernels/ADConservativeAdvection/advected_quantity) paramter is
+- A [!param](/Kernels/ADConservativeAdvection/advected_quantity) parameter is
   available which allows for advecting different quantities than the `variable`
   this object is acting upon
 

diff --git a/framework/src/bcs/ADConservativeAdvectionBC.C b/framework/src/bcs/ADConservativeAdvectionBC.C
@@ -22,7 +22,9 @@ ADConservativeAdvectionBC::validParams()
       "to be determined implicitly (e.g. we don't have a Dirichlet condition)");
   params.addParam<FunctionName>("velocity_function",
                                 "Function describing the values of velocity on the boundary.");
-  params.addClassDescription("DG for convection");
+  params.addClassDescription(
+      "Boundary condition for advection when it is integrated by parts. Supports Dirichlet "
+      "(inlet-like) and implicit (outlet-like) conditions.");
   params.addParam<MaterialPropertyName>("advected_quantity",
                                         "An optional material property to be advected. If not "
                                         "supplied, then the variable will be used.");

diff --git a/framework/src/dgkernels/ADDGConvection.C b/framework/src/dgkernels/ADDGConvection.C
@@ -16,7 +16,8 @@ ADDGConvection::validParams()
 {
   InputParameters params = ADDGKernel::validParams();
   params.addRequiredParam<MaterialPropertyName>("velocity", "Velocity vector");
-  params.addClassDescription("DG for convection");
+  params.addClassDescription(
+      "Adds internal face advection flux contributions for discontinuous Galerkin discretizations");
   params.addParam<MaterialPropertyName>("advected_quantity",
                                         "An optional material property to be advected. If not "
                                         "supplied, then the variable will be used.");

diff --git a/framework/src/kernels/ADConservativeAdvection.C b/framework/src/kernels/ADConservativeAdvection.C
@@ -8,7 +8,6 @@
 //* https://www.gnu.org/licenses/lgpl-2.1.html
 
 #include "ADConservativeAdvection.h"
-#include "SystemBase.h"
 
 registerMooseObject("MooseApp", ADConservativeAdvection);
 

diff --git a/test/tests/dgkernels/passive-scalar-channel-flow/tests b/test/tests/dgkernels/passive-scalar-channel-flow/tests
@@ -1,6 +1,6 @@
 [Tests]
   issues = '#24055'
-  design = 'ADConservativeAdvection.md ADDGConvection.md ADConservativeAdvectionBC.md MatDiffusion.md DGDiffusion.md DGFunctionDiffusionDirichletBC.md VectorFromVariableComponentsMaterial.md'
+  design = 'ADConservativeAdvection.md ADDGConvection.md ADConservativeAdvectionBC.md MatDiffusion.md DGDiffusion.md DGFunctionDiffusionDirichletBC.md'
   [test]
     type = Exodiff
     input = test.i