util.mcdomain.mcdomain_to_geometry

util.mcdomain.mcdomain_to_geometry(
    x_index,
    y_index,
    z,
    boundary_condition=None,
    adjacency=four_points_adjacency(),
)

Convert a given data to a grid geometry object with multiple boundaries. Input data are assumed to be of the same size.

Parameters

Name	Type	Description	Default
x_index	list of int	A list(-like) of unsigned (x, y) indices.	required
y_index	list of int	A list(-like) of unsigned (x, y) indices.	required
z	numpy.array	One dimensional height data.	required
data	numpy.array	A two-dimensional array.	required
boundary_condition	dict	Specify a boundary value tactic at each boundary within dict {geotype: tactic_name_or_func}. Parameters ———- geotype : int The boundary id. See also psiclone.geometry.Geotype. tactic : {‘average’, ‘min’, ‘max’} or float or callable object Specify a boundary value tactic. If it is a string, its corresponding numpy function is called to compute the boundary value. If it is float, its value is set. If it is callable, it is called with the signature tactic(geotype, dtype, levels) to compute the boundary value. Parameters ———- geotype : int The boundary id. The boundary id. See also psiclone.geometry.Geotype. dtype : data-type levels : numpy.array Height data at the boundary nodes.	None