Uncategorized or Deprecated#

The following functions are either uncategorized or deprecated. Uncategorized functions are simply those to which we have not yet assigned a category (but we will as we continue to improve the documentation). Although functions marked as deprecated are currently still available, they will be removed in a future Landlab release and so their use is discouraged.

BAD_INDEX

Indicates a node is bad index.

BC_LINK_IS_ACTIVE

Indicates a link is active, and can carry flux

BC_LINK_IS_FIXED

Indicates a link has a fixed gradient value, and behaves as a boundary

BC_LINK_IS_INACTIVE

Indicates a link is inactive, and cannot carry flux

BC_NODE_IS_CLOSED

Indicates a boundary node is closed

BC_NODE_IS_CORE

Indicates a node is core.

BC_NODE_IS_FIXED_GRADIENT

Indicates a boundary node has a fixed gradient.

BC_NODE_IS_FIXED_VALUE

Indicates a boundary node has a fixed value.

BC_NODE_IS_LOOPED

Indicates a boundary node is wrap-around.

VALID_LOCATIONS

Grid elements on which fields can be placed.

active_adjacent_corners_at_corner

Adjacent corners for each grid corner.

active_d8

active_d8_dirs_at_corner

active_d8_dirs_at_node

active_diagonal_dirs_at_corner

active_diagonal_dirs_at_node

active_diagonals

active_face_dirs_at_corner

1=incoming flux, -1=outgoing

adjacent_corners_at_corner

Get adjacent corners.

adjacent_faces_at_face

adjacent_links_at_link

all_corner_azimuths_map

Get azimuths from every corner to every other corner.

all_corner_distances_map

Get distances from every corner to every other corner.

angle_of_face

Get the angle of each face.

angle_of_face_about_head

Find and return the angle of a face about the corner at the face head.

area_of_cell

Get the area of each cell.

as_dataarray

Create an xarray DataArray representation of a grid field.

as_dataset

Create an xarray Dataset representation of a grid.

at_cell

at_corner

at_face

at_grid

at_layer

EventLayers for each cell.

at_link

at_node

at_patch

boundary_corners

Get array of boundary corners.

cell_at_node

cells_at_corner

cells_at_face

cells_present_at_corner

A boolean array, False where a cell has a closed corner or is

cells_present_at_face

A boolean array, False where a cell has a closed corner or is

closed_boundary_corners

Get array of closed boundary corners.

core_corners

Get array of core corners.

core_patches

Get array of core patches.

corner_at_core_patch

Get array of corners associated with core patches.

corner_at_face_head

Get corners at face head.

corner_at_face_tail

Get corners at face tail.

corner_at_patch

corner_nodes

corner_x

corner_y

corners

A shaped array of corner ids.

corners_at_bottom_edge

corners_at_cell

Get the corners that define a cell.

corners_at_d8

corners_at_diagonal

Nodes at diagonal tail and head.

corners_at_face

Get corners at either end of faces.

corners_at_left_edge

corners_at_link

corners_at_nodes_of_grid

Nodes at nodes of grid.

corners_at_right_edge

corners_at_top_edge

d8_adjacent_corners_at_corner

d8_adjacent_nodes_at_node

d8_dirs_at_corner

d8_dirs_at_node

d8_status_at_corner

d8_status_at_node

d8s_at_corner

Links and diagonals attached to corners.

default_group

Return the name of the group into which fields are put by default.

diagonal_adjacent_corners_at_corner

Get adjacent corners along diagonals.

diagonal_dirs_at_corner

Directions of diagonals attached to corners.

diagonal_dirs_at_node

Directions of diagonals attached to nodes.

diagonal_status_at_corner

diagonal_status_at_node

diagonals_at_corner

Diagonals attached to corners.

ds

dual

dx

dy

event_layers

EventLayers for each cell.

face_at_link

face_dirs_at_corner

face_status_at_corner

faces_at_cell

Get the faces that define a cell.

faces_at_corner

fields

List of fields held by the grid.

fixed_faces

Get array of fixed faces.

fixed_gradient_boundary_corner_anchor_corner

Returns the corner at the other end of the fixed face for a fixed

fixed_gradient_boundary_corner_fixed_face

An array of the fixed_faces connected to fixed gradient boundary

fixed_gradient_boundary_corners

