Skip to content

Update README to remove friction when NoSlip boundary condition is used - #41

Open
AJamesPhillips wants to merge 1 commit into
larsblatny:masterfrom
AJamesPhillips:update_readme_no_friction_for_NoSlip
Open

AJamesPhillips wants to merge 1 commit into
larsblatny:masterfrom
AJamesPhillips:update_readme_no_friction_for_NoSlip

Conversation

@AJamesPhillips

Copy link
Copy Markdown

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?

if (obj->bc == BC::NoSlip) {
    vx_rel = 0;
    vy_rel = 0;
    vz_rel = 0;
} // end BC::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
));
sim.add_plate(matter.ObjectPlate(0, matter.PlateType.bottom, matter.BC.NoSlip, 0.5))

I'm not sure if either you'd like to comment to help the user understand that the 0.5 value 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.

@AJamesPhillips
AJamesPhillips force-pushed the update_readme_no_friction_for_NoSlip branch from 6ce4071 to e21afb3 Compare September 27, 2026 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant