trixi-framework/Trixi.jl

Missing documentation of source_terms

Open

#1.925 geöffnet am 30. Apr. 2024

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Julia (153 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (686 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 19T 17h) (36 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Studieren Sie die vorhandenen Beispiele, die die Methode der hergestellten Lösungen für Quellterme verwenden, und erstellen Sie dann ein klares Beispiel in der Dokumentation, das die Verwendung des Parameters source terms in SemidiscretizationHyperbolic zeigt.
Tech Stack
julia
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJulia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80