Skip to content

Commit

Permalink
Add formal theory manual page with redirections to VVR and syntax pages
Browse files Browse the repository at this point in the history
  • Loading branch information
cticenhour committed Apr 19, 2024
1 parent afb5cd8 commit 95bfb5f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
11 changes: 11 additions & 0 deletions doc/content/sqa/theory_manual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# MALAMUTE Theory Manual

Background on the basis of MALAMUTE theory can be found throughout the standard user documentation.
Here, we highlight several locations of interest for MALAMUTE theory:

- 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.
- MALAMUTE verification and validation cases, along with associated documentation, can be found in
the [malamute_vvr.md].

<!--TODO: add link to demonstration cases page here when that page is not just an empty placeholder-->
2 changes: 1 addition & 1 deletion doc/sqa_reports.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Documents:
communication_and_contact_information: sqa/malamute_cci.md
software_coding_standards: sqa/malamute_scs.md
user_manual: sqa/user_manual.md
log_theory_manual: NONE # all theory is contained within example, benchmark, or design docs
theory_manual: sqa/theory_manual.md
show_warning: false
working_dirs:
- ${ROOT_DIR}/doc/content
Expand Down
1 change: 1 addition & 0 deletions test/tests/interfacekernels/thermal_conductance/tests
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,6 @@
allow_test_objects = True
requirement = 'The system shall calculate the correct thermal contact temperature solution when compared to an analytic result, given a one-dimensional, two-material-block scenario.'
issues = '#13'
verification=thermal_contact_verification.md
[../]
[]

0 comments on commit 95bfb5f

Please sign in to comment.