flopy.utils.lgrutil module

class Lgr(nlayp, nrowp, ncolp, delrp, delcp, topp, botmp, idomainp, ncpp=3, ncppl=1, xllp=0.0, yllp=0.0)[source]

Bases: object

property child

Return a SimpleRegularGrid object for the child model

Returns:: simple_regular_grid – simple grid object containing grid information for the child
Return type:: SimpleRegularGrid

get_delr_delc()[source]

get_exchange_data(angldegx=False, cdist=False)[source]

Get the list of parent/child connections

Returns:: exglist – list of connections between parent and child
Return type:: list

get_idomain()[source]

Return the idomain array for the child model. This will normally be all ones unless the idomain array for the parent model is non-rectangular and irregularly shaped. Then, parts of the child model will have idomain zero cells.

Returns:: idomain – idomain array for the child model
Return type:: ndarray

get_lower_left()[source]

Return the lower left corner of the child grid

Returns:: (xll, yll) – location of lower left corner of the child grid
Return type:: tuple

get_parent_connections(kc, ic, jc)[source]: Return a list of parent cell indices that are connected to child cell kc, ic, jc.

get_parent_indices(kc, ic, jc)[source]: Method returns the parent cell indices for this child. The returned indices are in zero-based indexing.

get_replicated_parent_array(parent_array)[source]

Get a two-dimensional array the size of the child grid that has values replicated from the provided parent array.

Parameters:: parent_array (ndarray) – A two-dimensional array that is the size of the parent model rows and columns.
Returns:: child_array – A two-dimensional array that is the size of the child model rows and columns
Return type:: ndarray

get_shape()[source]

Return the shape of the child grid

Returns:: (nlay, nrow, ncol) – shape of the child grid
Return type:: tuple

get_top_botm()[source]

property parent

Return a SimpleRegularGrid object for the parent model

Returns:: simple_regular_grid – simple grid object containing grid information for the parent
Return type:: SimpleRegularGrid

class SimpleRegularGrid(nlay, nrow, ncol, delr, delc, top, botm, idomain, xorigin, yorigin)[source]

Bases: object

Simple object for representing regular MODFLOW grid information.

Parameters:

nlay (int) – number of layers
nrow (int) – number of rows
ncol (int) – number of columns
delr (ndarray) – delr array
delc (ndarray) – delc array
top (ndarray) – top array (nrow, ncol)
botm (ndarray) – botm array (nlay, nrow, ncol)
idomain (ndarray) – idomain array (nlay, nrow, ncol)
xorigin (float) – x location of grid lower left corner
yorigin (float) – y location of grid lower left corner

get_gridprops_dis6()[source]

property modelgrid