Skip to content

Update docs for update_wavefields#1971

Open
icui wants to merge 1 commit into
develfrom
docs-wf
Open

Update docs for update_wavefields#1971
icui wants to merge 1 commit into
develfrom
docs-wf

Conversation

@icui

@icui icui commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Description

Update naming in docs.

Issue Number

If there is an issue created for these changes, link it here

Checklist

Please make sure to check developer documentation on specfem docs.

  • I ran the code through pre-commit to check style
  • THE DOCUMENTATION BUILDS WITHOUT WARNINGS/ERRORS
  • I have added labels to the PR (see right hand side of the PR page)
  • My code passes all the integration tests
  • I have added sufficient unittests to test my changes
  • I have added/updated documentation for the changes I am proposing
  • I have updated CMakeLists to ensure my code builds
  • My code builds across all platforms

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation to reflect the renaming/removal of the (previously documented) update_wavefields concept, aligning the architecture docs with the current update_medium naming used by the solver implementation.

Changes:

  • Removed the specfem::compute::update_wavefields API entry from the compute namespace docs.
  • Renamed references in architecture docs from update_wavefields to update_medium.
  • Updated the example Kokkos kernel label string from update_wavefields to update_medium.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/sections/api/specfem/compute/index.rst Removes the stale update_wavefields API entry from the specfem::compute docs index.
architecture/type-system/template-patterns.md Updates the Kokkos parallel_for example label string to update_medium.
architecture/simulation/workflow.md Renames workflow steps to update_medium in the canonical forward-simulation sequence.
architecture/core-components/medium-physics.md Removes update_wavefields from the compute-kernel orchestration table.
architecture.md Updates architecture-level function table/workflow references to update_medium and removes update_wavefields.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

├── compute_derivatives + update_medium (acoustic)
├── time_scheme.apply_corrector(acoustic)
├── compute_derivatives + update_wavefields (elastic)
├── compute_derivatives + update_medium (elastic)
Comment thread architecture.md
├── compute_derivatives + update_medium (acoustic)
├── time_scheme.apply_corrector(acoustic)
├── compute_derivatives + update_wavefields (elastic)
├── compute_derivatives + update_medium (elastic)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants