From 9c85597575b4aa8ba9e4ad645d0720823466ff4e Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:15:40 -0600 Subject: [PATCH 1/6] remove scalar from valid grid types --- docs/source/bmi.grid_funcs.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/bmi.grid_funcs.md b/docs/source/bmi.grid_funcs.md index a04116c..60f5401 100644 --- a/docs/source/bmi.grid_funcs.md +++ b/docs/source/bmi.grid_funcs.md @@ -58,7 +58,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` From 2d61fee7f86823848b36a0483f673e62c70ef6b5 Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:20:40 -0600 Subject: [PATCH 2/6] modify text to indicate not all vars will have a grid --- docs/source/bmi.grid_funcs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/bmi.grid_funcs.md b/docs/source/bmi.grid_funcs.md index 60f5401..1e1bfac 100644 --- a/docs/source/bmi.grid_funcs.md +++ b/docs/source/bmi.grid_funcs.md @@ -4,7 +4,7 @@ The functions in this section describe {ref}`model grids `. In the BMI, -every {term}`exchange item` is defined on a grid, +if an {term}`exchange item` is defined on a grid, 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. From 7febb1f2f75a660f239511eb6bd8e20af45179d8 Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:21:55 -0600 Subject: [PATCH 3/6] remove example that used a scalar grid --- docs/source/bmi.grid_funcs.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/source/bmi.grid_funcs.md b/docs/source/bmi.grid_funcs.md index 1e1bfac..fdcb7f8 100644 --- a/docs/source/bmi.grid_funcs.md +++ b/docs/source/bmi.grid_funcs.md @@ -10,12 +10,6 @@ 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. From 34bbd24f4a37377470176942b653c8ffd37e6832 Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:53:27 -0600 Subject: [PATCH 4/6] remove reference to scalar grids in unstructed grids section --- docs/source/model_grids.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/model_grids.md b/docs/source/model_grids.md index 6f866fe..0e555fe 100644 --- a/docs/source/model_grids.md +++ b/docs/source/model_grids.md @@ -131,8 +131,8 @@ Structured quadrilateral grids use the following BMI functions: ``` This category includes the *unstructured* type, -as well as the special cases -*scalar*, *points*, and *vector*. +as well as the special case of a grid of *points* (i.e. +unconnected nodes). This is the most general grid type. It can be used for any type of grid. This grid type must be used if the grid consists of cells From ad080ab293f9d479ab441ba9ef28f710f1845eb4 Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:53:59 -0600 Subject: [PATCH 5/6] remove reference to scalar grids in best practices section --- docs/source/bmi.best_practices.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/bmi.best_practices.md b/docs/source/bmi.best_practices.md index 75e9ddd..940d509 100644 --- a/docs/source/bmi.best_practices.md +++ b/docs/source/bmi.best_practices.md @@ -38,10 +38,10 @@ here are some tips to help when writing a BMI for a model. coupling models written in different languages. It's the developer's responsibility to ensure that array information is flattened/redimensionalized in the correct order. -- Recall that models can have multiple grids. This can be particularly - useful for defining {term}`exchange items ` that - don't vary over the model domain; e.g., a diffusivity -- just define - the variable on a separate {ref}`scalar grid `. +- Recall that model variables do not have to be attached to a grid. + This can be useful for defining {term}`exchange items ` + that don't vary over the model domain. +- Models can have multiple grids. - Avoid using global variables, if possible. This isn't strictly a BMI requirement, but if a model only uses local variables, its BMI will be self-contained. This may allow multiple instances of the model to From cbaf58b0c73fce21a585c38cf3f6df4252e498f3 Mon Sep 17 00:00:00 2001 From: mcflugen Date: Mon, 2 Jun 2025 08:54:47 -0600 Subject: [PATCH 6/6] remove text saying var location is ignored for scalars --- docs/source/bmi.var_funcs.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/source/bmi.var_funcs.md b/docs/source/bmi.var_funcs.md index c283b71..a8b7819 100644 --- a/docs/source/bmi.var_funcs.md +++ b/docs/source/bmi.var_funcs.md @@ -304,8 +304,6 @@ element the variable is defined. Valid return values are: 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 `), the location from this function is ignored. :::{include} links.md :::