Issue 1391 - Updates the documentation for timescheme

[lsawade]

Description

Updates and clarifies structure of the timescheme module and updates the documentation.

Commits

• Updated the timescheme documentation (403dec1)

Issue Number

Closes #1391

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]

Pull request overview

This PR reorganizes and clarifies the documentation structure for the timescheme module, moving it from the "Old structure" to the "New structure" under the specfem namespace. The changes include splitting monolithic header files into separate, focused files with improved documentation.

• Extracted time iterator classes into a dedicated impl/time_iterators.hpp file
• Split the base time_scheme class into its own header file timescheme/timescheme.hpp
• Enhanced documentation with mathematical formulas and usage examples for Newmark predictor/corrector phases
• Updated Doxygen configuration to support .tpp template implementation files

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
docs/sections/api/timescheme/newmark_forward.rst	Removed old location documentation file
docs/sections/api/timescheme/newmark_combined.rst	Removed old location documentation file
docs/sections/api/timescheme/newmark.rst	Removed old location documentation file
docs/sections/api/timescheme/index.rst	Removed old location documentation index
docs/sections/api/specfem/timescheme/timescheme.rst	Added documentation for base time_scheme class in new location
docs/sections/api/specfem/timescheme/newmark_forward.rst	Added documentation for forward Newmark specialization with updated template parameters
docs/sections/api/specfem/timescheme/newmark_combined.rst	Added documentation for combined simulation Newmark specialization with updated template parameters
docs/sections/api/specfem/timescheme/newmark.rst	Added comprehensive documentation for Newmark scheme with implementation details
docs/sections/api/specfem/timescheme/index.rst	Added new namespace-level documentation index
docs/sections/api/specfem/index.rst	Integrated timescheme documentation into specfem API structure
docs/sections/api/index.rst	Removed timescheme from old structure section
docs/Doxyfile.in	Added .tpp file support for template implementations
core/specfem/timescheme/timescheme.hpp	Created separate header for base time_scheme class with improved documentation
core/specfem/timescheme/newmark.tpp	Enhanced documentation with mathematical formulas, moved functions to newmark_impl namespace
core/specfem/timescheme/newmark.hpp	Added comprehensive documentation with usage examples for forward and combined simulations
core/specfem/timescheme/impl/time_iterators.hpp	Extracted iterator classes into dedicated header file with documentation
core/specfem/timescheme.hpp	Refactored to namespace documentation and includes for modular structure

---

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

[Rohit-Kakodkar]

There are some missing member functions that need to be documented. Otherwise looks good.