Skip to content

Commit

Permalink
Add new content to documentation
Browse files Browse the repository at this point in the history
- Adds Cardinal content
  - Excludes Nek-related content
  - Adds landing page for BulkEnergyConservationICAction
  - Adds landing page for VolumetricHeatSourceICAction
  - Removes excess syntax information for both IC actions
  - Adds landing page for Cardinal/ICs custom syntax
- Adds module content
- Add SQA dependencies and SQA requirement content for modules and apps

Refs idaholab#38 and idaholab#52
  • Loading branch information
cticenhour committed Aug 8, 2024
1 parent 03e233d commit 7efd2bc
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 0 deletions.
35 changes: 35 additions & 0 deletions doc/cardinal_nek_exclude.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
- source/**
- media/**
- ~source/auxkernels/NekSpatialBinComponentAux.md
- ~source/timesteppers/NekTimeStepper.md
- ~source/mesh/NekRSMesh.md
- ~source/postprocessors/boundary_specs.md
- ~source/postprocessors/NekHeatFluxIntegral.md
- ~source/postprocessors/NekNumRanks.md
- ~source/postprocessors/NekMassFluxWeightedSideAverage.md
- ~source/postprocessors/NekMassFluxWeightedSideIntegral.md
- ~source/postprocessors/NekPressureSurfaceForce.md
- ~source/postprocessors/NekScalarValuePostprocessor.md
- ~source/postprocessors/NekSideAverage.md
- ~source/postprocessors/NekSideExtremeValue.md
- ~source/postprocessors/NekSideIntegral.md
- ~source/postprocessors/NekUsrWrkBoundaryIntegral.md
- ~source/postprocessors/NekVolumeAverage.md
- ~source/postprocessors/NekVolumeExtremeValue.md
- ~source/postprocessors/NekVolumeIntegral.md
- ~source/postprocessors/PecletNumber.md
- ~source/postprocessors/ReynoldsNumber.md
- ~source/problems/NekRSProblem.md
- ~source/problems/NekRSSeparateDomainProblem.md
- ~source/problems/nek_classes.md
- ~source/problems/nondimensional_problem.md
- ~source/problems/output_solution.md
- ~source/problems/NekRSStandaloneProblem.md
- ~source/userobjects/NekBinnedPlaneAverage.md
- ~source/userobjects/NekBinnedPlaneIntegral.md
- ~source/userobjects/NekBinnedSideAverage.md
- ~source/userobjects/NekBinnedSideIntegral.md
- ~source/userobjects/NekBinnedVolumeAverage.md
- ~source/userobjects/NekBinnedVolumeIntegral.md
- ~source/userobjects/NekScalarValue.md
- ~source/userobjects/velocity_component.md
9 changes: 9 additions & 0 deletions doc/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ Content:
- python/TestHarness.md
tmap8:
root_dir: ${ROOT_DIR}/tmap8/doc/content
cardinal:
root_dir: ${ROOT_DIR}/cardinal/doc/content
content: !include ${ROOT_DIR}/doc/cardinal_nek_exclude.yml

Renderer:
type: MooseDocs.base.MaterializeRenderer
Expand Down Expand Up @@ -86,11 +89,16 @@ Extensions:
executable: ${ROOT_DIR}
remove:
framework: !include ${MOOSE_DIR}/framework/doc/remove.yml
cardinal:
- /ICs/BulkEnergyConservationIC
- /Cardinal/ICs/BulkEnergyConservation/BulkEnergyConservationICAction
- /Cardinal/ICs/VolumetricHeatSource/VolumetricHeatSourceICAction
MooseDocs.extensions.common:
shortcuts: !include ${MOOSE_DIR}/framework/doc/globals.yml
MooseDocs.extensions.acronym:
acronyms:
framework: !include ${MOOSE_DIR}/framework/doc/acronyms.yml
cardinal: !include ${ROOT_DIR}/cardinal/doc/acronyms.yml
fenix:
FENIX: Fusion ENergy Integrated multiphys-X
PIC: particle-in-cell
Expand All @@ -117,6 +125,7 @@ Extensions:
stochastic_tools: !include ${MOOSE_DIR}/modules/stochastic_tools/doc/sqa_stochastic_tools.yml
thermal_hydraulics: !include ${MOOSE_DIR}/modules/thermal_hydraulics/doc/sqa_thermal_hydraulics.yml
tmap8: !include ${ROOT_DIR}/tmap8/doc/sqa_tmap8.yml
#cardinal: !include ${ROOT_DIR}/cardinal/doc/sqa_cardinal.yml
reports: !include ${ROOT_DIR}/doc/sqa_reports.yml
repos:
default: https://github.com/idaholab/fenix
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!include BulkEnergyConservationIC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!include VolumetricHeatSourceICAction.md
1 change: 1 addition & 0 deletions doc/content/syntax/Cardinal/ICs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!include syntax/Cardinal/index.md
5 changes: 5 additions & 0 deletions doc/content/syntax/Cardinal/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Custom Cardinal Syntax

Custom block syntax is used for both of the [VolumetricHeatSourceICAction.md] and
[BulkEnergyConservationIC.md] objects. Examples of the usage of this syntax can
be found in either of the linked pages.
1 change: 1 addition & 0 deletions doc/sqa_fenix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ dependencies: # commented-out categories are not available
- stochastic_tools
- thermal_hydraulics
- tmap8
#- cardinal
reports: !include ${ROOT_DIR}/doc/sqa_reports.yml
2 changes: 2 additions & 0 deletions doc/sqa_reports.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ Requirements:
- ${MOOSE_DIR}/modules/ray_tracing/doc/content
- ${MOOSE_DIR}/modules/scalar_transport/doc/content
- ${MOOSE_DIR}/modules/solid_mechanics/doc/content
- ${MOOSE_DIR}/modules/solid_properties/doc/content
- ${MOOSE_DIR}/modules/stochastic_tools/doc/content
- ${MOOSE_DIR}/modules/thermal_hydraulics/doc/content
- ${ROOT_DIR}/tmap8/doc/content
- ${ROOT_DIR}/cardinal/doc/content
directories:
- ${ROOT_DIR}/test
show_warning: false

0 comments on commit 7efd2bc

Please sign in to comment.