UniformRectilinearGrid2D

class fastscape.processes.UniformRectilinearGrid2D(*, shape, spacing, origin)

Create a uniform rectilinear (static) 2-dimensional grid.

shape

Nb. of grid nodes in (y, x)

Variable properties:

type : variable
intent : in
dimensions : (‘shape_yx’,)
static : True

Type:: attr.Attribute

spacing

Grid node spacing in (y, x)

Variable properties:

type : variable
intent : in
dimensions : (‘shape_yx’,)
static : True

Type:: attr.Attribute

origin

(y, x) coordinates of grid origin

Variable properties:

type : variable
intent : in
dimensions : (‘shape_yx’,)
static : True

Type:: attr.Attribute

length

Total grid length in (y, x)

Variable properties:

type : variable
intent : out
dimensions : (‘shape_yx’,)

Type:: attr.Attribute

size

Total nb. of nodes

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

area

Total grid area

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

cell_area

Fixed grid cell area

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

dx

Grid spacing in x (cols)

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

dy

Grid spacing in y (rows)

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

nx

Nb. of nodes in x (cols)

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

ny

Nb. of nodes in y (rows)

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

x

Grid x coordinate

Variable properties:

type : index
intent : out
dimensions : (‘x’,)

Type:: attr.Attribute

y

Grid y coordinate

Variable properties:

type : index
intent : out
dimensions : (‘y’,)

Type:: attr.Attribute

Methods

`__init__`(*, shape, spacing, origin)	Method generated by attrs for class UniformRectilinearGrid2D.
`initialize`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import UniformRectilinearGrid2D

In [3]: xs.process_info(UniformRectilinearGrid2D)
<UniformRectilinearGrid2D  (xsimlab process)>
Variables:
    shape         [in] ('shape_yx',) nb. of grid nodes in (y, x)
    spacing       [in] ('shape_yx',) grid node spacing in (y, x)
    origin        [in] ('shape_yx',) (y, x) coordinates of grid origin
    length       [out] ('shape_yx',) total grid length in (y, x)
    size         [out] total nb. of nodes
    area         [out] total grid area
    cell_area    [out] fixed grid cell area
    dx           [out] grid spacing in x (cols)
    dy           [out] grid spacing in y (rows)
    nx           [out] nb. of nodes in x (cols)
    ny           [out] nb. of nodes in y (rows)
    x            [out] ('x',) grid x coordinate
    y            [out] ('y',) grid y coordinate
Simulation stages:
    initialize