Nodes, Links, and Patches

Raster

Nodes

active_adjacent_nodes_at_node	Adjacent nodes for each grid node.
active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
adjacent_nodes_at_node	Get adjacent nodes.
all_node_azimuths_map	Get azimuths from every node to every other node.
all_node_distances_map	Get distances from every node to every other node.
boundary_nodes	Get array of boundary nodes.
calc_aspect_at_node	Get array of aspect of a surface.
calc_distances_of_nodes_to_point	Get distances for nodes to a given point.
calc_flux_div_at_cell	Calculate divergence of link-based fluxes at cells.
calc_flux_div_at_node	Calculate divergence of link-based fluxes at nodes.
calc_grad_along_node_links	grid.calc_grad_along_node_links(node_values, [cell_ids], out=None)
calc_hillshade_at_node	Get array of hillshade.
calc_net_flux_at_node	Calculate net link fluxes at nodes.
calc_slope_at_node	Array of slopes at nodes, averaged over neighboring patches.
calculate_slope_aspect_at_nodes_burrough	Calculate topographic slope.
cell_area_at_node	Cell areas in a nnodes-long array.
closed_boundary_nodes	Get array of closed boundary nodes.
core_nodes	Get array of core nodes.
d8s_at_node	Links and diagonals attached to nodes.
diagonal_adjacent_nodes_at_node	Get adjacent nodes along diagonals.
diagonals_at_node	Diagonals attached to nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
find_nearest_node	Node nearest a point.
fixed_gradient_boundary_nodes	Get array of fixed gradient boundary nodes.
fixed_value_boundary_nodes	Get array of fixed value boundary nodes.
grid_coords_to_node_id	Convert node indices to node ID.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_max_of_inlinks_to_node	Map the maximum of links entering a node to the node.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_outlinks_to_node	Map the max of links leaving a node to the node.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_horizontal_active_links_to_node	Map the mean of active links in the x direction touching node to the node.
map_mean_of_horizontal_links_to_node	Map the mean of links in the x direction touching a node to the node.
map_mean_of_inlinks_to_node	Map the mean of links entering a node to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_links_to_node	Map the mean of links touching a node to the node.
map_mean_of_outlinks_to_node	Map the mean of links leaving a node to the node.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_mean_of_vertical_active_links_to_node	Map the mean of active links in the y direction touching node to the node.
map_mean_of_vertical_links_to_node	Map the mean of links in the y direction touching a node to the node.
map_min_of_inlinks_to_node	Map the minimum of links entering a node to the node.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_outlinks_to_node	Map the min of links leaving a node to the node.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
map_node_to_cell	Map values for nodes to cells.
map_sum_of_inlinks_to_node	Map the sum of links entering a node to the node.
map_sum_of_outlinks_to_node	Map the sum of links leaving a node to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
node_at_core_cell	Get array of nodes associated with core cells.
node_at_link_head	Get nodes at link head.
node_at_link_tail	Get nodes at link tail.
node_axis_coordinates	Get the coordinates of nodes along a particular axis.
node_has_boundary_neighbor	Check if nodes have neighbors that are boundary nodes.
node_is_boundary	Check if nodes are boundary nodes.
node_vector_to_raster	Unravel an array of node values.
nodes_around_point	Get the nodes surrounding a point.
nodes_at_link	Get nodes at either end of links.
nodes_at_patch	Get the nodes that define a patch.
number_of_cell_columns	Number of cell columns.
number_of_core_nodes	Number of core nodes.
number_of_interior_nodes	Number of interior nodes.
number_of_nodes	Get total number of nodes.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
open_boundary_nodes	Get array of open boundary nodes.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
roll_nodes_ud	Roll (shift) specified data on nodes up or down in a raster grid.
set_nodata_nodes_to_closed	Make no-data nodes closed boundaries.
set_nodata_nodes_to_fixed_gradient	Make no-data nodes fixed gradient boundaries.
status_at_node	Get array of the boundary status for each node.
unit_vector_sum_xcomponent_at_node	Get array of x-component of unit vector sums at each node.
unit_vector_sum_ycomponent_at_node	Get array of y-component of unit vector sums at each node.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).
x_of_node	Get x-coordinate of node.
xy_of_node	Get x and y-coordinates of node.
y_of_node	Get y-coordinate of node.

