Merge pull request #28734 from hugary1995/solid_mechanics_sqa

Make solid_mechanics moosedocs check clean

modules/solid_mechanics/doc/content/syntax/Modules/index.md

@@ -0,0 +1,3 @@
+This is a placeholder for the actual `Modules` syntax for allowing modules syntax to
+build correctly. The actual content explaining the `Modules` block is defined in
+`Modules/TensorMechanics/index.md`.

modules/solid_mechanics/doc/sqa_reports.yml

@@ -27,14 +27,11 @@ Documents:
     software_library_list: sqa/solid_mechanics_sll.md
     communication_and_contact_information: sqa/framework_cci.md
     software_coding_standards: sqa/framework_scs.md
-    log_user_manual: WARNING
-    log_theory_manual: WARNING
+    user_manual: content/modules/solid_mechanics/index.md
+    theory_manual: content/modules/solid_mechanics/index.md
 
 Requirements:
     solid_mechanics:
         directories:
             - ${MOOSE_DIR}/modules/solid_mechanics
-        log_duplicate_requirement: WARNING
         log_missing: WARNING
-        log_empty_issues: WARNING
-        log_testable: WARNING

modules/solid_mechanics/src/bcs/DashpotBC.C

@@ -15,7 +15,9 @@ InputParameters
 DashpotBC::validParams()
 {
   InputParameters params = IntegratedBC::validParams();
-  params.addClassDescription("Imposes a viscous friction stress, proportional to the velocity");
+  params.addClassDescription(
+      "Model a dashpot boundary condition where the traction is proportional "
+      "to the normal velocity.");
   params.addRequiredParam<unsigned int>(
       "component", "The displacement component corresponding the variable this BC acts on.");
   params.addRequiredCoupledVar("disp_x", "Displacement in the x direction");

modules/solid_mechanics/src/interfacekernels/CZMInterfaceKernelTotalLagrangian.C

@@ -15,8 +15,8 @@ InputParameters
 CZMInterfaceKernelTotalLagrangian::validParams()
 {
   InputParameters params = CZMInterfaceKernelBase::validParams();
-  params.addClassDescription(
-      "Assembles the integrated first Piola-Kirchhoff traction computed by a cohesive zone model");
+  params.addClassDescription("Calculate residual contribution for balancing the traction across an "
+                             "interface (used in the cohesive zone method).");
   params.set<std::string>("traction_global_name") = "PK1traction";
   return params;
 }

modules/solid_mechanics/src/kernels/MomentBalancing.C

@@ -23,8 +23,8 @@ InputParameters
 MomentBalancing::validParams()
 {
   InputParameters params = Kernel::validParams();
-  params.addClassDescription("Additional term for moment balance of the in-plane components in the "
-                             "Cosserat layered elasticity model");
+  params.addClassDescription("Balance of momentum for three-dimensional Cosserat media, notably in "
+                             "a Cosserat layered elasticity model.");
   params.addRequiredRangeCheckedParam<unsigned int>(
       "component",
       "component<3",

modules/solid_mechanics/src/materials/DensityScaling.C

@@ -17,8 +17,8 @@ InputParameters
 DensityScaling::validParams()
 {
   InputParameters params = Material::validParams();
-  params.addClassDescription("Creates an additional density scaling term to allow for larger time "
-                             "steps for specific time integration schemes");
+  params.addClassDescription("Automatically scale the material density to achieve the desired time "
+                             "step size to satisfy CFL conditions.");
   params.addRequiredParam<MaterialPropertyName>(
       "density",
       "Name of Material Property or a constant real number defining the density of the material.");

modules/solid_mechanics/src/materials/InclusionProperties.C

@@ -16,8 +16,8 @@ InputParameters
 InclusionProperties::validParams()
 {
   InputParameters params = Material::validParams();
-  params.addClassDescription(
-      "Computes analytical stress, strain and elastic energy terms for an elliptic inclusion");
+  params.addClassDescription("Calculate quantities used to define the analytical elasticity "
+                             "solution to the inclusion problem.");
   params.addRequiredParam<Real>("a", "Ellipse semiaxis");
   params.addRequiredParam<Real>("b", "Ellipse semiaxis");
   params.addRequiredParam<Real>("lambda", "Lame's first parameter");

modules/solid_mechanics/src/materials/WaveSpeed.C

@@ -21,8 +21,8 @@ InputParameters
 WaveSpeed::validParams()
 {
   InputParameters params = Material::validParams();
-  params.addClassDescription(
-      "Computes an approximate wave speed from the material stiffness and density");
+  params.addClassDescription("Calculate the wave speed as $E / \\sqrt{\\rho}$ where $E$ is the "
+                             "effective stiffness, and $\\rho$ is the material density.");
   params.addParam<std::string>("base_name",
                                "Optional parameter that allows the user to define "
                                "multiple mechanics material systems on the same "

modules/solid_mechanics/src/materials/lagrangian/ComputeHomogenizedLagrangianStrain.C

@@ -15,8 +15,8 @@ InputParameters
 ComputeHomogenizedLagrangianStrain::validParams()
 {
   InputParameters params = Material::validParams();
-  params.addClassDescription("Sets the homogenization gradient as a material property from an "
-                             "auxiliary variable input gradient");
+  params.addClassDescription("Calculate eigenstrain-like contribution from the homogenization "
+                             "strain used to satisfy the homogenization constraints.");
   params.addParam<std::string>("base_name", "Material property base name");
   params.addRequiredParam<UserObjectName>(
       "homogenization_constraint", "The UserObject for defining the homogenization constraint");

modules/solid_mechanics/src/scalarkernels/lagrangian/HomogenizationConstraintScalarKernel.C

@@ -29,8 +29,8 @@ InputParameters
 HomogenizationConstraintScalarKernel::validParams()
 {
   InputParameters params = ScalarKernel::validParams();
-  params.addClassDescription("Retrieves the residual and Jacobian contribution from the "
-                             "homogenization constraint user object");
+  params.addClassDescription("Calculate the scalar equation residual and Jacobian associated with "
+                             "the homogenization constraint.");
   params.addRequiredParam<UserObjectName>("homogenization_constraint",
                                           "The UserObject defining the homogenization constraint");
 

modules/solid_mechanics/src/userobjects/StepUserObject.C

@@ -17,8 +17,11 @@ InputParameters
 StepUserObject::validParams()
 {
   InputParameters params = GeneralUserObject::validParams();
-  params.addClassDescription("Maps the time steps and the load step simulation times. It can be "
-                             "used in either direction depending on the simulation setup");
+  params.addClassDescription(
+      "Maps the time steps and the load step simulation times. It can be "
+      "used in either direction depending on the simulation setup. It "
+      "generates steps to be used in StepPeriod to control the enabled/disabled state of objects "
+      "with user-provided simulation steps.");
   params.addParam<std::vector<Real>>(
       "step_start_times",
       "The beginning of step times. The number of steps is inferred from the number of times. One "

modules/solid_mechanics/src/userobjects/lagrangian/HomogenizationConstraint.C

@@ -26,7 +26,8 @@ InputParameters
 HomogenizationConstraint::validParams()
 {
   InputParameters params = ElementUserObject::validParams();
-  params.addClassDescription("Computes a volumetric homogenization constraint");
+  params.addClassDescription("Calculate element contribution to the homogenization constraint "
+                             "depending on the homogenization constraint type.");
   params.addRequiredParam<MultiMooseEnum>(
       "constraint_types",
       Homogenization::constraintType,