trixi-framework/Trixi.jl

Missing documentation of source_terms

Open

#1925 opened on Apr 30, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Julia (686 stars) (153 forks)batch import
documentationgood first issue

Description

The source_terms parameter of the SemidiscretizationHyperbolic is not really documented anywhere outside of the full Trixi.jl API page (briefly mentioned on the Behind the scenes of a simulation setup page), so how to add source terms to a simulation can be seen only from various examples relying on the method of manufactured solutions. I feel like some explicit example of how source terms work would be helpful (and would also show up in various related searches, e.g. googling for "trixi.jl" "source term" mostly points to the full API reference page).

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic familiarity with Trixi.jlUnderstanding of hyperbolic conservation laws
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the existing documentation for SemidiscretizationHyperbolic in the docs folder. Look at the source code for the source terms parameter to understand its usage. Review existing examples that use source terms, particularly those relying on the method of manufactured solutions. Write a clear example and add it to the documentation page. Consider adding a link from the API reference.