Skip to content

Remove text referencing scalar grid types #184

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
mcflugen wants to merge 6 commits into
base: stable
Choose a base branch
from
Open

Remove text referencing scalar grid types #184

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9c85597
remove scalar from valid grid types
mcflugen Jun 2, 2025
2d61fee
modify text to indicate not all vars will have a grid
mcflugen Jun 2, 2025
7febb1f
remove example that used a scalar grid
mcflugen Jun 2, 2025
34bbd24
remove reference to scalar grids in unstructed grids section
mcflugen Jun 2, 2025
ad080ab
remove reference to scalar grids in best practices section
mcflugen Jun 2, 2025
cbaf58b
remove text saying var location is ignored for scalars
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
9 changes: 1 addition & 8 deletions docs/source/bmi.grid_funcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,12 @@

The functions in this section describe {ref}`model grids <model-grids>`.
In the BMI,
every {term}`exchange item` is defined on a grid,
if an {term}`exchange item` is defined on a grid,

Copilot AI Jun 2, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider clarifying that not all exchange items are defined on a grid, and explicitly mention that variables without a grid will have their get_var_location return 'none'.

Copilot uses AI. Check for mistakes.
and is referenced by a {term}`grid identifier`
returned from the {ref}`get-var-grid` function.
This identifier is a required input to the functions listed below.

A model can have multiple grids.
For example,
consider modeling the diffusion of temperature over a flat plate.
One grid could be a uniform rectilinear grid on which
temperature is defined.
A second grid could be a scalar,
on which a constant thermal diffusivity is defined.

Not all grid functions are used by each type of grid.
However, all BMI grid functions must be implemented.
Expand Down Expand Up @@ -58,7 +52,6 @@ However, all BMI grid functions must be implemented.
Given a {term}`grid identifier`, get the type of that grid as a string.
Valid grid types are:

- `scalar`
- `points`
- `vector`
- `unstructured`
Expand Down