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.