Boundary handling for grid edges#

set_status_at_node_on_edges(grid, right=None, top=None, left=None, bottom=None)[source]#

Set node status on grid edges.

Parameters:

  • right (int, optional) – Node status along right edge.

  • top (int, optional) – Node status along top edge.

  • left (int, optional) – Node status along left edge.

  • bottom (int, optional) – Node status along bottom edge.

Examples

>>> from landlab import RasterModelGrid

>>> grid = RasterModelGrid((3, 4))
>>> grid.status_at_node 
array([1, 1, 1, 1,
       1, 0, 0, 1,
       1, 1, 1, 1], dtype=uint8)

>>> grid.set_status_at_node_on_edges(right=grid.BC_NODE_IS_CLOSED)
>>> grid.status_at_node 
array([1, 1, 1, 4,
       1, 0, 0, 4,
       1, 1, 1, 4], dtype=uint8)

>>> grid = RasterModelGrid((3, 4))

The status of a corner is set along with its clockwise edge. That is, if setting the status for the top and right edges, the upper-right corner has the status of the right edge.

>>> grid.set_status_at_node_on_edges(top=grid.BC_NODE_IS_CLOSED,
...     right=grid.BC_NODE_IS_FIXED_GRADIENT)
>>> grid.status_at_node 
array([1, 1, 1, 2,
       1, 0, 0, 2,
       4, 4, 4, 2], dtype=uint8)

In the above example, if you wanted the corner to have the status of the top edge, you need to make two calls to set_status_at_node_on_edges,

>>> grid = RasterModelGrid((3, 4))
>>> grid.set_status_at_node_on_edges(right=grid.BC_NODE_IS_FIXED_GRADIENT)
>>> grid.set_status_at_node_on_edges(top=grid.BC_NODE_IS_CLOSED)
>>> grid.status_at_node 
array([1, 1, 1, 2,
       1, 0, 0, 2,
       4, 4, 4, 4], dtype=uint8)

An example that sets all of the edges shows how corners are set.

>>> grid.set_status_at_node_on_edges(right=1, top=2, left=3, bottom=4)
>>> grid.status_at_node 
array([3, 4, 4, 4,
       3, 0, 0, 1,
       2, 2, 2, 1], dtype=uint8)