cf.PointTopologyArray.__init__

PointTopologyArray.__init__(edge_node_connectivity=None, face_node_connectivity=None, shape=None, start_index=None, cell_dimension=None, source=None, copy=True)[source]

Initialisation

Parameters:
edge_node_connectivity: array_like, optional

A 2-d integer array of indices that corresponds to a UGRID “edge_node_connectivity” variable.

face_node_connectivity: array_like, optional

A 2-d integer array of indices that corresponds to a UGRID “face_node_connectivity” variable.

shape: tuple, optional

The shape of the point cell domain topology array. If the shape is unknown (because the connectivity array has not been read yet) then set to None, which will result in a shape of (nan, nan).

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 PointTopologyArray instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the PointTopologyArray 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 PointTopologyArray instance then cf.PointTopologyArray(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.