mesh-estuary v3.2.3

Mercurial revision 5786:5c8b45563631 | 2026-08-04

Description

mesh-estuary interpolates a bathymetry and its gradient onto a given finite element (FE) mesh.

  • The bathymetry (topography) values are saved on elevation nodes.

  • The gradients are saved on velocity nodes.

Note: The mesh file must be in .nei format. If needed, use mesh-format to convert from other formats (e.g., GMSH).

Usage

mesh-estuary -m MESH_FILE -b BATHYMETRY_FILE

Options

Option

Description

-h, --help

Print this help and exit.

-m <file>

Path to the mesh file (.nei format) on which to interpolate the bathymetry.

-b <file>

Path to the bathymetry file (NetCDF or .grd format).

--debug

Enable debug mode.

Deprecated Options

⚠️ Warning: These options are no longer supported and may be removed in future versions.

Option

Description

--smoothed <n>

Number of smoothing iterations (deprecated).

-f <file>

Boundary file (deprecated).

-p <file>

Polygon file to limit the working area (deprecated).

-o <file>

Output file name (deprecated).

-d <descriptor>

Discretization element pair (e.g., LGP0xLGP1, DGP1xLGP2, DNP1xLGP2, Q1xQ0) (deprecated).

-z <zone>

Zone file (deprecated).

-s <meshsize>

Mesh size (deprecated).

Examples

Basic Usage

Interpolate bathymetry onto a mesh:

mesh-estuary -m mesh.nei -b bathymetry.nc

Debug Mode

Enable debug mode for troubleshooting:

mesh-estuary --debug -m mesh.nei -b bathymetry.grd

Environment Variables

None.

Notes

  1. Input Files:

  • The mesh file must be in .nei format. Use mesh-format to convert from other formats if necessary.

  • The bathymetry file must be in NetCDF or .grd format.

  1. Output:

  • The interpolated bathymetry is saved on elevation nodes of the mesh.

  • The gradients are saved on velocity nodes of the mesh.

  1. Debugging:

  • Use --debug to print additional information during execution.

  1. Deprecated Options:

  • Avoid using deprecated options, as they may not be supported in future versions.

See Also