Links

active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
active_links	Get array of active links.
angle_of_link	Get the angle of each link.
angle_of_link_about_head	Find and return the angle of a link about the node at the link head.
calc_diff_at_d8	Calculate differences of node values over links and diagonals.
calc_diff_at_diagonal	Calculate differences of node values over diagonals.
calc_diff_at_link	Calculate differences of node values over links.
calc_grad_along_node_links	grid.calc_grad_along_node_links(node_values, [cell_ids], out=None)
calc_grad_at_d8	Calculate gradients over all diagonals and links.
calc_grad_at_diagonal	Calculate gradients over all diagonals.
calc_grad_at_link	Calculate gradients in node_values at links.
d8s_at_node	Links and diagonals attached to nodes.
diagonals_at_node	Diagonals attached to nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_links	Get array of fixed links.
length_of_d8	Length of links and diagonals.
length_of_link	Get the length of links.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
links_at_patch	Get the links that define a patch.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_inlinks_to_node	Map the maximum of links entering a node to the node.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_outlinks_to_node	Map the max of links leaving a node to the node.
map_mean_of_horizontal_active_links_to_node	Map the mean of active links in the x direction touching node to the node.
map_mean_of_horizontal_links_to_node	Map the mean of links in the x direction touching a node to the node.
map_mean_of_inlinks_to_node	Map the mean of links entering a node to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_links_to_node	Map the mean of links touching a node to the node.
map_mean_of_outlinks_to_node	Map the mean of links leaving a node to the node.
map_mean_of_vertical_active_links_to_node	Map the mean of active links in the y direction touching node to the node.
map_mean_of_vertical_links_to_node	Map the mean of links in the y direction touching a node to the node.
map_min_of_inlinks_to_node	Map the minimum of links entering a node to the node.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_outlinks_to_node	Map the min of links leaving a node to the node.
map_sum_of_inlinks_to_node	Map the sum of links entering a node to the node.
map_sum_of_outlinks_to_node	Map the sum of links leaving a node to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
midpoint_of_link	Get the middle of links.
number_of_active_links	Number of active links.
number_of_fixed_links	Number of fixed links.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
resolve_values_on_links	Resolve the xy-components of links.
status_at_link	Get array of the status of all links.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).

Patches

area_of_patch	Get the area of each patch.
calc_grad_at_patch	Calculate the components of the gradient of each raster patch.
calc_slope_at_patch	Calculate the slope (positive magnitude of gradient) at raster patches.
calc_unit_normal_at_patch	Calculate and return the unit normal vector <a, b, c> to a patch.
calc_unit_normals_at_patch_subtriangles	Calculate unit normals on a patch.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
number_of_patches	Get the number of patches.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
xy_of_patch	Get the centroid of each patch.

Hex

Nodes