Get array of fixed gradient boundary corners.

fixed_gradient_boundary_node_anchor_node

Returns the node at the other end of the fixed link for a fixed gradient boundary node.

fixed_gradient_boundary_node_fixed_link

An array of the fixed_links connected to fixed gradient boundary nodes.

fixed_value_boundary_corners

Get array of fixed value boundary corners.

freeze

Freeze the graph by making arrays read-only.

from_dataset

from_file

Create grid from a file-like object.

from_netcdf

frozen

groups

List of group names.

horizontal_faces

horizontal_links

imshow

Plot a data field.

length_of_diagonal

length_of_face

Get the length of faces.

link_at_face

link_dirs_at_node

Get directions of links touching a node.

link_status_at_node

link_with_angle

Return array of IDs of links with given angle.

link_with_node_status

Links with a given node status.

links_at_node

Get links touching a node.

load

looped_neighbors_at_patch

For each patch in a raster, return the D8 neighboring patches, looping

map_link_vector_components_to_node

Map (x,y) components of link data data_at_link onto nodes.

map_link_vector_components_to_node_raster

Map (x,y) vector components of data_at_link onto nodes.

map_link_vector_to_nodes

Map data defined on links to nodes.

material_layers

MaterialLayers for each cell.

merge

midpoint_of_face

Get the middle of faces.

ndim

Number of spatial dimensions of the grid.

node_at_cell

node_corners

node_x

node_y

nodes

A shaped array of node ids.

nodes_at_bottom_edge

nodes_at_corners_of_grid

Nodes at corners of grid.

nodes_at_d8

nodes_at_diagonal

Nodes at diagonal tail and head.

nodes_at_edge

nodes_at_face

nodes_at_left_edge

nodes_at_right_edge

nodes_at_top_edge

number_of_cells

Get the number of cells.

number_of_cells_present_at_corner

Return the number of cells at a corner without a closed corner.

number_of_cells_present_at_face

Return the number of cells at a face without a closed corner.

number_of_core_corners

Number of core corners.

number_of_core_patches

Number of core patches.

number_of_corner_columns

number_of_corner_rows

number_of_corners

Get total number of corners.

number_of_d8

Number of links and diagonals.

number_of_diagonals

Number of diagonals in the grid.

number_of_faces

Get corners at face head.

number_of_fixed_faces

Number of fixed faces.

number_of_interior_corners

Number of interior corners.

number_of_links

Get nodes at link head.

number_of_node_columns

number_of_node_rows

number_of_patch_columns

Number of patch columns.

number_of_patch_rows

Number of patch rows.

open_boundary_corners

Get array of open boundary corners.

origin

patch_area_at_corner

Cell areas in a ncorners-long array.

patch_at_corner

patch_grid_shape

Get the shape of the patchular grid (grid with only patches).

patches_at_link

Get the patches on either side of each link.

patches_at_node

Get the patches that touch each node.

patches_at_nodes_of_grid

Get array of patches in patchular grid (grid with only patches) nodes.

perimeter_corners

perimeter_nodes

Get nodes on the convex hull of a Graph.

reset_status_at_node

second_ring_looped_neighbors_at_patch

Get list of second ring looped neighbor patch IDs (all 16 neighbors).

shape

sort

Sort graph elements.

spacing

status_at_corner

Get array of the boundary status for each corner.

status_at_d8

status_at_diagonal

Status at diagonals.

status_at_face

Get array of the status of all faces.

thaw

Thaw the graph by making arrays writable.

thawed

to_dict

to_json

to_netcdf

Write graph contents to a netCDF file.

unit_vector_at_corner

Get a unit vector for each corner.

unit_vector_at_face

Make arrays to store the unit vectors associated with each face.

unit_vector_at_link

Make arrays to store the unit vectors associated with each link.

unit_vector_at_node

Get a unit vector for each node.

unit_vector_sum_xcomponent_at_corner

Get array of x-component of unit vector sums at each corner.

unit_vector_sum_ycomponent_at_corner

Get array of y-component of unit vector sums at each corner.

vertical_faces

vertical_links

x_of_corner

Get x-coordinate of corner.

xy_of_cell

Get the centroid of each cell.

xy_of_corner

Get x and y-coordinates of corner.

xy_of_face

xy_of_link

xy_of_lower_left

Return (x, y) of the reference point.

xy_of_reference

Return the coordinates (x, y) of the reference point.

y_of_corner

Get y-coordinate of corner.

looped_neighbors_at_cell

For each cell in a raster, return the D8 neighboring cells, looping across grid boundaries as necessary.

BAD_INDEX

Indicates a node is bad index.

BC_LINK_IS_ACTIVE

Indicates a link is active, and can carry flux

BC_LINK_IS_FIXED

Indicates a link has a fixed gradient value, and behaves as a boundary

BC_LINK_IS_INACTIVE

Indicates a link is inactive, and cannot carry flux

BC_NODE_IS_CLOSED

Indicates a boundary node is closed

BC_NODE_IS_CORE

Indicates a node is core.

BC_NODE_IS_FIXED_GRADIENT

Indicates a boundary node has a fixed gradient.

BC_NODE_IS_FIXED_VALUE

Indicates a boundary node has a fixed value.

BC_NODE_IS_LOOPED

Indicates a boundary node is wrap-around.

VALID_LOCATIONS

Grid elements on which fields can be placed.

active_adjacent_corners_at_corner

Adjacent corners for each grid corner.

active_face_dirs_at_corner

1=incoming flux, -1=outgoing

adjacent_corners_at_corner

Get adjacent corners.

adjacent_faces_at_face

adjacent_links_at_link

all_corner_azimuths_map

Get azimuths from every corner to every other corner.

all_corner_distances_map

Get distances from every corner to every other corner.

angle_of_face

Get the angle of each face.

angle_of_face_about_head

Find and return the angle of a face about the corner at the face head.

area_of_cell

Get the area of each cell.

as_dataarray

Create an xarray DataArray representation of a grid field.

as_dataset

Create an xarray Dataset representation of a grid.

at_cell

at_corner

at_face

at_grid

at_layer

EventLayers for each cell.

at_link

at_node

at_patch

boundary_corners

Get array of boundary corners.

cell_at_node

cells_at_corner

Get the cells that touch each corner.

cells_at_face

Get the cells on either side of each face.

cells_present_at_corner

A boolean array, False where a cell has a closed corner or is

cells_present_at_face

A boolean array, False where a cell has a closed corner or is

closed_boundary_corners

Get array of closed boundary corners.

core_corners

Get array of core corners.

core_patches

Get array of core patches.

corner_at_core_patch

Get array of corners associated with core patches.

corner_at_face_head

Get corners at face head.

corner_at_face_tail

Get corners at face tail.

corner_at_patch

corner_layout

corner_x

corner_y

corners

Get identifier for each corner.

corners_at_bottom_edge

Get corners along the bottom edge.

corners_at_cell

Get the corners that define a cell.

corners_at_face

Get corners at either end of faces.

corners_at_left_edge

Get corners along the left edge.

corners_at_link

corners_at_right_edge

Get corners along the right edge.

corners_at_top_edge

Get corners along the top edge.

default_group

Return the name of the group into which fields are put by default.

ds

dual

event_layers

EventLayers for each cell.

face_at_link

face_dirs_at_corner

Get directions of faces touching a corner.

face_status_at_corner

faces_at_cell

Get the faces that define a cell.

faces_at_corner

Get faces touching a corner.

fields

List of fields held by the grid.

fixed_faces

Get array of fixed faces.

fixed_gradient_boundary_corner_anchor_corner

Returns the corner at the other end of the fixed face for a fixed

fixed_gradient_boundary_corner_fixed_face

An array of the fixed_faces connected to fixed gradient boundary

fixed_gradient_boundary_corners

Get array of fixed gradient boundary corners.

fixed_gradient_boundary_node_anchor_node

Returns the node at the other end of the fixed link for a fixed gradient boundary node.

fixed_gradient_boundary_node_fixed_link

An array of the fixed_links connected to fixed gradient boundary nodes.

fixed_value_boundary_corners

Get array of fixed value boundary corners.

freeze

Freeze the graph by making arrays read-only.

from_dataset

from_dict

Create grid from dictionary.

from_file

Create grid from a file-like object.

from_netcdf

frozen

groups

List of group names.

imshow

Plot a data field.

length_of_face

length_of_link

Get the length of links.

link_at_face

link_dirs_at_node

Get directions of links touching a node.

link_status_at_node

link_with_angle

Return array of IDs of links with given angle.

link_with_node_status

Links with a given node status.

load

map_link_vector_components_to_node

Map (x,y) components of link data data_at_link onto nodes.

map_link_vector_to_nodes

Map data defined on links to nodes.

material_layers

MaterialLayers for each cell.

merge

midpoint_of_face

Get the middle of faces.

ndim

Number of spatial dimensions of the grid.

node_at_cell

node_layout

node_row_and_column

Row and column from node ID, FOR VERT RECT CONFIGURATION ONLY.

node_x

node_y

nodes_at_bottom_edge

Get nodes along the bottom edge.

nodes_at_face

nodes_at_left_edge

Get nodes along the left edge.

nodes_at_right_edge

Get nodes along the right edge.

nodes_at_top_edge

Get nodes along the top edge.

number_of_cells

Get the number of cells.

number_of_cells_present_at_corner

Return the number of cells at a corner without a closed corner.

number_of_cells_present_at_face

Return the number of cells at a face without a closed corner.

number_of_core_corners

Number of core corners.

number_of_core_patches

Number of core patches.

number_of_corner_columns

Number of corner columns hex grid.

number_of_corner_rows

Number of corner rows in a rectangular-shaped and/or horizontally

number_of_corners

Get total number of corners.

number_of_faces

Get corners at face head.

number_of_fixed_faces

Number of fixed faces.

number_of_links

Get nodes at link head.

open_boundary_corners

Get array of open boundary corners.

orientation

patch_area_at_corner

Cell areas in a ncorners-long array.

patch_at_corner

perimeter_corners

Get corners on the convex hull of a Graph.

reset_status_at_node

shape

sort

Sort graph elements.

spacing

status_at_corner

Get array of the boundary status for each corner.

status_at_face

Get array of the status of all faces.

thaw

Thaw the graph by making arrays writable.

thawed

to_dict

to_json

to_netcdf

Write graph contents to a netCDF file.

unit_vector_at_corner

Get a unit vector for each corner.

unit_vector_at_face

Make arrays to store the unit vectors associated with each face.

unit_vector_at_link

Make arrays to store the unit vectors associated with each link.

unit_vector_at_node

Get a unit vector for each node.

unit_vector_sum_xcomponent_at_corner

Get array of x-component of unit vector sums at each corner.

unit_vector_sum_ycomponent_at_corner

Get array of y-component of unit vector sums at each corner.

x_of_corner

Get x-coordinate of corner.

xy_of_cell

Get the centroid of each cell.

xy_of_corner

Get x and y-coordinates of corner.

xy_of_face

xy_of_link

xy_of_lower_left

Return (x, y) of the reference point.

xy_of_reference

Return the coordinates (x, y) of the reference point.

y_of_corner

Get y-coordinate of corner.

BAD_INDEX

Indicates a node is bad index.

BC_LINK_IS_ACTIVE

Indicates a link is active, and can carry flux

BC_LINK_IS_FIXED

Indicates a link has a fixed gradient value, and behaves as a boundary

BC_LINK_IS_INACTIVE

Indicates a link is inactive, and cannot carry flux

BC_NODE_IS_CLOSED

Indicates a boundary node is closed

BC_NODE_IS_CORE

Indicates a node is core.

BC_NODE_IS_FIXED_GRADIENT

Indicates a boundary node has a fixed gradient.

BC_NODE_IS_FIXED_VALUE

Indicates a boundary node has a fixed value.

BC_NODE_IS_LOOPED

Indicates a boundary node is wrap-around.

VALID_LOCATIONS

Grid elements on which fields can be placed.

active_adjacent_corners_at_corner

Adjacent corners for each grid corner.

active_face_dirs_at_corner

1=incoming flux, -1=outgoing

adjacent_corners_at_corner

Get adjacent corners.

adjacent_faces_at_face

adjacent_links_at_link

all_corner_azimuths_map

Get azimuths from every corner to every other corner.

all_corner_distances_map

Get distances from every corner to every other corner.

angle_at_corner

angle_at_node

angle_of_face

Get the angle of each face.

angle_of_face_about_head

Find and return the angle of a face about the corner at the face head.

angle_spacing_of_ring

area_of_cell

Get the area of each cell.

