trixi-framework / trixi-framework/TrixiParticles.jl

Non-public API is used in sampling example without comment

Open
#846 1 comment 0 reactions 1 assignee View on GitHub

@LasNikas is already working on this.

Since Jun 26, 2025.

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

Description

The complex_shape_2d.jl uses

shape_sampled = ComplexShape(geometry; particle_spacing, density=1.0,
                             store_winding_number=true,
                             point_in_geometry_algorithm)

where store_winding_number is not public API. I just copied this code and was wondering why the packing didn't work. The reason is that with this kwarg set to true, a NamedTuple is returned instead of an InitialCondition. This is very confusing.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.