active_adjacent_nodes_at_node	Adjacent nodes for each grid node.
active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
adjacent_nodes_at_node	Get adjacent nodes.
all_node_azimuths_map	Get azimuths from every node to every other node.
all_node_distances_map	Get distances from every node to every other node.
boundary_nodes	Get array of boundary nodes.
calc_aspect_at_node	Get array of aspect of a surface.
calc_distances_of_nodes_to_point	Get distances for nodes to a given point.
calc_flux_div_at_cell	Calculate divergence of link-based fluxes at cells.
calc_flux_div_at_node	Calculate divergence of link-based fluxes at nodes.
calc_hillshade_at_node	Get array of hillshade.
calc_net_flux_at_node	Calculate net link fluxes at nodes.
calc_slope_at_node	Array of slopes at nodes, averaged over neighboring patches.
cell_area_at_node	Cell areas in a nnodes-long array.
closed_boundary_nodes	Get array of closed boundary nodes.
core_nodes	Get array of core nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_gradient_boundary_nodes	Get array of fixed gradient boundary nodes.
fixed_value_boundary_nodes	Get array of fixed value boundary nodes.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
map_node_to_cell	Map values for nodes to cells.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
node_at_core_cell	Get array of nodes associated with core cells.
node_at_link_head	Get nodes at link head.
node_at_link_tail	Get nodes at link tail.
node_axis_coordinates	Get the coordinates of nodes along a particular axis.
node_has_boundary_neighbor	Check if ModelGrid nodes have neighbors that are boundary nodes.
node_is_boundary	Check if nodes are boundary nodes.
nodes	Get identifier for each node.
nodes_at_link	Get nodes at either end of links.
nodes_at_patch	Get the nodes that define a patch.
number_of_core_nodes	Number of core nodes.
number_of_node_columns	Number of node columns hex grid.
number_of_node_rows	Number of node rows in a rectangular-shaped and/or horizontally oriented hex grid.
number_of_nodes	Get total number of nodes.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
open_boundary_nodes	Get array of open boundary nodes.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
set_nodata_nodes_to_closed	Make no-data nodes closed boundaries.
set_nodata_nodes_to_fixed_gradient	Make no-data nodes fixed gradient boundaries.
status_at_node	Get array of the boundary status for each node.
unit_vector_sum_xcomponent_at_node	Get array of x-component of unit vector sums at each node.
unit_vector_sum_ycomponent_at_node	Get array of y-component of unit vector sums at each node.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).
x_of_node	Get x-coordinate of node.
xy_of_node	Get x and y-coordinates of node.
y_of_node	Get y-coordinate of node.

Links

active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
active_links	Get array of active links.
angle_of_link	Get the angle of each link.
angle_of_link_about_head	Find and return the angle of a link about the node at the link head.
calc_diff_at_link	Calculate differences of node values over links.
calc_grad_at_link	Calculate gradients of node values at links.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_links	Get array of fixed links.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
links_at_node	Get links touching a node.
links_at_patch	Get the links that define a patch.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
midpoint_of_link	Get the middle of links.
number_of_active_links	Number of active links.
number_of_fixed_links	Number of fixed links.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
resolve_values_on_links	Resolve the xy-components of links.
status_at_link	Get array of the status of all links.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).

Patches

area_of_patch	Get the area of each patch.
calc_grad_at_patch	Calculate the components of the gradient at each patch.
calc_slope_at_patch	Calculate the slope (positive magnitude of gradient) at patches.
calc_unit_normal_at_patch	Calculate and return the unit normal vector <a, b, c> to a patch.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
number_of_patches	Get the number of patches.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
patches_at_link	Get the patches on either side of each link.
patches_at_node	Get the patches that touch each node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
xy_of_patch	Get the centroid of each patch.

Radial

Nodes

active_adjacent_nodes_at_node	Adjacent nodes for each grid node.
active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
adjacent_nodes_at_node	Get adjacent nodes.
all_node_azimuths_map	Get azimuths from every node to every other node.
all_node_distances_map	Get distances from every node to every other node.
boundary_nodes	Get array of boundary nodes.
calc_aspect_at_node	Get array of aspect of a surface.
calc_distances_of_nodes_to_point	Get distances for nodes to a given point.
calc_flux_div_at_cell	Calculate divergence of link-based fluxes at cells.
calc_flux_div_at_node	Calculate divergence of link-based fluxes at nodes.
calc_hillshade_at_node	Get array of hillshade.
calc_net_flux_at_node	Calculate net link fluxes at nodes.
calc_slope_at_node	Array of slopes at nodes, averaged over neighboring patches.
cell_area_at_node	Cell areas in a nnodes-long array.
closed_boundary_nodes	Get array of closed boundary nodes.
core_nodes	Get array of core nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_gradient_boundary_nodes	Get array of fixed gradient boundary nodes.
fixed_value_boundary_nodes	Get array of fixed value boundary nodes.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
map_node_to_cell	Map values for nodes to cells.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
node_at_core_cell	Get array of nodes associated with core cells.
node_at_link_head	Get nodes at link head.
node_at_link_tail	Get nodes at link tail.
node_axis_coordinates	Get the coordinates of nodes along a particular axis.
node_has_boundary_neighbor	Check if ModelGrid nodes have neighbors that are boundary nodes.
node_is_boundary	Check if nodes are boundary nodes.
nodes	Get identifier for each node.
nodes_at_link	Get nodes at either end of links.
nodes_at_patch	Get the nodes that define a patch.
number_of_core_nodes	Number of core nodes.
number_of_nodes	Get total number of nodes.
number_of_nodes_in_ring	Number of nodes in each ring.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
open_boundary_nodes	Get array of open boundary nodes.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
perimeter_nodes	Get nodes on the convex hull of a Graph.
radius_at_node	Distance for center node to each node.
set_nodata_nodes_to_closed	Make no-data nodes closed boundaries.
set_nodata_nodes_to_fixed_gradient	Make no-data nodes fixed gradient boundaries.
status_at_node	Get array of the boundary status for each node.
unit_vector_sum_xcomponent_at_node	Get array of x-component of unit vector sums at each node.
unit_vector_sum_ycomponent_at_node	Get array of y-component of unit vector sums at each node.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).
x_of_node	Get x-coordinate of node.
xy_of_node	Get x and y-coordinates of node.
y_of_node	Get y-coordinate of node.

