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 of mesh2d_delete_small_flow_edges_and_small_triangles #161

Open
veenstrajelmer opened this issue Apr 22, 2024 · 0 comments
Labels
chore Changes to the build process or auxiliary tools and libraries such as documentation generation

Comments

@veenstrajelmer
Copy link

What is the need for this task.
The function mesh2d_delete_small_flow_edges_and_small_triangles raises several questions.

What is the task?
There was an explanation given in Deltares/dfm_tools#812 (comment) about mesh2d_delete_small_flow_edges_and_small_triangles. This function is also documented, but this is a bit less clear than in the issue comment. I suggest to slightly clarify this:

"""Deletes all small mesh2d flow edges and small triangles.
The flow edges are the edges connecting faces circumcenters.
Args:
small_flow_edges_length_threshold (float): The configurable length for detecting a small flow edge.
min_fractional_area_triangles (float): The ratio of the face area to the average area of neighboring
non-triangular faces. This parameter is used for determining whether
a triangular face is small.

It would also be good if sensible argument default vlaues are set or mentioned in the docstring.

@veenstrajelmer veenstrajelmer added the chore Changes to the build process or auxiliary tools and libraries such as documentation generation label Apr 22, 2024
@veenstrajelmer veenstrajelmer changed the title Improve documentation of Improve documentation of mesh2d_delete_small_flow_edges_and_small_triangles Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Changes to the build process or auxiliary tools and libraries such as documentation generation
Projects
None yet
Development

No branches or pull requests

1 participant