Skip to content

subtile_grid_sizer

SubtileGridSizer

Bases: GridSizer

dim_extents property

__init__(nx, ny, nz, n_halo, data_dimensions, backend)

from_tile_params(nx_tile, ny_tile, nz, n_halo, layout, *, backend, data_dimensions=None, tile_partitioner=None, tile_rank=0) classmethod

Create a SubtileGridSizer from parameters about the full tile.

Parameters:

Name Type Description Default
nx_tile int

number of x cell centers on the tile

required
ny_tile int

number of y cell centers on the tile

required
nz int

number of vertical levels

required
n_halo int

number of halo points

required
layout tuple[int, int]

(y, x) number of ranks along tile edges

required
backend Backend

current backend in use

required
data_dimensions dict[str, int] | None

lengths of any non-x/y/z dimensions, such as land or radiation dimensions

None
tile_partitioner optional

partitioner object for the tile. By default, a TilePartitioner is created with the given layout

None
tile_rank optional

rank of this subtile

0

from_namelist(namelist, tile_partitioner=None, tile_rank=0, *, backend) classmethod

Create a SubtileGridSizer from a Fortran namelist.

Parameters:

Name Type Description Default
namelist dict

A namelist for the fv3gfs fortran model

required
tile_partitioner optional

a partitioner to use for segmenting the tile. By default, a TilePartitioner is used

None
tile_rank optional

current rank on tile. Default is 0. Only matters if different ranks have different domain shapes. If tile_partitioner is a TilePartitioner, this argument does not matter

0
backend Backend

current backend in use

required

get_origin(dims)

get_extent(dims)

get_shape(dims)