Links

active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
active_links	Get array of active links.
angle_of_link	Get the angle of each link.
angle_of_link_about_head	Find and return the angle of a link about the node at the link head.
calc_diff_at_link	Calculate differences of node values over links.
calc_grad_at_link	Calculate gradients of node values at links.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_links	Get array of fixed links.
length_of_link	Get the length of links.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
links_at_node	Get links touching a node.
links_at_patch	Get the links that define a patch.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
midpoint_of_link	Get the middle of links.
number_of_active_links	Number of active links.
number_of_fixed_links	Number of fixed links.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
resolve_values_on_links	Resolve the xy-components of links.
status_at_link	Get array of the status of all links.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).

Patches

area_of_patch	Get the area of each patch.
calc_grad_at_patch	Calculate the components of the gradient at each patch.
calc_slope_at_patch	Calculate the slope (positive magnitude of gradient) at patches.
calc_unit_normal_at_patch	Calculate and return the unit normal vector <a, b, c> to a patch.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
number_of_patches	Get the number of patches.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
patches_at_link	Get the patches on either side of each link.
patches_at_node	Get the patches that touch each node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
xy_of_patch	Get the centroid of each patch.

Voronoi

Nodes

active_adjacent_nodes_at_node	Adjacent nodes for each grid node.
active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
adjacent_nodes_at_node	Get adjacent nodes.
all_node_azimuths_map	Get azimuths from every node to every other node.
all_node_distances_map	Get distances from every node to every other node.
boundary_nodes	Get array of boundary nodes.
calc_aspect_at_node	Get array of aspect of a surface.
calc_distances_of_nodes_to_point	Get distances for nodes to a given point.
calc_flux_div_at_cell	Calculate divergence of link-based fluxes at cells.
calc_flux_div_at_node	Calculate divergence of link-based fluxes at nodes.
calc_hillshade_at_node	Get array of hillshade.
calc_net_flux_at_node	Calculate net link fluxes at nodes.
calc_slope_at_node	Array of slopes at nodes, averaged over neighboring patches.
cell_area_at_node	Cell areas in a nnodes-long array.
closed_boundary_nodes	Get array of closed boundary nodes.
core_nodes	Get array of core nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_gradient_boundary_nodes	Get array of fixed gradient boundary nodes.
fixed_value_boundary_nodes	Get array of fixed value boundary nodes.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
map_node_to_cell	Map values for nodes to cells.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
node_at_core_cell	Get array of nodes associated with core cells.
node_at_link_head	Get nodes at link head.
node_at_link_tail	Get nodes at link tail.
node_axis_coordinates	Get the coordinates of nodes along a particular axis.
node_has_boundary_neighbor	Check if ModelGrid nodes have neighbors that are boundary nodes.
node_is_boundary	Check if nodes are boundary nodes.
nodes	Get identifier for each node.
nodes_at_link	Get nodes at either end of links.
nodes_at_patch	Get the nodes that define a patch.
number_of_core_nodes	Number of core nodes.
number_of_nodes	Get total number of nodes.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
open_boundary_nodes	Get array of open boundary nodes.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
perimeter_nodes	Get nodes on the convex hull of a Graph.
set_nodata_nodes_to_closed	Make no-data nodes closed boundaries.
set_nodata_nodes_to_fixed_gradient	Make no-data nodes fixed gradient boundaries.
status_at_node	Get array of the boundary status for each node.
unit_vector_sum_xcomponent_at_node	Get array of x-component of unit vector sums at each node.
unit_vector_sum_ycomponent_at_node	Get array of y-component of unit vector sums at each node.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).
x_of_node	Get x-coordinate of node.
xy_of_node	Get x and y-coordinates of node.
y_of_node	Get y-coordinate of node.