as_dataarray

Create an xarray DataArray representation of a grid field.

as_dataset

Create an xarray Dataset representation of a grid.

at_cell

at_corner

at_face

at_grid

at_layer

EventLayers for each cell.

at_link

at_node

at_patch

boundary_corners

Get array of boundary corners.

cell_at_node

cells_at_corner

Get the cells that touch each corner.

cells_at_face

Get the cells on either side of each face.

cells_present_at_corner

A boolean array, False where a cell has a closed corner or is

cells_present_at_face

A boolean array, False where a cell has a closed corner or is

closed_boundary_corners

Get array of closed boundary corners.

core_corners

Get array of core corners.

core_patches

Get array of core patches.

corner_at_core_patch

Get array of corners associated with core patches.

corner_at_face_head

Get corners at face head.

corner_at_face_tail

Get corners at face tail.

corner_at_patch

corner_x

corner_y

corners

Get identifier for each corner.

corners_at_cell

Get the corners that define a cell.

corners_at_face

Get corners at either end of faces.

corners_at_link

corners_per_ring

default_group

Return the name of the group into which fields are put by default.

ds

dual

event_layers

EventLayers for each cell.

face_at_link

face_dirs_at_corner

Get directions of faces touching a corner.

face_status_at_corner

faces_at_cell

Get the faces that define a cell.

faces_at_corner

Get faces touching a corner.

fields

List of fields held by the grid.

fixed_faces

Get array of fixed faces.

fixed_gradient_boundary_corner_anchor_corner

Returns the corner at the other end of the fixed face for a fixed

fixed_gradient_boundary_corner_fixed_face

An array of the fixed_faces connected to fixed gradient boundary

fixed_gradient_boundary_corners

Get array of fixed gradient boundary corners.

fixed_gradient_boundary_node_anchor_node

Returns the node at the other end of the fixed link for a fixed gradient boundary node.

fixed_gradient_boundary_node_fixed_link

An array of the fixed_links connected to fixed gradient boundary nodes.

fixed_value_boundary_corners

Get array of fixed value boundary corners.

freeze

Freeze the graph by making arrays read-only.

from_dataset

from_dict

Create grid from dictionary.

from_file

Create grid from a file-like object.

from_netcdf

frozen

groups

List of group names.

imshow

Plot a data field.

length_of_face

Get the length of faces.

link_at_face

link_dirs_at_node

Get directions of links touching a node.

link_status_at_node

link_with_angle

Return array of IDs of links with given angle.

link_with_node_status

Links with a given node status.

load

map_link_vector_components_to_node

Map (x,y) components of link data data_at_link onto nodes.

map_link_vector_to_nodes

Map data defined on links to nodes.

material_layers

MaterialLayers for each cell.

merge

midpoint_of_face

Get the middle of faces.

ndim

Number of spatial dimensions of the grid.

node_at_cell

node_x

node_y

nodes_at_face

nodes_per_ring

number_of_cells

Get the number of cells.

number_of_cells_present_at_corner

Return the number of cells at a corner without a closed corner.

number_of_cells_present_at_face

Return the number of cells at a face without a closed corner.

number_of_core_corners

Number of core corners.

number_of_core_patches

Number of core patches.

number_of_corners

Get total number of corners.

number_of_corners_in_ring

Number of corners in each ring.

number_of_faces

Get corners at face head.

number_of_fixed_faces

Number of fixed faces.

number_of_links

Get nodes at link head.

open_boundary_corners

Get array of open boundary corners.

origin

patch_area_at_corner

Cell areas in a ncorners-long array.

patch_at_corner

perimeter_corners

Get corners on the convex hull of a Graph.

radius_at_corner

Distance for center corner to each corner.

radius_of_ring

reset_status_at_node

ring_at_corner

ring_at_node

shape

sort

Sort graph elements.

spacing

status_at_corner

Get array of the boundary status for each corner.

status_at_face

Get array of the status of all faces.

thaw

Thaw the graph by making arrays writable.

thawed

to_dict

to_json

to_netcdf

Write graph contents to a netCDF file.

unit_vector_at_corner

Get a unit vector for each corner.

unit_vector_at_face

Make arrays to store the unit vectors associated with each face.

unit_vector_at_link

Make arrays to store the unit vectors associated with each link.

