trixi-framework/Trixi.jl

Missing documentation of source_terms

Open

#1,925 建立於 2024年4月30日

在 GitHub 查看
 (2 留言) (1 反應) (0 負責人)Julia (686 star) (153 fork)batch import
documentationgood first issue

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic familiarity with Trixi.jlUnderstanding of hyperbolic conservation laws
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
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.