Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various SQA improvements #107

Merged
merged 14 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coverage
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
# - warn_new: Warns below this percentage of coverage for new lines added

[default]
require_total = 65
require_total = 69
warn_new = 90
10 changes: 2 additions & 8 deletions doc/content/source/bcs/DisplaceBoundaryBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# DisplaceBoundaryBC

!alert construction title=Undocumented Class
The DisplaceBoundaryBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/DisplaceBoundaryBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the DisplaceBoundaryBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the DisplaceBoundaryBC object.
!listing cold-no-surface-tension.i block=BCs/displace_x_top

!syntax parameters /BCs/DisplaceBoundaryBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/bcs/GaussianWeldEnergyFluxBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# GaussianWeldEnergyFluxBC

!alert construction title=Undocumented Class
The GaussianWeldEnergyFluxBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/GaussianWeldEnergyFluxBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the GaussianWeldEnergyFluxBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the GaussianWeldEnergyFluxBC object.
!listing cold-no-surface-tension.i block=BCs/weld_flux

!syntax parameters /BCs/GaussianWeldEnergyFluxBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# PenaltyDisplaceBoundaryBC

!alert construction title=Undocumented Class
The PenaltyDisplaceBoundaryBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/PenaltyDisplaceBoundaryBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the PenaltyDisplaceBoundaryBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the PenaltyDisplaceBoundaryBC object.
!listing 3d-scaled-1st-order.i block=BCs/displace_x_top

!syntax parameters /BCs/PenaltyDisplaceBoundaryBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/bcs/RadiationEnergyFluxBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# RadiationEnergyFluxBC

!alert construction title=Undocumented Class
The RadiationEnergyFluxBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/RadiationEnergyFluxBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the RadiationEnergyFluxBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the RadiationEnergyFluxBC object.
!listing cold-no-surface-tension.i block=BCs/radiation_flux

!syntax parameters /BCs/RadiationEnergyFluxBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/bcs/SurfaceTensionBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# SurfaceTensionBC

!alert construction title=Undocumented Class
The SurfaceTensionBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/SurfaceTensionBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the SurfaceTensionBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the SurfaceTensionBC object.
!listing 3d-scaled-1st-order.i block=BCs/surface_x

!syntax parameters /BCs/SurfaceTensionBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# VaporRecoilPressureMomentumFluxBC

!alert construction title=Undocumented Class
The VaporRecoilPressureMomentumFluxBC has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /BCs/VaporRecoilPressureMomentumFluxBC

## Overview
!! ## Overview

!! Replace these lines with information regarding the VaporRecoilPressureMomentumFluxBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the VaporRecoilPressureMomentumFluxBC object.
!listing cold-no-surface-tension.i block=BCs/vapor_recoil_x

!syntax parameters /BCs/VaporRecoilPressureMomentumFluxBC

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/indicators/AbsoluteValueIndicator.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
# AbsoluteValueIndicator

!alert construction title=Undocumented Class
The AbsoluteValueIndicator has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Adaptivity/Indicators/AbsoluteValueIndicator

## Overview
!! ## Overview

!! Replace these lines with information regarding the AbsoluteValueIndicator object.

## Example Input File Syntax
!! ## Example Input File Syntax

!! Describe and include an example of how to use the AbsoluteValueIndicator object.

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/kernels/ADStressDivergence.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# ADStressDivergence

!alert construction title=Undocumented Class
The ADStressDivergence has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Kernels/ADStressDivergence

## Overview
!! ## Overview

!! Replace these lines with information regarding the ADStressDivergence object.

## Example Input File Syntax

!! Describe and include an example of how to use the ADStressDivergence object.
!listing 3d-scaled-1st-order.i block=Kernels/disp_x

!syntax parameters /Kernels/ADStressDivergence

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/kernels/BaldrConvectedMesh.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# BaldrConvectedMesh

!alert construction title=Undocumented Class
The BaldrConvectedMesh has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Kernels/BaldrConvectedMesh

## Overview
!! ## Overview

!! Replace these lines with information regarding the BaldrConvectedMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the BaldrConvectedMesh object.
!listing cold-twice-around-no-surface-tension.i block=Kernels/mesh_velocity

!syntax parameters /Kernels/BaldrConvectedMesh

Expand Down
10 changes: 2 additions & 8 deletions doc/content/source/kernels/BaldrTemperatureConvectedMesh.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# BaldrTemperatureConvectedMesh

!alert construction title=Undocumented Class
The BaldrTemperatureConvectedMesh has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Kernels/BaldrTemperatureConvectedMesh

## Overview
!! ## Overview

!! Replace these lines with information regarding the BaldrTemperatureConvectedMesh object.

## Example Input File Syntax

!! Describe and include an example of how to use the BaldrTemperatureConvectedMesh object.
!listing cold-twice-around-no-surface-tension.i block=Kernels/mesh_T

