mpas_tools.ocean.build_mesh.build_planar_mesh

mpas_tools.ocean.build_mesh.build_planar_mesh(cellWidth, x, y, geom_points, geom_edges, out_filename='base_mesh.nc', vtk_dir='base_mesh_vtk', preserve_floodplain=False, floodplain_elevation=20.0, do_inject_bathymetry=False, logger=None, use_progress_bar=True)[source]

Build a planar MPAS mesh

Parameters:

  • cellWidth (ndarray) – m x n array of cell width in km

  • x (ndarray) – arrays defining planar coordinates in meters

  • y (ndarray) – arrays defining planar coordinates in meters

  • geom_points (ndarray) – list of point coordinates for bounding polygon for the planar mesh

  • geom_edges (ndarray) – list of edges between points in geom_points that define the bounding polygon

  • out_filename (str, optional) – The file name of the resulting MPAS mesh

  • vtk_dir (str, optional) – The name of the directory where mesh data will be extracted for viewing in ParaVeiw.

  • preserve_floodplain (bool, optional) – Whether a flood plain (bathymetry above z = 0) should be preserved in the mesh

  • floodplain_elevation (float, optional) – The elevation in meters to which the flood plain is preserved

  • do_inject_bathymetry (bool, optional) – Whether one of the default bathymetry datasets, earth_relief_15s.nc or topo.msh, should be added to the MPAS mesh

  • logger (logging.Logger, optional) – A logger for the output if not stdout

  • use_progress_bar (bool, optional) – Whether to display progress bars (problematic in logging to a file)