unit_vector_at_node

Get a unit vector for each node.

unit_vector_sum_xcomponent_at_corner

Get array of x-component of unit vector sums at each corner.

unit_vector_sum_ycomponent_at_corner

Get array of y-component of unit vector sums at each corner.

x_of_corner

Get x-coordinate of corner.

xy_of_cell

Get the centroid of each cell.

xy_of_center

Return (x, y) of the reference point.

xy_of_corner

Get x and y-coordinates of corner.

xy_of_face

xy_of_link

xy_of_reference

Return the coordinates (x, y) of the reference point.

y_of_corner

Get y-coordinate of corner.

BAD_INDEX

Indicates a node is bad index.

BC_LINK_IS_ACTIVE

Indicates a link is active, and can carry flux

BC_LINK_IS_FIXED

Indicates a link has a fixed gradient value, and behaves as a boundary

BC_LINK_IS_INACTIVE

Indicates a link is inactive, and cannot carry flux

BC_NODE_IS_CLOSED

Indicates a boundary node is closed

BC_NODE_IS_CORE

Indicates a node is core.

BC_NODE_IS_FIXED_GRADIENT

Indicates a boundary node has a fixed gradient.

BC_NODE_IS_FIXED_VALUE

Indicates a boundary node has a fixed value.

BC_NODE_IS_LOOPED

Indicates a boundary node is wrap-around.

VALID_LOCATIONS

Grid elements on which fields can be placed.

active_adjacent_corners_at_corner

Adjacent corners for each grid corner.

active_face_dirs_at_corner

1=incoming flux, -1=outgoing

adjacent_corners_at_corner

Get adjacent corners.

adjacent_faces_at_face

adjacent_links_at_link

all_corner_azimuths_map

Get azimuths from every corner to every other corner.

all_corner_distances_map

Get distances from every corner to every other corner.

angle_of_face

Get the angle of each face.

angle_of_face_about_head

Find and return the angle of a face about the corner at the face head.

area_of_cell

Get the area of each cell.

as_dataarray

Create an xarray DataArray representation of a grid field.

as_dataset

Create an xarray Dataset representation of a grid.

at_cell

at_corner

at_face

at_grid

at_layer

EventLayers for each cell.

at_link

at_node

at_patch

boundary_corners

Get array of boundary corners.

cell_at_node

cells_at_corner

Get the cells that touch each corner.

cells_at_face

Get the cells on either side of each face.

cells_present_at_corner

A boolean array, False where a cell has a closed corner or is

cells_present_at_face

A boolean array, False where a cell has a closed corner or is

closed_boundary_corners

Get array of closed boundary corners.

core_corners

Get array of core corners.

core_patches

Get array of core patches.

corner_at_core_patch

Get array of corners associated with core patches.

corner_at_face_head

Get corners at face head.

corner_at_face_tail

Get corners at face tail.

corner_at_patch

corner_x

corner_y

corners

Get identifier for each corner.

corners_at_cell

Get the corners that define a cell.

corners_at_face

Get corners at either end of faces.

corners_at_link

default_group

Return the name of the group into which fields are put by default.

ds

dual

event_layers

EventLayers for each cell.

face_at_link

face_dirs_at_corner

Get directions of faces touching a corner.

face_status_at_corner

faces_at_cell

Get the faces that define a cell.

faces_at_corner

Get faces touching a corner.

fields

List of fields held by the grid.

fixed_faces

Get array of fixed faces.

fixed_gradient_boundary_corner_anchor_corner

Returns the corner at the other end of the fixed face for a fixed

fixed_gradient_boundary_corner_fixed_face

An array of the fixed_faces connected to fixed gradient boundary

fixed_gradient_boundary_corners

Get array of fixed gradient boundary corners.

fixed_gradient_boundary_node_anchor_node

Returns the node at the other end of the fixed link for a fixed gradient boundary node.

fixed_gradient_boundary_node_fixed_link

An array of the fixed_links connected to fixed gradient boundary nodes.

fixed_value_boundary_corners

Get array of fixed value boundary corners.

freeze

Freeze the graph by making arrays read-only.

from_dict

Create grid from dictionary.

from_file

Create grid from a file-like object.

from_netcdf

frozen

groups

List of group names.

imshow

Plot a data field.

length_of_face

