Skip to content
Open
Changes from all commits
Commits
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
14 changes: 12 additions & 2 deletions docs/source/bmi.var_funcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,15 +297,25 @@ element the variable is defined. Valid return values are:
- `node`
- `edge`
- `face`
- `none` (see note)

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.

:::{attention}

The return value `"none"` from `get_var_location` is not part of the current
BMI specification, but has seen informal use to indicate variables not tied
to a grid location. This usage may be formally supported in a future version
of the specification.
:::

**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
:::