Skip to content

Add none location to get_var_location #183

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: stable
Choose a base branch
from
Open

Add none location to get_var_location #183

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e27a8c7
add "none" location to get_var_location description
mcflugen May 31, 2025
17844c8
add note about grid location of none
mcflugen Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/bmi.var_funcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,15 +297,17 @@ element the variable is defined. Valid return values are:
- `node`
- `edge`
- `face`
- `none`

A value of `none` indicates the variable is not attached to a grid and
that `get_var_grid` will not be implemented for this variable.

**Implementation notes**

- In C++, Java, and Python, the *location* argument is omitted and the location
is returned from the function.
- In C and Fortran, an integer status code indicating success (zero) or failure
(nonzero) is returned.
- If the given variable is a scalar (i.e., defined on a {ref}`scalar
grid <unstructured-grids>`), the location from this function is ignored.

:::{include} links.md
:::