Skip to content

Commit

Permalink
Add new content to documentation
Browse files Browse the repository at this point in the history
- Adds TMAP8 content (requires a forthcoming adjustment to TMAP8 documentation to build successfully)
- 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
- Tweaks name of FENIX user notes page in light of TMAP8 conflict
- Adds code coverage link to navigation
- 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 1, 2024
1 parent cb35dbd commit 28e8a29
Show file tree
Hide file tree
Showing 9 changed files with 134 additions and 4 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
61 changes: 58 additions & 3 deletions doc/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,36 @@ Content:
root_dir: ${ROOT_DIR}/doc/content
framework:
root_dir: ${MOOSE_DIR}/framework/doc/content
chemical_reactions:
root_dir: ${MOOSE_DIR}/modules/chemical_reactions/doc/content
electromagnetics:
root_dir: ${MOOSE_DIR}/modules/electromagnetics/doc/content
fluid_properties:
root_dir: ${MOOSE_DIR}/modules/fluid_properties/doc/content
heat_transfer:
root_dir: ${MOOSE_DIR}/modules/heat_transfer/doc/content
misc:
root_dir: ${MOOSE_DIR}/modules/misc/doc/content
navier_stokes:
root_dir: ${MOOSE_DIR}/modules/navier_stokes/doc/content
phase_field:
root_dir: ${MOOSE_DIR}/modules/phase_field/doc/content
reactor:
root_dir: ${MOOSE_DIR}/modules/reactor/doc/content
rdg:
root_dir: ${MOOSE_DIR}/modules/rdg/doc/content
ray_tracing:
root_dir: ${MOOSE_DIR}/modules/ray_tracing/doc/content
scalar_transport:
root_dir: ${MOOSE_DIR}/modules/scalar_transport/doc/content
solid_mechanics:
root_dir: ${MOOSE_DIR}/modules/solid_mechanics/doc/content
solid_properties:
root_dir: ${MOOSE_DIR}/modules/solid_properties/doc/content
stochastic_tools:
root_dir: ${MOOSE_DIR}/modules/stochastic_tools/doc/content
thermal_hydraulics:
root_dir: ${MOOSE_DIR}/modules/thermal_hydraulics/doc/content
modules:
root_dir: ${MOOSE_DIR}/modules/doc/content
content:
Expand All @@ -17,6 +41,7 @@ Content:
- help/finite_element_concepts/nodal_patch_recovery.md
- application_development/performance_benchmarking.md
- application_usage/restart_recover.md
- application_usage/command_line_usage.md
python:
root_dir: ${MOOSE_DIR}/python/doc/content
content:
Expand All @@ -27,6 +52,11 @@ Content:
- python/testers/**
- python/CSVDiff.md
- 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 All @@ -49,7 +79,7 @@ Extensions:
Software Quality:
Software Quality Assurance (SQA) Information: /sqa/index.md
Code Standards: sqa/fenix_scs.md
#Code Coverage: https://mooseframework.inl.gov/fenix/docs/coverage
Code Coverage: https://mooseframework.inl.gov/fenix/docs/coverage
Help:
FENIX Issues Page: https://github.com/idaholab/FENIX/issues
FENIX Discussion Forum: https://github.com/idaholab/fenix/discussions
Expand All @@ -59,26 +89,51 @@ 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
CFD: computational fluid dynamics
CAD: computer-aided design
MooseDocs.extensions.sqa:
active: true
categories:
categories: # commented-out categories are not available
fenix: !include ${ROOT_DIR}/doc/sqa_fenix.yml
framework: !include ${MOOSE_DIR}/framework/doc/sqa_framework.yml
ray_tracing: !include ${MOOSE_DIR}/modules/ray_tracing/doc/sqa_ray_tracing.yml
#chemical_reactions: !include ${MOOSE_DIR}/modules/chemical_reactions/doc/sqa_chemical_reactions.yml
electromagnetics: !include ${MOOSE_DIR}/modules/electromagnetics/doc/sqa_electromagnetics.yml
fluid_properties: !include ${MOOSE_DIR}/modules/fluid_properties/doc/sqa_fluid_properties.yml
heat_transfer: !include ${MOOSE_DIR}/modules/heat_transfer/doc/sqa_heat_transfer.yml
misc: !include ${MOOSE_DIR}/modules/misc/doc/sqa_misc.yml
navier_stokes: !include ${MOOSE_DIR}/modules/navier_stokes/doc/sqa_navier_stokes.yml
phase_field: !include ${MOOSE_DIR}/modules/phase_field/doc/sqa_phase_field.yml
reactor: !include ${MOOSE_DIR}/modules/reactor/doc/sqa_reactor.yml
rdg: !include ${MOOSE_DIR}/modules/rdg/doc/sqa_rdg.yml
ray_tracing: !include ${MOOSE_DIR}/modules/ray_tracing/doc/sqa_ray_tracing.yml
scalar_transport: !include ${MOOSE_DIR}/modules/scalar_transport/doc/sqa_scalar_transport.yml
solid_mechanics: !include ${MOOSE_DIR}/modules/solid_mechanics/doc/sqa_solid_mechanics.yml
solid_properties: !include ${MOOSE_DIR}/modules/solid_properties/doc/sqa_solid_properties.yml
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
MooseDocs.extensions.template:
active: true
MooseDocs.extensions.bibtex:
duplicates:
- hales15homogenization
- kim_phase-field_1999
- Incropera2002
- petersen
File renamed without changes.
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.
19 changes: 18 additions & 1 deletion doc/sqa_fenix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@ directories:
- ${ROOT_DIR}/test/tests
specs:
- tests
dependencies:
dependencies: # commented-out categories are not available
- framework
#- chemical_reactions
- electromagnetics
- fluid_properties
- heat_transfer
- misc
- navier_stokes
- phase_field
- reactor
- rdg
- ray_tracing
- scalar_transport
- solid_mechanics
- solid_properties
- stochastic_tools
- thermal_hydraulics
- tmap8
#- cardinal
reports: !include ${ROOT_DIR}/doc/sqa_reports.yml
15 changes: 15 additions & 0 deletions doc/sqa_reports.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,23 @@ Requirements:
working_dirs:
- ${ROOT_DIR}/doc/content
- ${MOOSE_DIR}/framework/doc/content
- ${MOOSE_DIR}/modules/chemical_reactions/doc/content
- ${MOOSE_DIR}/modules/electromagnetics/doc/content
- ${MOOSE_DIR}/modules/fluid_properties/doc/content
- ${MOOSE_DIR}/modules/heat_transfer/doc/content
- ${MOOSE_DIR}/modules/misc/doc/content
- ${MOOSE_DIR}/modules/navier_stokes/doc/content
- ${MOOSE_DIR}/modules/phase_field/doc/content
- ${MOOSE_DIR}/modules/reactor/doc/content
- ${MOOSE_DIR}/modules/rdg/doc/content
- ${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 28e8a29

Please sign in to comment.