Conversation
Contributor
There was a problem hiding this comment.
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_wavefieldsAPI entry from the compute namespace docs. - Renamed references in architecture docs from
update_wavefieldstoupdate_medium. - Updated the example Kokkos kernel label string from
update_wavefieldstoupdate_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) |
| ├── compute_derivatives + update_medium (acoustic) | ||
| ├── time_scheme.apply_corrector(acoustic) | ||
| ├── compute_derivatives + update_wavefields (elastic) | ||
| ├── compute_derivatives + update_medium (elastic) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.