Get the length of faces.

link_at_face

link_dirs_at_node

Get directions of links touching a node.

link_status_at_node

link_with_angle

Return array of IDs of links with given angle.

link_with_node_status

Links with a given node status.

load

map_link_vector_components_to_node

Map (x,y) components of link data data_at_link onto nodes.

map_link_vector_to_nodes

Map data defined on links to nodes.

material_layers

MaterialLayers for each cell.

merge

midpoint_of_face

Get the middle of faces.

ndim

Number of spatial dimensions of the grid.

node_at_cell

node_x

node_y

nodes_at_face

number_of_cells

Get the number of cells.

number_of_cells_present_at_corner

Return the number of cells at a corner without a closed corner.

number_of_cells_present_at_face

Return the number of cells at a face without a closed corner.

number_of_core_corners

Number of core corners.

number_of_core_patches

Number of core patches.

number_of_corners

Get total number of corners.

number_of_faces

Get corners at face head.

number_of_fixed_faces

Number of fixed faces.

number_of_links

Get nodes at link head.

open_boundary_corners

Get array of open boundary corners.

patch_area_at_corner

Cell areas in a ncorners-long array.

patch_at_corner

perimeter_corners

Get corners on the convex hull of a Graph.

reset_status_at_node

sort

Sort graph elements.

status_at_corner

Get array of the boundary status for each corner.

status_at_face

Get array of the status of all faces.

thaw

Thaw the graph by making arrays writable.

thawed

to_dict

to_json

to_netcdf

Write graph contents to a netCDF file.

unit_vector_at_corner

Get a unit vector for each corner.

unit_vector_at_face

Make arrays to store the unit vectors associated with each face.

unit_vector_at_link

Make arrays to store the unit vectors associated with each link.

unit_vector_at_node

Get a unit vector for each node.

unit_vector_sum_xcomponent_at_corner

Get array of x-component of unit vector sums at each corner.

unit_vector_sum_ycomponent_at_corner

Get array of y-component of unit vector sums at each corner.

x_of_corner

Get x-coordinate of corner.

xy_of_cell

Get the centroid of each cell.

xy_of_corner

Get x and y-coordinates of corner.

xy_of_face

xy_of_link

xy_of_reference

Return the coordinates (x, y) of the reference point.

y_of_corner

Get y-coordinate of corner.

BAD_INDEX

Indicates a node is bad index.

BC_LINK_IS_ACTIVE

Indicates a link is active, and can carry flux

BC_LINK_IS_FIXED

Indicates a link has a fixed gradient value, and behaves as a boundary

BC_LINK_IS_INACTIVE

Indicates a link is inactive, and cannot carry flux

BC_NODE_IS_CLOSED

Indicates a boundary node is closed

BC_NODE_IS_CORE

Indicates a node is core.

BC_NODE_IS_FIXED_GRADIENT

Indicates a boundary node has a fixed gradient.

BC_NODE_IS_FIXED_VALUE

Indicates a boundary node has a fixed value.

BC_NODE_IS_LOOPED

Indicates a boundary node is wrap-around.

VALID_LOCATIONS

Grid elements on which fields can be placed.

active_adjacent_corners_at_corner

Adjacent corners for each grid corner.

active_face_dirs_at_corner

1=incoming flux, -1=outgoing

adjacent_corners_at_corner

Get adjacent corners.

adjacent_faces_at_face

adjacent_links_at_link

all_corner_azimuths_map

Get azimuths from every corner to every other corner.

all_corner_distances_map

Get distances from every corner to every other corner.

angle_of_face

Get the angle of each face.

angle_of_face_about_head

Find and return the angle of a face about the corner at the face head.

area_of_cell

Get the area of each cell.

as_dataarray

Create an xarray DataArray representation of a grid field.

as_dataset

Create an xarray Dataset representation of a grid.

at_cell

at_corner

at_face

at_grid

at_layer

EventLayers for each cell.

at_link

at_node

at_patch

boundary_corners

Get array of boundary corners.

cell_at_node

cells_at_corner

Get the cells that touch each corner.

cells_at_face

Get the cells on either side of each face.

cells_present_at_corner

A boolean array, False where a cell has a closed corner or is

cells_present_at_face

A boolean array, False where a cell has a closed corner or is

closed_boundary_corners