Links

active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
active_links	Get array of active links.
angle_of_link	Get the angle of each link.
angle_of_link_about_head	Find and return the angle of a link about the node at the link head.
calc_diff_at_link	Calculate differences of node values over links.
calc_grad_at_link	Calculate gradients of node values at links.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_links	Get array of fixed links.
length_of_link	Get the length of links.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
links_at_node	Get links touching a node.
links_at_patch	Get the links that define a patch.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
midpoint_of_link	Get the middle of links.
number_of_active_links	Number of active links.
number_of_fixed_links	Number of fixed links.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
resolve_values_on_links	Resolve the xy-components of links.
status_at_link	Get array of the status of all links.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).

Patches

area_of_patch	Get the area of each patch.
calc_grad_at_patch	Calculate the components of the gradient at each patch.
calc_slope_at_patch	Calculate the slope (positive magnitude of gradient) at patches.
calc_unit_normal_at_patch	Calculate and return the unit normal vector <a, b, c> to a patch.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
number_of_patches	Get the number of patches.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
patches_at_link	Get the patches on either side of each link.
patches_at_node	Get the patches that touch each node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
xy_of_patch	Get the centroid of each patch.

FramedVoronoi

Nodes

active_adjacent_nodes_at_node	Adjacent nodes for each grid node.
active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
adjacent_nodes_at_node	Get adjacent nodes.
all_node_azimuths_map	Get azimuths from every node to every other node.
all_node_distances_map	Get distances from every node to every other node.
boundary_nodes	Get array of boundary nodes.
calc_aspect_at_node	Get array of aspect of a surface.
calc_distances_of_nodes_to_point	Get distances for nodes to a given point.
calc_flux_div_at_cell	Calculate divergence of link-based fluxes at cells.
calc_flux_div_at_node	Calculate divergence of link-based fluxes at nodes.
calc_hillshade_at_node	Get array of hillshade.
calc_net_flux_at_node	Calculate net link fluxes at nodes.
calc_slope_at_node	Array of slopes at nodes, averaged over neighboring patches.
cell_area_at_node	Cell areas in a nnodes-long array.
closed_boundary_nodes	Get array of closed boundary nodes.
core_nodes	Get array of core nodes.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_gradient_boundary_nodes	Get array of fixed gradient boundary nodes.
fixed_value_boundary_nodes	Get array of fixed value boundary nodes.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
map_node_to_cell	Map values for nodes to cells.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
node_at_core_cell	Get array of nodes associated with core cells.
node_at_link_head	Get nodes at link head.
node_at_link_tail	Get nodes at link tail.
node_axis_coordinates	Get the coordinates of nodes along a particular axis.
node_has_boundary_neighbor	Check if ModelGrid nodes have neighbors that are boundary nodes.
node_is_boundary	Check if nodes are boundary nodes.
nodes	Get identifier for each node.
nodes_at_link	Get nodes at either end of links.
nodes_at_patch	Get the nodes that define a patch.
number_of_core_nodes	Number of core nodes.
number_of_nodes	Get total number of nodes.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
open_boundary_nodes	Get array of open boundary nodes.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
set_nodata_nodes_to_closed	Make no-data nodes closed boundaries.
set_nodata_nodes_to_fixed_gradient	Make no-data nodes fixed gradient boundaries.
status_at_node	Get array of the boundary status for each node.
unit_vector_sum_xcomponent_at_node	Get array of x-component of unit vector sums at each node.
unit_vector_sum_ycomponent_at_node	Get array of y-component of unit vector sums at each node.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).
x_of_node	Get x-coordinate of node.
xy_of_node	Get x and y-coordinates of node.
y_of_node	Get y-coordinate of node.

