diff --git a/.coverage b/.coverage index 9d6e5534..1d945b3a 100644 --- a/.coverage +++ b/.coverage @@ -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 diff --git a/doc/content/source/bcs/DisplaceBoundaryBC.md b/doc/content/source/bcs/DisplaceBoundaryBC.md index 05bbaf6e..31364ae1 100644 --- a/doc/content/source/bcs/DisplaceBoundaryBC.md +++ b/doc/content/source/bcs/DisplaceBoundaryBC.md @@ -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 diff --git a/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md b/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md index 05d3411b..1e06c35d 100644 --- a/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md +++ b/doc/content/source/bcs/GaussianWeldEnergyFluxBC.md @@ -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 diff --git a/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md b/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md index ab24b9a4..46ba3757 100644 --- a/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md +++ b/doc/content/source/bcs/PenaltyDisplaceBoundaryBC.md @@ -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 diff --git a/doc/content/source/bcs/RadiationEnergyFluxBC.md b/doc/content/source/bcs/RadiationEnergyFluxBC.md index 90514155..09ea067e 100644 --- a/doc/content/source/bcs/RadiationEnergyFluxBC.md +++ b/doc/content/source/bcs/RadiationEnergyFluxBC.md @@ -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 diff --git a/doc/content/source/bcs/SurfaceTensionBC.md b/doc/content/source/bcs/SurfaceTensionBC.md index a6e1bce4..1e2e9ea4 100644 --- a/doc/content/source/bcs/SurfaceTensionBC.md +++ b/doc/content/source/bcs/SurfaceTensionBC.md @@ -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 diff --git a/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md b/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md index 73916ebd..1ca73995 100644 --- a/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md +++ b/doc/content/source/bcs/VaporRecoilPressureMomentumFluxBC.md @@ -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 diff --git a/doc/content/source/indicators/AbsoluteValueIndicator.md b/doc/content/source/indicators/AbsoluteValueIndicator.md index 12013bdd..e69d4f52 100644 --- a/doc/content/source/indicators/AbsoluteValueIndicator.md +++ b/doc/content/source/indicators/AbsoluteValueIndicator.md @@ -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. diff --git a/doc/content/source/kernels/ADStressDivergence.md b/doc/content/source/kernels/ADStressDivergence.md index fa1012f3..5a737071 100644 --- a/doc/content/source/kernels/ADStressDivergence.md +++ b/doc/content/source/kernels/ADStressDivergence.md @@ -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 diff --git a/doc/content/source/kernels/BaldrConvectedMesh.md b/doc/content/source/kernels/BaldrConvectedMesh.md index 542361ab..ff9fac0d 100644 --- a/doc/content/source/kernels/BaldrConvectedMesh.md +++ b/doc/content/source/kernels/BaldrConvectedMesh.md @@ -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 diff --git a/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md b/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md index aa5682fe..4484d0b4 100644 --- a/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md +++ b/doc/content/source/kernels/BaldrTemperatureConvectedMesh.md @@ -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 diff --git a/doc/content/source/materials/CrazyKCPlantFits.md b/doc/content/source/materials/CrazyKCPlantFits.md deleted file mode 100644 index 02230e37..00000000 --- a/doc/content/source/materials/CrazyKCPlantFits.md +++ /dev/null @@ -1,23 +0,0 @@ -# CrazyKCPlantFits - -!alert construction title=Undocumented Class -The CrazyKCPlantFits 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/CrazyKCPlantFits - -## Overview - -!! Replace these lines with information regarding the CrazyKCPlantFits object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the CrazyKCPlantFits object. - -!syntax parameters /Materials/CrazyKCPlantFits - -!syntax inputs /Materials/CrazyKCPlantFits - -!syntax children /Materials/CrazyKCPlantFits diff --git a/doc/content/source/materials/CrazyKCPlantFitsBoundary.md b/doc/content/source/materials/CrazyKCPlantFitsBoundary.md deleted file mode 100644 index 49cd5b05..00000000 --- a/doc/content/source/materials/CrazyKCPlantFitsBoundary.md +++ /dev/null @@ -1,23 +0,0 @@ -# CrazyKCPlantFitsBoundary - -!alert construction title=Undocumented Class -The CrazyKCPlantFitsBoundary 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/CrazyKCPlantFitsBoundary - -## Overview - -!! Replace these lines with information regarding the CrazyKCPlantFitsBoundary object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the CrazyKCPlantFitsBoundary object. - -!syntax parameters /Materials/CrazyKCPlantFitsBoundary - -!syntax inputs /Materials/CrazyKCPlantFitsBoundary - -!syntax children /Materials/CrazyKCPlantFitsBoundary diff --git a/doc/content/source/materials/DemonstrationPlantFits.md b/doc/content/source/materials/DemonstrationPlantFits.md new file mode 100644 index 00000000..842658b5 --- /dev/null +++ b/doc/content/source/materials/DemonstrationPlantFits.md @@ -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 diff --git a/doc/content/source/materials/DemonstrationPlantFitsBoundary.md b/doc/content/source/materials/DemonstrationPlantFitsBoundary.md new file mode 100644 index 00000000..d106dd56 --- /dev/null +++ b/doc/content/source/materials/DemonstrationPlantFitsBoundary.md @@ -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 diff --git a/doc/content/source/materials/PseudoSolidStress.md b/doc/content/source/materials/PseudoSolidStress.md index 54ddea5c..71166a39 100644 --- a/doc/content/source/materials/PseudoSolidStress.md +++ b/doc/content/source/materials/PseudoSolidStress.md @@ -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 diff --git a/doc/content/sqa/user_manual.md b/doc/content/sqa/user_manual.md new file mode 100644 index 00000000..c8c65e07 --- /dev/null +++ b/doc/content/sqa/user_manual.md @@ -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. diff --git a/doc/content/syntax/index.md b/doc/content/syntax/index.md index b4535a3e..41449d46 100644 --- a/doc/content/syntax/index.md +++ b/doc/content/syntax/index.md @@ -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 diff --git a/doc/content/syntax/malamute_only.md b/doc/content/syntax/malamute_only.md new file mode 100644 index 00000000..3a2a0a5f --- /dev/null +++ b/doc/content/syntax/malamute_only.md @@ -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 diff --git a/doc/sqa_reports.yml b/doc/sqa_reports.yml index dfde1c0d..eaa7d034 100644 --- a/doc/sqa_reports.yml +++ b/doc/sqa_reports.yml @@ -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: @@ -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 @@ -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 diff --git a/examples/laser_welding_problems/physics/multi-scale-grain-growth/larry-2d-one-spot-scaled-1st-order.i b/examples/laser_welding_problems/physics/multi-scale-grain-growth/larry-2d-one-spot-scaled-1st-order.i index 744c98a1..a6e47ed7 100644 --- a/examples/laser_welding_problems/physics/multi-scale-grain-growth/larry-2d-one-spot-scaled-1st-order.i +++ b/examples/laser_welding_problems/physics/multi-scale-grain-growth/larry-2d-one-spot-scaled-1st-order.i @@ -307,7 +307,7 @@ pooldepth=${width} [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 length_unit_exponent = ${length_unit_exponent} @@ -316,7 +316,7 @@ pooldepth=${width} time_unit_exponent = ${time_unit_exponent} [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'top' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/no-surface-tension/cold-no-surface-tension.i b/examples/laser_welding_problems/physics/no-surface-tension/cold-no-surface-tension.i index 339146c0..20a4a2b3 100644 --- a/examples/laser_welding_problems/physics/no-surface-tension/cold-no-surface-tension.i +++ b/examples/laser_welding_problems/physics/no-surface-tension/cold-no-surface-tension.i @@ -327,12 +327,12 @@ surfacetemp=300 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T [../] diff --git a/examples/laser_welding_problems/physics/no-surface-tension/hot-no-surface-tension.i b/examples/laser_welding_problems/physics/no-surface-tension/hot-no-surface-tension.i index f9328af3..2463c53f 100644 --- a/examples/laser_welding_problems/physics/no-surface-tension/hot-no-surface-tension.i +++ b/examples/laser_welding_problems/physics/no-surface-tension/hot-no-surface-tension.i @@ -325,12 +325,12 @@ timestep=4e-7 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T [../] diff --git a/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-scaled-2nd-order.i b/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-scaled-2nd-order.i index 19897f0b..c509028b 100644 --- a/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-scaled-2nd-order.i +++ b/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-scaled-2nd-order.i @@ -293,7 +293,7 @@ half_width=${fparse 4e-4 / 10^length_unit_exponent} [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 length_unit_exponent = ${length_unit_exponent} @@ -304,7 +304,7 @@ half_width=${fparse 4e-4 / 10^length_unit_exponent} T90 = 400 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'top' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-unscaled-2nd-order.i b/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-unscaled-2nd-order.i index 9fdd3585..1e79a8b6 100644 --- a/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-unscaled-2nd-order.i +++ b/examples/laser_welding_problems/physics/surface-tension/2d-one-spot-unscaled-2nd-order.i @@ -274,12 +274,12 @@ pooldepth=2e-4 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'top' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/surface-tension/3d-one-spot-unscaled-1st-order.i b/examples/laser_welding_problems/physics/surface-tension/3d-one-spot-unscaled-1st-order.i index 4d114048..5884bda6 100644 --- a/examples/laser_welding_problems/physics/surface-tension/3d-one-spot-unscaled-1st-order.i +++ b/examples/laser_welding_problems/physics/surface-tension/3d-one-spot-unscaled-1st-order.i @@ -364,12 +364,12 @@ pooldepth=.2e-3 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'front' temperature = T diff --git a/examples/laser_welding_problems/physics/surface-tension/3d-scaled-1st-order.i b/examples/laser_welding_problems/physics/surface-tension/3d-scaled-1st-order.i index 1567fa2f..a966b8de 100644 --- a/examples/laser_welding_problems/physics/surface-tension/3d-scaled-1st-order.i +++ b/examples/laser_welding_problems/physics/surface-tension/3d-scaled-1st-order.i @@ -404,7 +404,7 @@ pooldepth=${width} [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 length_unit_exponent = ${length_unit_exponent} @@ -413,7 +413,7 @@ pooldepth=${width} time_unit_exponent = ${time_unit_exponent} [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/surface-tension/cold-start-twice-around-circle.i b/examples/laser_welding_problems/physics/surface-tension/cold-start-twice-around-circle.i index 24692801..d5a18611 100644 --- a/examples/laser_welding_problems/physics/surface-tension/cold-start-twice-around-circle.i +++ b/examples/laser_welding_problems/physics/surface-tension/cold-start-twice-around-circle.i @@ -352,12 +352,12 @@ surfacetemp=300 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/surface-tension/gold-2d-one-spot-scaled-1st-order.i b/examples/laser_welding_problems/physics/surface-tension/gold-2d-one-spot-scaled-1st-order.i index 56fd09e5..ebc52732 100644 --- a/examples/laser_welding_problems/physics/surface-tension/gold-2d-one-spot-scaled-1st-order.i +++ b/examples/laser_welding_problems/physics/surface-tension/gold-2d-one-spot-scaled-1st-order.i @@ -297,7 +297,7 @@ pooldepth=${width} [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 length_unit_exponent = ${length_unit_exponent} @@ -306,7 +306,7 @@ pooldepth=${width} time_unit_exponent = ${time_unit_exponent} [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'top' temperature = T use_displaced_mesh = true diff --git a/examples/laser_welding_problems/physics/surface-tension/hot-once-around-circle.i b/examples/laser_welding_problems/physics/surface-tension/hot-once-around-circle.i index 20412f99..dda8ad62 100644 --- a/examples/laser_welding_problems/physics/surface-tension/hot-once-around-circle.i +++ b/examples/laser_welding_problems/physics/surface-tension/hot-once-around-circle.i @@ -350,12 +350,12 @@ timestep=4e-7 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'front' temperature = T diff --git a/examples/laser_welding_problems/profiling/kc-profiling.i b/examples/laser_welding_problems/profiling/kc-profiling.i index 6386ffd3..74b7821c 100644 --- a/examples/laser_welding_problems/profiling/kc-profiling.i +++ b/examples/laser_welding_problems/profiling/kc-profiling.i @@ -308,11 +308,11 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'front' temperature = T diff --git a/examples/melt_pool_2d/tests b/examples/melt_pool_2d/tests index 2ea0f797..27185dc2 100644 --- a/examples/melt_pool_2d/tests +++ b/examples/melt_pool_2d/tests @@ -4,5 +4,6 @@ input = 'melt_pool.i' check_input = True method = opt + issues = '#4' [../] [] diff --git a/examples/melt_pool_3d/tests b/examples/melt_pool_3d/tests index a00c9792..191e4ff4 100644 --- a/examples/melt_pool_3d/tests +++ b/examples/melt_pool_3d/tests @@ -4,5 +4,6 @@ input = 'melt_pool.i' check_input = True method = opt + issues = '#4' [../] [] diff --git a/examples/sps/engineering_scale/validation/dcs5/empty_die/stepped_20mm/tests b/examples/sps/engineering_scale/validation/dcs5/empty_die/stepped_20mm/tests index dc65203a..7725ef9c 100644 --- a/examples/sps/engineering_scale/validation/dcs5/empty_die/stepped_20mm/tests +++ b/examples/sps/engineering_scale/validation/dcs5/empty_die/stepped_20mm/tests @@ -1,14 +1,13 @@ [Tests] - requirement = 'The system shall compute the electro-thermo-mechanical response ' - 'of a 2D-axisymmetric representation of the DCS-5 stepped 20mm diameter ' - 'punch graphite tooling stack,' [dcs5_stepped20mm_empty_constant_properties] type = RunApp input = 'dcs5_stepped20mm_empty_constant_properties.i' check_input = True method = opt issues = '#91' - detail = 'using constant graphite material properties, which signficantly ' - 'overestimates the temperature profile during the SPS run.' + requirement = 'The system shall compute the electro-thermo-mechanical response ' + 'of a 2D-axisymmetric representation of the DCS-5 stepped 20mm diameter ' + 'punch graphite tooling stack, using constant graphite material properties, ' + 'which significantly overestimates the temperature profile measured during the EFAS run.' [] [] diff --git a/include/materials/CrazyKCPlantFits.h b/include/materials/DemonstrationPlantFits.h similarity index 93% rename from include/materials/CrazyKCPlantFits.h rename to include/materials/DemonstrationPlantFits.h index 70549f7c..14b780cf 100644 --- a/include/materials/CrazyKCPlantFits.h +++ b/include/materials/DemonstrationPlantFits.h @@ -14,12 +14,12 @@ /** * A material that couples a material property */ -class CrazyKCPlantFits : public ADMaterial +class DemonstrationPlantFits : public ADMaterial { public: static InputParameters validParams(); - CrazyKCPlantFits(const InputParameters & parameters); + DemonstrationPlantFits(const InputParameters & parameters); protected: virtual void computeQpProperties(); diff --git a/include/materials/CrazyKCPlantFitsBoundary.h b/include/materials/DemonstrationPlantFitsBoundary.h similarity index 93% rename from include/materials/CrazyKCPlantFitsBoundary.h rename to include/materials/DemonstrationPlantFitsBoundary.h index 4ddd608a..d9d9cfb1 100644 --- a/include/materials/CrazyKCPlantFitsBoundary.h +++ b/include/materials/DemonstrationPlantFitsBoundary.h @@ -14,12 +14,12 @@ /** * A material that couples a material property */ -class CrazyKCPlantFitsBoundary : public ADMaterial +class DemonstrationPlantFitsBoundary : public ADMaterial { public: static InputParameters validParams(); - CrazyKCPlantFitsBoundary(const InputParameters & parameters); + DemonstrationPlantFitsBoundary(const InputParameters & parameters); protected: virtual void computeQpProperties(); diff --git a/src/bcs/GaussianWeldEnergyFluxBC.C b/src/bcs/GaussianWeldEnergyFluxBC.C index 72d8af19..fc8b73fc 100644 --- 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("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 index cef8962e..18479a16 100644 --- a/src/indicators/AbsoluteValueIndicator.C +++ b/src/indicators/AbsoluteValueIndicator.C @@ -16,6 +16,8 @@ InputParameters AbsoluteValueIndicator::validParams() { InputParameters params = ElementIntegralIndicator::validParams(); + params.addClassDescription( + "Computes 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 index 805b6d07..d6faa265 100644 --- a/src/kernels/ADStressDivergence.C +++ b/src/kernels/ADStressDivergence.C @@ -15,6 +15,8 @@ InputParameters ADStressDivergence::validParams() { InputParameters params = ADKernel::validParams(); + params.addClassDescription("Computes the divergence of the stress tensor with respect to a given " + "displacement component."); params.addRequiredParam("component", "The displacement component"); return params; } diff --git a/src/materials/CrazyKCPlantFits.C b/src/materials/DemonstrationPlantFits.C similarity index 94% rename from src/materials/CrazyKCPlantFits.C rename to src/materials/DemonstrationPlantFits.C index 02ca1e75..498133db 100644 --- a/src/materials/CrazyKCPlantFits.C +++ b/src/materials/DemonstrationPlantFits.C @@ -7,14 +7,16 @@ /* ALL RIGHTS RESERVED */ /****************************************************************************/ -#include "CrazyKCPlantFits.h" +#include "DemonstrationPlantFits.h" -registerMooseObject("MalamuteApp", CrazyKCPlantFits); +registerMooseObject("MalamuteApp", DemonstrationPlantFits); InputParameters -CrazyKCPlantFits::validParams() +DemonstrationPlantFits::validParams() { InputParameters params = ADMaterial::validParams(); + params.addClassDescription( + "Material properties corresponding to demonstration reference material."); params.addParam("c_mu0", 0.15616, "mu0 coefficient"); params.addParam("c_mu1", -3.3696e-5, "mu1 coefficient"); params.addParam("c_mu2", 1.0191e-8, "mu2 coefficient"); @@ -55,7 +57,7 @@ CrazyKCPlantFits::validParams() return params; } -CrazyKCPlantFits::CrazyKCPlantFits(const InputParameters & parameters) +DemonstrationPlantFits::DemonstrationPlantFits(const InputParameters & parameters) : ADMaterial(parameters), _c_mu0(getParam("c_mu0")), _c_mu1(getParam("c_mu1")), @@ -85,7 +87,7 @@ CrazyKCPlantFits::CrazyKCPlantFits(const InputParameters & parameters) } void -CrazyKCPlantFits::computeQpProperties() +DemonstrationPlantFits::computeQpProperties() { if (_temperature[_qp] < _Tl * _temperature_units_per_kelvin) _mu[_qp] = _mass_units_per_kilogram / (_length_units_per_meter * _time_units_per_second) * diff --git a/src/materials/CrazyKCPlantFitsBoundary.C b/src/materials/DemonstrationPlantFitsBoundary.C similarity index 93% rename from src/materials/CrazyKCPlantFitsBoundary.C rename to src/materials/DemonstrationPlantFitsBoundary.C index 776bf36b..9f972043 100644 --- a/src/materials/CrazyKCPlantFitsBoundary.C +++ b/src/materials/DemonstrationPlantFitsBoundary.C @@ -7,15 +7,17 @@ /* ALL RIGHTS RESERVED */ /****************************************************************************/ -#include "CrazyKCPlantFitsBoundary.h" +#include "DemonstrationPlantFitsBoundary.h" #include "Assembly.h" -registerMooseObject("MalamuteApp", CrazyKCPlantFitsBoundary); +registerMooseObject("MalamuteApp", DemonstrationPlantFitsBoundary); InputParameters -CrazyKCPlantFitsBoundary::validParams() +DemonstrationPlantFitsBoundary::validParams() { InputParameters params = ADMaterial::validParams(); + params.addClassDescription( + "Boundary material properties corresponding to demonstration reference material."); params.addParam("c_mu0", 0.15616, "mu0 coefficient"); params.addParam("ap0", 0, ""); params.addParam("ap1", 1.851502e1, ""); @@ -58,7 +60,7 @@ CrazyKCPlantFitsBoundary::validParams() return params; } -CrazyKCPlantFitsBoundary::CrazyKCPlantFitsBoundary(const InputParameters & parameters) +DemonstrationPlantFitsBoundary::DemonstrationPlantFitsBoundary(const InputParameters & parameters) : ADMaterial(parameters), _ap0(getParam("ap0")), _ap1(getParam("ap1")), @@ -94,7 +96,7 @@ CrazyKCPlantFitsBoundary::CrazyKCPlantFitsBoundary(const InputParameters & param } void -CrazyKCPlantFitsBoundary::computeQpProperties() +DemonstrationPlantFitsBoundary::computeQpProperties() { auto && theta = _temperature[_qp] / _temperature_units_per_kelvin - _Tb; if (theta < _Tbound1) diff --git a/src/materials/PseudoSolidStress.C b/src/materials/PseudoSolidStress.C index e18f8ced..7327df6d 100644 --- 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"); diff --git a/test/tests/gaussian_heat_source/tests b/test/tests/gaussian_heat_source/tests index 3f8336eb..35efba93 100644 --- a/test/tests/gaussian_heat_source/tests +++ b/test/tests/gaussian_heat_source/tests @@ -4,48 +4,52 @@ type = CSVDiff input = 'gaussian_heat_source.i' csvdiff = 'gaussian_heat_source_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source, whose movement is prescribed by a position function.' design = 'ADGaussianHeatSourceBase.md ADFunctionPathGaussianHeatSource.md' [] [velocity_gaussian_heat_source] type = CSVDiff input = 'velocity_gaussian_heat_source.i' csvdiff = 'velocity_gaussian_heat_source_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source, whose movement is prescribed by a given velocity vector.' design = 'ADGaussianHeatSourceBase.md ADVelocityGaussianHeatSource.md' [] [gaussian_heat_source_vary_r] type = CSVDiff input = 'gaussian_heat_source_vary_r.i' csvdiff = 'gaussian_heat_source_vary_r_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source and anisotropic effective radii along three directions.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source (movement prescribed by a position function) and anisotropic effective ' + 'radii along three directions.' design = 'ADGaussianHeatSourceBase.md ADFunctionPathGaussianHeatSource.md' [] [velocity_gaussian_heat_source_vary_r] type = CSVDiff input = 'velocity_gaussian_heat_source_vary_r.i' csvdiff = 'velocity_gaussian_heat_source_vary_r_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source and anisotropic effective radii along three directions.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source (movement prescribed by velocity vector) and anisotropic effective radii ' + 'along three directions.' design = 'ADGaussianHeatSourceBase.md ADVelocityGaussianHeatSource.md' [] [gaussian_heat_source_experiment_r] type = CSVDiff input = 'gaussian_heat_source_experiment_r.i' csvdiff = 'gaussian_heat_source_experiment_r_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source and anisotropic effective radii based on experimental measurements.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source (movement prescribed by a position function) and anisotropic effective ' + 'radii based on experimental measurements.' design = 'ADGaussianHeatSourceBase.md ADFunctionPathGaussianHeatSource.md' [] [velocity_gaussian_heat_source_experiment_r] type = CSVDiff input = 'velocity_gaussian_heat_source_experiment_r.i' csvdiff = 'velocity_gaussian_heat_source_experiment_r_out.csv' - requirement = 'The system shall produce the correct temperature field with moving Gaussian heat ' - 'source and anisotropic effective radii based on experimental measurements.' + requirement = 'The system shall produce the correct temperature field with a moving Gaussian heat ' + 'source (movement prescribed by velocity vector) and anisotropic effective radii ' + 'based on experimental measurements.' design = 'ADGaussianHeatSourceBase.md ADVelocityGaussianHeatSource.md' [] [] diff --git a/test/tests/laser_welding_jacobian_testing/2nd-order-2d-jacobian-tester.i b/test/tests/laser_welding_jacobian_testing/2nd-order-2d-jacobian-tester.i index d8c77e48..88d9b9e6 100644 --- a/test/tests/laser_welding_jacobian_testing/2nd-order-2d-jacobian-tester.i +++ b/test/tests/laser_welding_jacobian_testing/2nd-order-2d-jacobian-tester.i @@ -254,7 +254,7 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T c_mu1 = 1 c_mu2 = 1 @@ -270,7 +270,7 @@ c_rho0 = 1 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'top' temperature = T diff --git a/test/tests/laser_welding_jacobian_testing/2nd-order-jacobian-tester.i b/test/tests/laser_welding_jacobian_testing/2nd-order-jacobian-tester.i index acab819f..bab26bf9 100644 --- a/test/tests/laser_welding_jacobian_testing/2nd-order-jacobian-tester.i +++ b/test/tests/laser_welding_jacobian_testing/2nd-order-jacobian-tester.i @@ -338,7 +338,7 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T c_mu1 = 1 c_mu2 = 1 @@ -354,7 +354,7 @@ c_rho0 = 1 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'front' temperature = T diff --git a/test/tests/laser_welding_jacobian_testing/kc_jacobian_tester.i b/test/tests/laser_welding_jacobian_testing/kc_jacobian_tester.i index 83209282..f53b53ce 100644 --- a/test/tests/laser_welding_jacobian_testing/kc_jacobian_tester.i +++ b/test/tests/laser_welding_jacobian_testing/kc_jacobian_tester.i @@ -336,7 +336,7 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T c_mu1 = 1 c_mu2 = 1 @@ -352,7 +352,7 @@ c_rho0 = 1 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'front' temperature = T diff --git a/test/tests/laser_welding_jacobian_testing/non-uniform-1st-order-2d-jacobian-tester.i b/test/tests/laser_welding_jacobian_testing/non-uniform-1st-order-2d-jacobian-tester.i index e6bec450..fd53b5bb 100644 --- a/test/tests/laser_welding_jacobian_testing/non-uniform-1st-order-2d-jacobian-tester.i +++ b/test/tests/laser_welding_jacobian_testing/non-uniform-1st-order-2d-jacobian-tester.i @@ -253,7 +253,7 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T c_mu1 = 1 c_mu2 = 1 @@ -269,7 +269,7 @@ c_rho0 = 1 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'top' temperature = T diff --git a/test/tests/laser_welding_jacobian_testing/non-uniform-2nd-order-2d-jacobian-tester.i b/test/tests/laser_welding_jacobian_testing/non-uniform-2nd-order-2d-jacobian-tester.i index c8dae827..43764167 100644 --- a/test/tests/laser_welding_jacobian_testing/non-uniform-2nd-order-2d-jacobian-tester.i +++ b/test/tests/laser_welding_jacobian_testing/non-uniform-2nd-order-2d-jacobian-tester.i @@ -254,7 +254,7 @@ [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T c_mu1 = 1 c_mu2 = 1 @@ -270,7 +270,7 @@ c_rho0 = 1 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary use_displaced_mesh = true boundary = 'top' temperature = T diff --git a/test/tests/laser_welding_physics/cold-twice-around-no-surface-tension.i b/test/tests/laser_welding_physics/cold-twice-around-no-surface-tension.i index c0f7e288..d3076aaa 100644 --- a/test/tests/laser_welding_physics/cold-twice-around-no-surface-tension.i +++ b/test/tests/laser_welding_physics/cold-twice-around-no-surface-tension.i @@ -274,12 +274,12 @@ surfacetemp=300 [Materials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T [../] diff --git a/test/tests/laser_welding_physics/hot-once-around-no-surface-tension.i b/test/tests/laser_welding_physics/hot-once-around-no-surface-tension.i index fb554be7..a724d707 100644 --- a/test/tests/laser_welding_physics/hot-once-around-no-surface-tension.i +++ b/test/tests/laser_welding_physics/hot-once-around-no-surface-tension.i @@ -324,12 +324,12 @@ timestep=4e-7 [ADMaterials] [./kc_fits] - type = CrazyKCPlantFits + type = DemonstrationPlantFits temperature = T beta = 1e7 [../] [./boundary] - type = CrazyKCPlantFitsBoundary + type = DemonstrationPlantFitsBoundary boundary = 'front' temperature = T [../]