cf.CellConnectivityArray.__init__

CellConnectivityArray.__init__(cell_connectivity=None, start_index=None, cell_dimension=None, source=None, copy=True)[source]

Initialisation

Parameters:
cell_connectivity: array_like

A 2-d integer array that contains indices which map each cell to its neighbours, as found in a UGRID “face_face_connectivity”, or “volume_volume_connectivity” variable.

start_index: int

The base of the indices provided by the integer index array. Must be 0 or 1 for zero- or one-based indices respectively.

cell_dimension: int

The position of the data dimension that indexes the cells, either 0 or 1.

source: optional

Convert source, which can be any type of object, to a CellConnectivityArray instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the CellConnectivityArray API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a CellConnectivityArray instance then cf.CellConnectivityArray(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.