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

Improve documentation on fluids / physics table #11

Closed
haraldkl opened this issue Mar 26, 2024 · 2 comments
Closed

Improve documentation on fluids / physics table #11

haraldkl opened this issue Mar 26, 2024 · 2 comments
Assignees

Comments

@haraldkl
Copy link
Member

The documentation on the fluids/physics table is currently not sufficiently good to allow new users to easily grasp what is needed and how material parameters for the simulation are to be set.
I believe, the explanation currently is found in examples, and it does not provide the necessary information. Rather, there is a lot of text on the SI System, which isn't really needed there. It also says that physical and LBM units have to be provided, though a conversion between them is possible.

An explanation on the specific variables that are actually read by Musubi and the logic behind them and their necessity, aswell as guides on how to obtain them from physical units or similarity numbers, that users would expect.

@haraldkl
Copy link
Member Author

haraldkl commented May 8, 2024

Now that we have #14 merged, could we address this issue?

@haraldkl
Copy link
Member Author

This was fixed by #26.

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

2 participants