From 43435c5a9d37f73308b93225af96e215a995d5ac Mon Sep 17 00:00:00 2001 From: Matthew Falcone Date: Fri, 10 Jan 2025 11:36:38 +0000 Subject: [PATCH] Improvements to doc strings --- src/auxkernels/TimeAverageAux.C | 6 +++--- src/auxkernels/VectorTimeAverageAux.C | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/auxkernels/TimeAverageAux.C b/src/auxkernels/TimeAverageAux.C index 538c57d..c39a2a0 100644 --- a/src/auxkernels/TimeAverageAux.C +++ b/src/auxkernels/TimeAverageAux.C @@ -7,10 +7,10 @@ TimeAverageAux::validParams() { InputParameters params = AuxKernel::validParams(); - params.addClassDescription("AuxKernel that performs time averaging of variables." - ""); + params.addClassDescription("AuxKernel that performs time averaging of variables."); params.addRequiredCoupledVar("scalars", - "Scalar variables to be averaged"); + "Scalar variables to be averaged. If multiple scalars are " + "given the average of their product is given"); return params; } TimeAverageAux::TimeAverageAux(const InputParameters & parameters) diff --git a/src/auxkernels/VectorTimeAverageAux.C b/src/auxkernels/VectorTimeAverageAux.C index 4330eb4..dfca058 100644 --- a/src/auxkernels/VectorTimeAverageAux.C +++ b/src/auxkernels/VectorTimeAverageAux.C @@ -13,10 +13,12 @@ VectorTimeAverageAux::validParams() params.addRequiredCoupledVar("vectors", "Vector variables to be time averaged." "If multiple vectors are provided the average of their " - "scalar multiplication is given. "); + "component-wise multiplication is given. "); params.addCoupledVar("scalars", - "Scalar variables to be included in the time average."); + "Scalar variables to be included in the time average. " + "If scalars are are given the average of their product with the vector " + "averages is given"); return params; } VectorTimeAverageAux::VectorTimeAverageAux(const InputParameters & parameters)