Links

active_link_dirs_at_node	1=incoming flux, -1=outgoing flux, 0=no flux.
active_links	Get array of active links.
angle_of_link	Get the angle of each link.
angle_of_link_about_head	Find and return the angle of a link about the node at the link head.
calc_diff_at_link	Calculate differences of node values over links.
calc_grad_at_link	Calculate gradients of node values at links.
downwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are downwind of each node, according to values (array or field).
fixed_links	Get array of fixed links.
length_of_link	Get the length of links.
link_at_node_is_downwind	Return a boolean the same shape as links_at_node which flags links which are downwind of the node as True.
link_at_node_is_upwind	Return a boolean the same shape as links_at_node which flags links which are upwind of the node as True.
links_at_node	Get links touching a node.
links_at_patch	Get the links that define a patch.
map_downwind_node_link_max_to_node	Map the largest magnitude of the links carrying flux from the node to the node.
map_downwind_node_link_mean_to_node	Map the mean magnitude of the links carrying flux out of the node to the node.
map_link_head_node_to_link	Map values from a link head nodes to links.
map_link_tail_node_to_link	Map values from a link tail nodes to links.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_link_nodes_to_link	Map the maximum of a link's nodes to the link.
map_max_of_node_links_to_node	Map the maximum value of a nodes' links to the node.
map_mean_of_link_nodes_to_link	Map the mean of a link's nodes to the link.
map_min_of_link_nodes_to_link	Map the minimum of a link's nodes to the link.
map_min_of_node_links_to_node	Map the minimum value of a nodes' links to the node.
map_upwind_node_link_max_to_node	Map the largest magnitude of the links bringing flux into the node to the node.
map_upwind_node_link_mean_to_node	Map the mean magnitude of the links bringing flux into the node to the node.
map_value_at_downwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links carrying fluxes out of the node, found in a second node array or field.
map_value_at_max_node_to_link	Map the the value found in one node array to a link, based on the maximum value found in a second node field or array.
map_value_at_min_node_to_link	Map the the value found in one node array to a link, based on the minimum value found in a second node field or array.
map_value_at_upwind_node_link_max_to_node	Map the the value found in one link array to a node, based on the largest magnitude value of links bringing fluxes into the node, found in a second node array or field.
midpoint_of_link	Get the middle of links.
number_of_active_links	Number of active links.
number_of_fixed_links	Number of fixed links.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
resolve_values_on_links	Resolve the xy-components of links.
status_at_link	Get array of the status of all links.
upwind_links_at_node	Return an (nnodes, X) shape array of link IDs of which links are upwind of each node, according to values (field or array).

Patches

area_of_patch	Get the area of each patch.
calc_grad_at_patch	Calculate the components of the gradient at each patch.
calc_slope_at_patch	Calculate the slope (positive magnitude of gradient) at patches.
calc_unit_normal_at_patch	Calculate and return the unit normal vector <a, b, c> to a patch.
map_link_vector_sum_to_patch	Map the vector sum of links around a patch to the patch.
map_max_of_patch_nodes_to_patch	Map the maximum value of nodes around a patch to the patch.
map_mean_of_patch_nodes_to_patch	Map the mean value of nodes around a patch to the patch.
map_min_of_patch_nodes_to_patch	Map the minimum value of nodes around a patch to the patch.
number_of_patches	Get the number of patches.
number_of_patches_present_at_link	Return the number of patches at a link without a closed node.
number_of_patches_present_at_node	Return the number of patches at a node without a closed node.
patches_at_link	Get the patches on either side of each link.
patches_at_node	Get the patches that touch each node.
patches_present_at_link	A boolean array, False where a patch has a closed node or is missing.
patches_present_at_node	A boolean array, False where a patch has a closed node or is missing.
xy_of_patch	Get the centroid of each patch.