hydromodpy.spatial.mesh.gmsh_grid.exchange_api

Expose the simplest public I/O API for the solver-independent Gmsh workflow.

This module is the entry point to use when a caller only needs to load or save 2D meshes, 3D extruded meshes, or 3D values attached to prisms. It deliberately hides the lower-level implementation modules so colleagues can work with a small and stable surface.

Functions

load_extruded_as_hydro_mesh(path)	Read one extruded mesh and convert it directly to the generic HydroMesh.
load_extruded_mesh(path)	Read one extruded 3D prism mesh from disk.
load_extruded_mesh_values(path, *[, ...])	Read one 3D prism mesh together with the scalar values attached to prisms.
load_hydro_mesh_vtu(path)	Read a HydroMesh from a VTU file.
load_planar_as_hydro_mesh(path, *[, cell_type])	Read one planar mesh and convert it directly to the generic HydroMesh.
load_planar_mesh(path, *[, cell_type])	Read one 2D planar mesh into the package-level mesh object.
save_extruded_mesh(mesh, path, *[, file_format])	Write one extruded 3D prism mesh to disk.
save_extruded_mesh_values(mesh_with_values, ...)	Write one valued 3D prism mesh to disk.
save_extruded_values_npy(mesh_with_values, path)	Write the canonical (n_layers, n_cells_2d) value array to .npy.
save_extruded_values_summary(...)	Write a compact JSON summary of attached 3D prism values.
save_hydro_mesh_vtu(hydro_mesh, path)	Write a HydroMesh to a VTU file (any topology, 2D or 3D).
save_planar_mesh(mesh, path, *[, file_format])	Write one planar mesh through the stable package I/O surface.