landlab.grid.diagonals module#

class DiagonalsMixIn[source]#

Bases: object

Add diagonals to a structured quad grid.

property active_d8#
property active_d8_dirs_at_node#
property active_diagonal_dirs_at_node#
property active_diagonals#
property d8_adjacent_nodes_at_node#
property d8_dirs_at_node#
property d8_status_at_node#
property d8s_at_node#

Links and diagonals attached to nodes.

Returns

Links and diagonals at each node.

Return type

ndarray of int, shape (n_nodes, 8)

Examples

>>> import numpy as np
>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((3, 4))
>>> grid.d8s_at_node.shape == (grid.number_of_nodes, 8)
True
>>> grid.d8s_at_node
array([[ 0,  3, -1, -1, 17, -1, -1, -1],
       [ 1,  4,  0, -1, 19, 18, -1, -1],
       [ 2,  5,  1, -1, 21, 20, -1, -1],
       [-1,  6,  2, -1, -1, 22, -1, -1],
       [ 7, 10, -1,  3, 23, -1, -1, 18],
       [ 8, 11,  7,  4, 25, 24, 17, 20],
       [ 9, 12,  8,  5, 27, 26, 19, 22],
       [-1, 13,  9,  6, -1, 28, 21, -1],
       [14, -1, -1, 10, -1, -1, -1, 24],
       [15, -1, 14, 11, -1, -1, 23, 26],
       [16, -1, 15, 12, -1, -1, 25, 28],
       [-1, -1, 16, 13, -1, -1, 27, -1]])
>>> np.all(grid.d8s_at_node[:, :4] == grid.links_at_node)
True
>>> diagonals_at_node = grid.d8s_at_node[:, 4:] - grid.number_of_links
>>> diagonals_at_node[grid.d8s_at_node[:, 4:] == -1] = -1
>>> np.all(diagonals_at_node == grid.diagonals_at_node)
True
property diagonal_adjacent_nodes_at_node#

Get adjacent nodes along diagonals.

Order is the landlab standard, counterclockwise starting from east.

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.diagonal_adjacent_nodes_at_node
array([[ 4, -1, -1, -1], [ 5,  3, -1, -1], [-1,  4, -1, -1],
       [ 7, -1, -1,  1], [ 8,  6,  0,  2], [-1,  7,  1, -1],
       [10, -1, -1,  4], [11,  9,  3,  5], [-1, 10,  4, -1],
       [-1, -1, -1,  7], [-1, -1,  6,  8], [-1, -1,  7, -1]])
property diagonal_dirs_at_node#

Directions of diagonals attached to nodes.

Array of diagonal directions relative to each node. If the diagonal is directed away from the node the direction is -1, if the diagonal is directed toward the node its direction is 1. Each node is assumed to have exactly four diagonals attached to it. However, perimeter nodes will have fewer diagonals (corner nodes will only have one diagonal and edge nodes two). In such cases, placeholders of 0 are used.

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.diagonal_dirs_at_node.shape == (grid.number_of_nodes, 4)
True
>>> grid.diagonal_dirs_at_node
array([[-1,  0,  0,  0], [-1, -1,  0,  0], [ 0, -1,  0,  0],
       [-1,  0,  0,  1], [-1, -1,  1,  1], [ 0, -1,  1,  0],
       [-1,  0,  0,  1], [-1, -1,  1,  1], [ 0, -1,  1,  0],
       [ 0,  0,  0,  1], [ 0,  0,  1,  1], [ 0,  0,  1,  0]],
       dtype=int8)

The lower-right corner node only has one diagonal.

>>> grid.diagonal_dirs_at_node[2]
array([ 0, -1,  0,  0], dtype=int8)

A node on one of the edges has two diagonals.

>>> grid.diagonal_dirs_at_node[3]
array([-1,  0,  0,  1], dtype=int8)
property diagonal_status_at_node#
property diagonals_at_node#

Diagonals attached to nodes.

Returns

Diagonals at each node.

Return type

ndarray of int, shape (n_nodes, 4)

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.diagonals_at_node.shape == (grid.number_of_nodes, 4)
True
>>> grid.diagonals_at_node
array([[ 0, -1, -1, -1], [ 2,  1, -1, -1], [-1,  3, -1, -1],
       [ 4, -1, -1,  1], [ 6,  5,  0,  3], [-1,  7,  2, -1],
       [ 8, -1, -1,  5], [10,  9,  4,  7], [-1, 11,  6, -1],
       [-1, -1, -1,  9], [-1, -1,  8, 11], [-1, -1, 10, -1]])
property length_of_d8#

Length of links and diagonals.

Return the lengths links and diagonals in the grid. Links are listed first and then diagonals.

Returns

Link lengths.

Return type