Get array of closed boundary corners.

core_corners

Get array of core corners.

core_patches

Get array of core patches.

corner_at_core_patch

Get array of corners associated with core patches.

corner_at_face_head

Get corners at face head.

corner_at_face_tail

Get corners at face tail.

corner_at_patch

corner_layout

corner_x

corner_y

corners

Get identifier for each corner.

corners_at_bottom_edge

corners_at_cell

Get the corners that define a cell.

corners_at_face

Get corners at either end of faces.

corners_at_left_edge

corners_at_link

corners_at_right_edge

corners_at_top_edge

default_group

Return the name of the group into which fields are put by default.

ds

dual

event_layers

EventLayers for each cell.

face_at_link

face_dirs_at_corner

Get directions of faces touching a corner.

face_status_at_corner

faces_at_cell

Get the faces that define a cell.

faces_at_corner

Get faces touching a corner.

fields

List of fields held by the grid.

fixed_faces

Get array of fixed faces.

fixed_gradient_boundary_corner_anchor_corner

Returns the corner at the other end of the fixed face for a fixed

fixed_gradient_boundary_corner_fixed_face

An array of the fixed_faces connected to fixed gradient boundary

fixed_gradient_boundary_corners

Get array of fixed gradient boundary corners.

fixed_gradient_boundary_node_anchor_node

Returns the node at the other end of the fixed link for a fixed gradient boundary node.

fixed_gradient_boundary_node_fixed_link

An array of the fixed_links connected to fixed gradient boundary nodes.

fixed_value_boundary_corners

Get array of fixed value boundary corners.

freeze

Freeze the graph by making arrays read-only.

from_dict

Create grid from dictionary.

from_file

Create grid from a file-like object.

from_netcdf

frozen

groups

List of group names.

imshow

Plot a data field.

length_of_face

Get the length of faces.

link_at_face

link_dirs_at_node

Get directions of links touching a node.

link_status_at_node

link_with_angle

Return array of IDs of links with given angle.

link_with_node_status

Links with a given node status.

load

map_link_vector_components_to_node

Map (x,y) components of link data data_at_link onto nodes.

map_link_vector_to_nodes

Map data defined on links to nodes.

material_layers

MaterialLayers for each cell.

merge

midpoint_of_face

Get the middle of faces.

ndim

Number of spatial dimensions of the grid.

node_at_cell

node_layout

node_x

node_y

nodes_at_bottom_edge

nodes_at_face

nodes_at_left_edge

nodes_at_right_edge

nodes_at_top_edge

number_of_cells

Get the number of cells.

number_of_cells_present_at_corner

Return the number of cells at a corner without a closed corner.

number_of_cells_present_at_face

Return the number of cells at a face without a closed corner.

number_of_core_corners

Number of core corners.

number_of_core_patches

Number of core patches.

number_of_corners

Get total number of corners.

number_of_faces

Get corners at face head.

number_of_fixed_faces

Number of fixed faces.

number_of_links

Get nodes at link head.

open_boundary_corners

Get array of open boundary corners.

orientation

patch_area_at_corner

Cell areas in a ncorners-long array.

patch_at_corner

perimeter_corners

Get corners on the convex hull of a Graph.

reset_status_at_node

shape

sort

Sort graph elements.

status_at_corner

Get array of the boundary status for each corner.

status_at_face

Get array of the status of all faces.

thaw

Thaw the graph by making arrays writable.

thawed

to_dict

to_json

to_netcdf

Write graph contents to a netCDF file.

unit_vector_at_corner

Get a unit vector for each corner.

unit_vector_at_face

Make arrays to store the unit vectors associated with each face.

unit_vector_at_link

Make arrays to store the unit vectors associated with each link.

unit_vector_at_node

Get a unit vector for each node.

unit_vector_sum_xcomponent_at_corner

Get array of x-component of unit vector sums at each corner.

unit_vector_sum_ycomponent_at_corner

Get array of y-component of unit vector sums at each corner.

x_of_corner

Get x-coordinate of corner.

xy_of_cell

Get the centroid of each cell.

xy_of_corner

Get x and y-coordinates of corner.

xy_of_face

xy_of_link

xy_of_reference

Return the coordinates (x, y) of the reference point.

xy_spacing

y_of_corner

Get y-coordinate of corner.