SQA: add missing class descriptions

Refs idaholab#73
cticenhour · Oct 10, 2023 · 365fd62 · 365fd62
1 parent e1c19b4
commit 365fd62
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 0 deletions.
diff --git a/src/bcs/GaussianWeldEnergyFluxBC.C b/src/bcs/GaussianWeldEnergyFluxBC.C
@@ -16,6 +16,8 @@ InputParameters
 GaussianWeldEnergyFluxBC::validParams()
 {
   InputParameters params = ADIntegratedBC::validParams();
+  params.addClassDescription("Calculates the boundary condition residual contribution of the heat "
+                             "flux of a Gaussian laser beam impinging on a surface.");
   params.addRequiredParam<Real>("reff",
                                 "The effective radius describing the radial distribution of the "
                                 "beam energy. This should be non-dimensional.");

diff --git a/src/indicators/AbsoluteValueIndicator.C b/src/indicators/AbsoluteValueIndicator.C
@@ -16,6 +16,8 @@ InputParameters
 AbsoluteValueIndicator::validParams()
 {
   InputParameters params = ElementIntegralIndicator::validParams();
+  params.addClassDescription(
+      "Compute the absolute value of the provided variable for use as an error indicator.");
   return params;
 }
 

diff --git a/src/kernels/ADStressDivergence.C b/src/kernels/ADStressDivergence.C
@@ -15,6 +15,8 @@ InputParameters
 ADStressDivergence::validParams()
 {
   InputParameters params = ADKernel::validParams();
+  params.addClassDescription(
+      "Computes a stress divergence term for a given displacement component.");
   params.addRequiredParam<int>("component", "The displacement component");
   return params;
 }

diff --git a/src/materials/CrazyKCPlantFits.C b/src/materials/CrazyKCPlantFits.C
@@ -15,6 +15,7 @@ InputParameters
 CrazyKCPlantFits::validParams()
 {
   InputParameters params = ADMaterial::validParams();
+  params.addClassDescription("Material properties corresponding to KC plant reference material.");
   params.addParam<Real>("c_mu0", 0.15616, "mu0 coefficient");
   params.addParam<Real>("c_mu1", -3.3696e-5, "mu1 coefficient");
   params.addParam<Real>("c_mu2", 1.0191e-8, "mu2 coefficient");

diff --git a/src/materials/CrazyKCPlantFitsBoundary.C b/src/materials/CrazyKCPlantFitsBoundary.C
@@ -16,6 +16,8 @@ InputParameters
 CrazyKCPlantFitsBoundary::validParams()
 {
   InputParameters params = ADMaterial::validParams();
+  params.addClassDescription(
+      "Boundary material properties corresponding to KC plant reference material.");
   params.addParam<Real>("c_mu0", 0.15616, "mu0 coefficient");
   params.addParam<Real>("ap0", 0, "");
   params.addParam<Real>("ap1", 1.851502e1, "");

diff --git a/src/materials/PseudoSolidStress.C b/src/materials/PseudoSolidStress.C
@@ -15,6 +15,8 @@ InputParameters
 PseudoSolidStress::validParams()
 {
   InputParameters params = ADMaterial::validParams();
+  params.addClassDescription(
+      "Calculates a pseudo solid stress property based on coupled displacements.");
   params.addRequiredCoupledVar("disp_x", "The x displacement");
   params.addCoupledVar("disp_y", "The y displacement");
   params.addCoupledVar("disp_z", "The z displacement");