From 323da7dd4d33cd7860a2c58308f7fe984640f90d Mon Sep 17 00:00:00 2001 From: Corey Date: Tue, 2 Jan 2024 16:38:29 -0500 Subject: [PATCH] Rephrasing 'defined species' to 'specified species' --- src/auxkernels/AbsValueAux.C | 2 +- src/auxkernels/Current.C | 2 +- src/auxkernels/DiffusiveFlux.C | 2 +- src/auxkernels/DriftDiffusionFluxAux.C | 2 +- src/auxkernels/EFieldAdvAux.C | 3 ++- src/auxkernels/TotalFlux.C | 2 +- 6 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/auxkernels/AbsValueAux.C b/src/auxkernels/AbsValueAux.C index f007530d8c0e..0702a4b225d9 100644 --- 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 index a57b7540b323..b2b734847e1b 100644 --- a/src/auxkernels/Current.C +++ b/src/auxkernels/Current.C @@ -31,7 +31,7 @@ CurrentTempl::validParams() "art_diff", false, "Whether there is a current contribution from artificial diffusion."); params.addRequiredParam("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 index f5ad07131a51..7cbd59b71276 100644 --- a/src/auxkernels/DiffusiveFlux.C +++ b/src/auxkernels/DiffusiveFlux.C @@ -25,7 +25,7 @@ DiffusiveFluxTempl::validParams() params.addRequiredCoupledVar("density_log", "The variable representing the log of the density."); params.addRequiredParam("position_units", "Units of position."); params.addParam("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 index e6bc871dfdb3..697f88171e43 100644 --- 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("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 index 571895ef2f69..c67aba2ab5eb 100644 --- a/src/auxkernels/EFieldAdvAux.C +++ b/src/auxkernels/EFieldAdvAux.C @@ -27,7 +27,8 @@ EFieldAdvAuxTempl::validParams() params.addRequiredCoupledVar("density_log", "The variable representing the log of the density."); params.addRequiredParam("position_units", "Units of position."); params.addParam("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 index a4d64aac7e28..1d67493ba7e4 100644 --- a/src/auxkernels/TotalFlux.C +++ b/src/auxkernels/TotalFlux.C @@ -27,7 +27,7 @@ TotalFluxTempl::validParams() params.addRequiredCoupledVar("potential", "The potential"); params.addParam( "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; }