-
foxes.output.FlowPlots2D.get_states_data_yz(var, x_direction=
270.0, vmin=None, vmax=None, data_format='numpy', **kwargs)[source] Generates 2D farm flow figure in a horizontal yz-plane.
Parameters¶
- var: str
The variable name
- x_direction: float, optional
The direction of the x axis, 0 = north
- 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_yz
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)