ndarray of float

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((3, 3), xy_spacing=(4, 3))
>>> grid.length_of_link
array([ 4.,  4.,  3.,  3.,  3.,  4.,  4.,  3.,  3.,  3.,  4.,  4.])
>>> grid.length_of_d8 
array([ 4.,  4.,  3.,  3.,  3.,
        4.,  4.,  3.,  3.,  3.,
        4.,  4.,  5.,  5.,  5.,
        5.,  5.,  5.,  5.,  5.])
property length_of_diagonal#
property nodes_at_d8#
property nodes_at_diagonal#

Nodes at diagonal tail and head.

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.nodes_at_diagonal.shape == (grid.number_of_diagonals, 2)
True
>>> grid.nodes_at_diagonal
array([[ 0,  4], [ 1,  3], [ 1,  5], [ 2,  4],
       [ 3,  7], [ 4,  6], [ 4,  8], [ 5,  7],
       [ 6, 10], [ 7,  9], [ 7, 11], [ 8, 10]])

The first column is diagonal tail and the second the head.

>>> grid.diagonals_at_node[3]
array([ 4, -1, -1,  1])
>>> grid.nodes_at_diagonal[(4, 1), ]
array([[3, 7],
       [1, 3]])
>>> grid.diagonal_dirs_at_node[3]
array([-1,  0,  0,  1], dtype=int8)
property number_of_d8#

Number of links and diagonals.

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.number_of_d8
29
property number_of_diagonals#

Number of diagonals in the grid.

Examples

>>> from landlab import RasterModelGrid
>>> grid = RasterModelGrid((4, 3))
>>> grid.number_of_diagonals
12
reset_status_at_node()[source]#
property status_at_d8#
property status_at_diagonal#

Status at diagonals.

Examples

>>> from landlab import LinkStatus, NodeStatus, RasterModelGrid
>>> grid = RasterModelGrid((4, 3))

An inactive link (or diagonal) is one that joins two boundary nodes or has one end that is a closed boundary.

>>> grid.status_at_node
array([1, 1, 1,
       1, 0, 1,
       1, 0, 1,
       1, 1, 1], dtype=uint8)
>>> NodeStatus.CORE, NodeStatus.FIXED_VALUE
(<NodeStatus.CORE: 0>, <NodeStatus.FIXED_VALUE: 1>)

Diagonals that connect two boundary nodes are inactive.

>>> grid.status_at_diagonal
array([0, 4, 4, 0,
       0, 0, 0, 0,
       4, 0, 0, 4], dtype=uint8)
>>> LinkStatus.ACTIVE, LinkStatus.INACTIVE
(<LinkStatus.ACTIVE: 0>, <LinkStatus.INACTIVE: 4>)

By setting a node to closed that wasn’t before, a new link becomes inactive.

>>> grid.status_at_node[5] = NodeStatus.CLOSED
>>> grid.status_at_diagonal
array([0, 4, 4, 0,
       0, 0, 0, 4,
       4, 0, 0, 4], dtype=uint8)
create_diagonals_at_node(shape, out=None)[source]#

Create array of diagonals at node.

Create an array that gives the diagonal touching each node for a structured grid of quadrilaterals. For each node, links are ordered clockwise from axis=1.

Parameters
  • shape (tuple of (n_rows, n_cols)) – Shape as number of node rows and node columns.

  • out (ndarray of shape (n_nodes, 4), optional) – Output buffer to place diagonal ids at each node.

Returns

out – Diagonals at node with -1 for missing diagonals.

Return type

ndarray of shape (n_nodes, 4)

Examples

>>> from landlab.grid.diagonals import create_diagonals_at_node
>>> create_diagonals_at_node((3, 4))
array([[ 0, -1, -1, -1],
       [ 2,  1, -1, -1],
       [ 4,  3, -1, -1],
       [-1,  5, -1, -1],
       [ 6, -1, -1,  1],
       [ 8,  7,  0,  3],
       [10,  9,  2,  5],
       [-1, 11,  4, -1],
       [-1, -1, -1,  7],
       [-1, -1,  6,  9],
       [-1, -1,  8, 11],
       [-1, -1, 10, -1]])
create_nodes_at_diagonal(shape, out=None)[source]#

Create array of tail and head nodes for diagonals.

Parameters
  • shape (tuple of (n_rows, n_cols)) – Shape as number of node rows and node columns.

  • out (ndarray of shape (n_diagonals, 2), optional) – Output buffer to place nodes at each diagonal.

Returns

out – Tail and head node for each diagonal.

Return type

ndarray of shape (n_diagonals, 2)

Examples

>>> from landlab.grid.diagonals import create_nodes_at_diagonal
>>> create_nodes_at_diagonal((3, 4)) 
array([[ 0, 5], [ 1, 4], [ 1,  6], [ 2, 5], [ 2,  7], [ 3,  6],
       [ 4, 9], [ 5, 8], [ 5, 10], [ 6, 9], [ 6, 11], [ 7, 10]])