!syntax parameters /Kernels/BaldrTemperatureConvectedMesh

Expand Down
23 changes: 0 additions & 23 deletions doc/content/source/materials/CrazyKCPlantFits.md

This file was deleted.

23 changes: 0 additions & 23 deletions doc/content/source/materials/CrazyKCPlantFitsBoundary.md

This file was deleted.

17 changes: 17 additions & 0 deletions doc/content/source/materials/DemonstrationPlantFits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DemonstrationPlantFits

!syntax description /Materials/DemonstrationPlantFits

!! ## Overview

!! Replace these lines with information regarding the DemonstrationPlantFits object.

## Example Input File Syntax

!listing cold-no-surface-tension.i block=Materials/kc_fits

!syntax parameters /Materials/DemonstrationPlantFits

!syntax inputs /Materials/DemonstrationPlantFits

!syntax children /Materials/DemonstrationPlantFits
17 changes: 17 additions & 0 deletions doc/content/source/materials/DemonstrationPlantFitsBoundary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DemonstrationPlantFitsBoundary

!syntax description /Materials/DemonstrationPlantFitsBoundary

!! ## Overview

!! Replace these lines with information regarding the DemonstrationPlantFitsBoundary object.

## Example Input File Syntax

!listing cold-no-surface-tension.i block=Materials/boundary

!syntax parameters /Materials/DemonstrationPlantFitsBoundary

!syntax inputs /Materials/DemonstrationPlantFitsBoundary

!syntax children /Materials/DemonstrationPlantFitsBoundary
10 changes: 2 additions & 8 deletions doc/content/source/materials/PseudoSolidStress.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# PseudoSolidStress

!alert construction title=Undocumented Class
The PseudoSolidStress has not been documented. The content listed below should be used as a starting point for
documenting the class, which includes the typical automatic documentation associated with a
MooseObject; however, what is contained is ultimately determined by what is necessary to make the
documentation clear for users.

!syntax description /Materials/PseudoSolidStress

## Overview
!! ## Overview

!! Replace these lines with information regarding the PseudoSolidStress object.

## Example Input File Syntax

!! Describe and include an example of how to use the PseudoSolidStress object.
!listing 3d-scaled-1st-order.i block=Materials/stress

!syntax parameters /Materials/PseudoSolidStress

Expand Down
4 changes: 4 additions & 0 deletions doc/content/sqa/user_manual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# MALAMUTE User Manual

Documentation for all MALAMUTE input file objects, and how they can be used in the creation of a
multiphysics simulation, is contained in the [syntax/index.md] page.
cticenhour marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions doc/content/syntax/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ Listed below are all of the possible input parameter options for a MALAMUTE inpu
file. Click the blue link shown to the right of each heading to see a more detailed
description of its purpose.

For a filtered list of MALAMUTE-only syntax, please [click here](syntax/malamute_only.md).

!syntax complete
9 changes: 9 additions & 0 deletions doc/content/syntax/malamute_only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MALAMUTE-only Input File Syntax

Listed below are the input parameter options for a MALAMUTE input file for code contained solely
within MALAMUTE (not within MOOSE or its modules). Click the blue link shown to the right of each
heading to see a more detailed description of its purpose.

To return to the complete code syntax, please [click here](syntax/index.md).

!syntax complete groups=MalamuteApp
9 changes: 4 additions & 5 deletions doc/sqa_reports.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Applications:
content_directory: ${ROOT_DIR}/doc/content
remove:
- ${MOOSE_DIR}/framework/doc/remove.yml
log_default: WARNING
show_warning: false

Documents:
Expand All @@ -19,13 +18,14 @@ Documents:
software_requirements_specification: sqa/malamute_srs.md
software_design_description: sqa/malamute_sdd.md
software_test_plan: sqa/malamute_stp.md
requirements_traceablity_matrix: sqa/malamute_rtm.md
requirements_traceability_matrix: sqa/malamute_rtm.md
verification_validation_report: sqa/malamute_vvr.md
failure_analysis_report: sqa/malamute_far.md
software_library_list: sqa/malamute_sll.md
communication_and_contact_information: sqa/malamute_cci.md
software_coding_standards: sqa/malamute_scs.md
log_default: WARNING
user_manual: sqa/user_manual.md
log_theory_manual: NONE # all theory is contained within example, benchmark, or design docs
show_warning: false
working_dirs:
- ${ROOT_DIR}/doc/content
Expand All @@ -49,6 +49,5 @@ Requirements:
- ${MOOSE_DIR}/modules/tensor_mechanics/doc/content
directories:
- ${ROOT_DIR}/test
- ${ROOT_DIR}/examples
log_default: WARNING
# - ${ROOT_DIR}/examples TODO: add back in when examples is more stable and less R&D
show_warning: false
Loading