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

Mesh::firstX() doc is confusing #3012

Open
dschwoerer opened this issue Oct 25, 2024 · 1 comment
Open

Mesh::firstX() doc is confusing #3012

dschwoerer opened this issue Oct 25, 2024 · 1 comment

Comments

@dschwoerer
Copy link
Contributor

The documentation of Mesh::firstX() sounds like it would return always false for x-periodic grids, but it does not:
https://github.com/boutproject/BOUT-dev/blob/master/src/mesh/impls/bout/boutmesh.hxx#L69
https://github.com/boutproject/BOUT-dev/blob/master/src/mesh/impls/bout/boutmesh.cxx#L1488

Is that intentional? Should I fix the comment?

@ZedThree
Copy link
Member

From a quick look, it seems most places are using it in the sense of the comment (that is, checking if there's a boundary, and if so, use one-sided differences), so I suspect that they wouldn't handle periodic X correctly/very well

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