Rephrasing 'defined species' to 'specified species'

shannon-lab · Jan 2, 2024 · 323da7d · 323da7d
1 parent 1a879eb
commit 323da7d
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 6 deletions.
diff --git a/src/auxkernels/AbsValueAux.C b/src/auxkernels/AbsValueAux.C
@@ -17,7 +17,7 @@ AbsValueAux::validParams()
 {
   InputParameters params = AuxKernel::validParams();
   params.addRequiredCoupledVar("u", "Variable we want absolute value of.");
-  params.addClassDescription("Returns the absolute value of variable");
+  params.addClassDescription("Returns the absolute value of the specified variable");
   return params;
 }
 

diff --git a/src/auxkernels/Current.C b/src/auxkernels/Current.C
@@ -31,7 +31,7 @@ CurrentTempl<is_ad>::validParams()
       "art_diff", false, "Whether there is a current contribution from artificial diffusion.");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addClassDescription(
-      "Returns the electric current associated with the flux of defined species");
+      "Returns the electric current associated with the flux of the specified species");
   return params;
 }
 

diff --git a/src/auxkernels/DiffusiveFlux.C b/src/auxkernels/DiffusiveFlux.C
@@ -25,7 +25,7 @@ DiffusiveFluxTempl<is_ad>::validParams()
   params.addRequiredCoupledVar("density_log", "The variable representing the log of the density.");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addParam<int>("component", 0, "The component of position. (0 = x, 1 = y, 2 = z)");
-  params.addClassDescription("Returns the diffusive flux of defined species");
+  params.addClassDescription("Returns the diffusive flux of the specified species");
   return params;
 }
 

diff --git a/src/auxkernels/DriftDiffusionFluxAux.C b/src/auxkernels/DriftDiffusionFluxAux.C
@@ -24,7 +24,7 @@ DriftDiffusionFluxAux::validParams()
                         "negative.");
   params.addRequiredCoupledVar("u", "The drift-diffusing species.");
   params.addParam<int>("component", 0, "The flux component you want to see.");
-  params.addClassDescription("Returns the drift-diffusion flux of defined species");
+  params.addClassDescription("Returns the drift-diffusion flux of the specified species");
   return params;
 }
 

diff --git a/src/auxkernels/EFieldAdvAux.C b/src/auxkernels/EFieldAdvAux.C
@@ -27,7 +27,8 @@ EFieldAdvAuxTempl<is_ad>::validParams()
   params.addRequiredCoupledVar("density_log", "The variable representing the log of the density.");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addParam<int>("component", 0, "The component the EField Vector. (0 = x, 1 = y, 2 = z)");
-  params.addClassDescription("Returns the electric field driven advective flux of defined species");
+  params.addClassDescription(
+      "Returns the electric field driven advective flux of the specified species");
   return params;
 }
 

diff --git a/src/auxkernels/TotalFlux.C b/src/auxkernels/TotalFlux.C
@@ -27,7 +27,7 @@ TotalFluxTempl<is_ad>::validParams()
   params.addRequiredCoupledVar("potential", "The potential");
   params.addParam<int>(
       "component", 0, "The component of the TotalFlux vector. (0 = x, 1 = y, 2 = z)");
-  params.addClassDescription("Returns the total flux of defined species");
+  params.addClassDescription("Returns the total flux of the specified species");
 
   return params;
 }