From 125254a1f521f33400b73bf0e0842a1fa5d4beb8 Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Mon, 21 Oct 2024 08:43:20 +0200 Subject: [PATCH] Remove list of attributes, refer to API docs --- docs/user-guide/dfsu.qmd | 31 ------------------------------- 1 file changed, 31 deletions(-) diff --git a/docs/user-guide/dfsu.qmd b/docs/user-guide/dfsu.qmd index ba522ffa4..160d1bcf8 100644 --- a/docs/user-guide/dfsu.qmd +++ b/docs/user-guide/dfsu.qmd @@ -36,37 +36,6 @@ In MIKE Zero, node ids, element ids and layer ids are 1-based. In MIKE IO, all MIKE IO has Flexible Mesh Geometry classes, e.g. [`GeometryFM2D`](`mikeio.spatial.GeometryFM2D`), containing the list of node coordinates and the element table which defines the mesh, as well as a number of derived properties (e.g. element coordinates) and methods making it convenient to work with the mesh. -| Property | Description | -|----------|--------------| -| `n_nodes` | Number of nodes | -| `node_coordinates` | Coordinates (x,y,z) of all nodes | -| `codes` | Codes of all nodes (0:water, 1:land, >=2:open boundary) | -| `boundary_polylines` | Lists of closed polylines defining domain outline | -| `n_elements` | Number of elements | -| `element_coordinates` | Center coordinates of each element | -| `element_table` | Element to node connectivity | -| `max_nodes_per_element` | The maximum number of nodes for an element | -| `is_tri_only` | Does the mesh consist of triangles only? | -| `projection_string` | The projection string | -| `is_geo` | Are coordinates geographical (LONG/LAT)? | -| `is_local_coordinates` | Are coordinates relative (NON-UTM)? | -| `type_name` | Type name, e.g. Dfsu2D| - - -| Method | Description | -|----------|--------------| -| `contains()` | test if a list of points are contained by mesh | -| `find_index()` | Find index of elements containing points/area| -| `isel()` | Get subset geometry for list of indicies | -| `find_nearest_points()` | Find index of nearest elements (optionally for a list) | -| `plot` | Plot the geometry | -| `get_overset_grid()` | Get a Grid2D covering the domain | -| `to_shapely()` | Export mesh as shapely MultiPolygon | -| `get_element_area()` | Calculate the horizontal area of each element | - - -These properties and methods are accessible from the geometry, but also from the Mesh/Dfsu object. - If a .dfsu file is *read* with [](`mikeio.read`), the returned Dataset ds will contain a Flexible Mesh Geometry `geometry`. If a .dfsu or a .mesh file is *opened* with [](`mikeio.open`), the returned object will also contain a Flexible Mesh Geometry `geometry`. ```{python}