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

Inconsistency in get_grid_size for unstructured grids #133

Open
BSchilperoort opened this issue Oct 25, 2023 · 3 comments
Open

Inconsistency in get_grid_size for unstructured grids #133

BSchilperoort opened this issue Oct 25, 2023 · 3 comments

Comments

@BSchilperoort
Copy link

In the model grid overview for unstructured grids, the function get_grid_size is not listed.

However, in the SIDL overview it states the following:

This function is needed for every grid type.

The grid size is used for, among other things, the length of arrays returned by get_grid_x and get_grid_y for unstructured and structured quad grids.

Seeing as the functionality of get_grid_size for unstructured grids is identical to get_node_count I am not sure if it's actually required.

@mdpiper
Copy link
Member

mdpiper commented Oct 25, 2023

@BSchilperoort Thank you for catching this! I think I'll make a note on this in the model grid overview--I don't want to change the main page of the docs without a release. When I write the PR, may I tag you on it for review and approval?

Seeing as the functionality of get_grid_size for unstructured grids is identical to get_node_count I am not sure if it's actually required.

We've thought about deprecating get_grid_size universally in favor of get_grid_node_count because of this.

@mdpiper
Copy link
Member

mdpiper commented Oct 25, 2023

@BSchilperoort Also, if you have a recommendation for how to address this issue, I'd welcome it.

@BSchilperoort
Copy link
Author

When I write the PR, may I tag you on it for review and approval?

Yeah feel free to tag me.

We've thought about deprecating get_grid_size universally in favor of get_grid_node_count because of this.

This sounds like a good solution to me. It is more generic and will work for all grid types.

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