Repository navigation
Update README to remove friction when NoSlip boundary condition is used - #41
Open
AJamesPhillips wants to merge 1 commit into
Open
AJamesPhillips wants to merge 1 commit into
AJamesPhillips wants to merge 1 commit into
Conversation
AJamesPhillips
force-pushed
the
update_readme_no_friction_for_NoSlip
branch
from
September 27, 2026 20:18
6ce4071 to
e21afb3
Compare
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.
I may have misunderstood the boundary_collision.cpp code but I'd interpret this as ignoring the friction value when the boundary condition (BC) is NoSlip?
In the README, the C++ and Python example code set a friction value when the boundary condition (BC) is NoSlip which as a new user I found confusing:
sim.plates.push_back(std::make_unique<ObjectPlate>( /*position*/ 0, /*type*/ PlateType::bottom, /*BC*/ BC::NoSlip, /*friction*/ 0.5 ));I'm not sure if either you'd like to comment to help the user understand that the
0.5value is friction and that it will be ignored when BC is NoSlip. Or if you'd prefer it was removed.Amazing library by the way. Thanks so much for developing and sharing it.