Generates 2D farm flow figure in a horizontal xy-plane.

Parameters¶

var: str

The variable name

vmin: float, optional

The minimal variable value

vmax: float, optional

The maximal variable value

data_format: str

The output data format: numpy, pandas, xarray

kwargs: dict, optional

Additional parameters for SliceData.get_states_data_xy

Returns¶

parameters: dict

The parameters used

data: dict or pandas.DataFrame or xarray.Dataset

The gridded data

states: numpy.ndarray, optional

The states indices

grid_data: tuple, optional

The grid data (x_pos, y_pos, z_pos, g_pts)