trixi-framework/Trixi.jl

Missing documentation of source_terms

Open

Aperta il 30 apr 2024

Vedi su GitHub
 (2 commenti) (1 reazione) (0 assegnatari)Julia (686 star) (153 fork)batch import
documentationgood first issue

Descrizione

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).

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic familiarity with Trixi.jlUnderstanding of hyperbolic conservation laws
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75
Direzione di ricerca
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.