Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for SetPhases is out of date. #133

Open
ixchow opened this issue Feb 9, 2022 · 0 comments
Open

Documentation for SetPhases is out of date. #133

ixchow opened this issue Feb 9, 2022 · 0 comments

Comments

@ixchow
Copy link

ixchow commented Feb 9, 2022

The documentation for NvFlexSetPhases (and the html generated from it) says:

Particles with a non-zero phase id only interact with particles whose phase differs from theirs. This is useful, for example, to stop particles belonging to a single rigid shape from interacting with each other.

However the current version of FleX has quite a bit more flexibility in what phase means; see (e.g.) the NvFlexPhase enum. I suggest this paragraph be removed or modified to point to that enum.

It also says:

Phase 0 is used to indicate fluid particles when NvFlexParams::mFluid is set.

This references a parameter (mFluid) that does not exist. I suggest this paragraph be removed.

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

No branches or pull requests

1 participant