hydromt.model.components.MeshComponent.get_mesh#

MeshComponent.get_mesh(grid_name: str, include_data: bool = False) Ugrid1d | Ugrid2d | UgridDataArray | UgridDataset[source]#

Return a specific grid topology from mesh based on grid_name.

If include_data is True, the data variables for that specific grid are also included.

Parameters:
  • grid_name (str) – Name of the grid to return.

  • include_data (bool, optional) – If True, also include data variables, by default False.

Returns:

uds – Grid topology with or without data variables.

Return type:

Union[xu.Ugrid1d, xu.Ugrid2d, xu.UgridDataArray, xu.UgridDataset]