Skip to content

Rename d_mesh_static dimension to follow canonical naming convention #687

Description

@joeloskarsson

Background

PR #635 added a "Canonical dimension names" list to the README, including:

  • d_mesh_static - number of static features per mesh node

In review of PR #635 it was noted that d_mesh_static doesn't
match the naming pattern of the other canonical names: num_* for counts (num_state_vars, num_forcing_vars, num_grid_nodes,
num_mesh_nodes) and *_dim for feature sizes (hidden_dim, input_dim). The d_-prefix follows neither.

Proposal

Rename d_mesh_static to num_mesh_static_vars, matching the num_* family.

Scope

The name predates #635 and also appears in code comments/docstrings, which should be updated together:

Separately, surrounding comments use ad-hoc node-count names (N_mesh, N_mesh_nodes_level) instead of the canonical
num_mesh_nodes. Would be good to also fix

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions