Add docs particle packing#797
Merged
efaulhaber merged 7 commits intotrixi-framework:mainfrom May 21, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the particle packing process and updates the ParticlePackingSystem interface to allow an optional signed distance field, while adjusting some default parameter values.
- Updated ParticlePackingSystem parameter types and defaults (e.g., tlsph from true to false)
- Expanded and clarified documentation in both the Julia source and the markdown files
- Added a new reference entry in the bibliography for the particle packing methodology
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/preprocessing/particle_packing/system.jl | Updated parameter types/defaults and documentation for ParticlePackingSystem |
| docs/src/refs.bib | Added reference for particle packing from Zhu et al. (2021) |
| docs/src/preprocessing/preprocessing.md | Added comprehensive documentation for the Particle Packing workflow |
Comments suppressed due to low confidence (2)
src/preprocessing/particle_packing/system.jl:3
- Ensure that downstream code properly handles the case when 'signed_distance_field' is Nothing to avoid potential runtime errors.
signed_distance_field::Union{SignedDistanceField, Nothing},
docs/src/preprocessing/preprocessing.md:259
- Verify that the new reference identifiers and links in the Particle Packing section correctly map to the intended sections and figures.
# [Particle Packing](@id particle_packing)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #797 +/- ##
=======================================
Coverage 70.68% 70.68%
=======================================
Files 106 106
Lines 6703 6703
=======================================
Hits 4738 4738
Misses 1965 1965
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
svchb
requested changes
May 12, 2025
added 2 commits
May 15, 2025 16:53
efaulhaber
requested changes
May 19, 2025
svchb
approved these changes
May 21, 2025
efaulhaber
approved these changes
May 21, 2025
Member
|
/run-gpu-tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.