trixi-framework / trixi-framework/TrixiParticles.jl

IISPH docs are confusing

Open
#911 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
83
Forks
24
Avg merge
8d 18h
Merged PRs (30d)
3

Description

Image In the IISPH docs (#751), this part is a bit confusing. `d_{ij}` is actually only defined for `i != j`. If we set `j = i`, we get zero, because `\nabla W_ii` is zero. We do not get the `d_{ii}` that is defined as the first sum. I think it would be less confusing if the second sum was written as `\sum_{j \neq i}` with a comment below "note that the second sum does not contain `i`, as `\nabla W_{ii} = 0`".

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the IISPH documentation referenced in #751 and locate the displayed definition involving d_{ij} and the second sum. Compare the notation with the issue's explanation of the i = j case, then update the formula or nearby note so the exclusion of i is unambiguous and verify the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.