class foxes.output.FlowPlots2D(foxes.output.SliceData)[source]

Class for horizontal or vertical 2D flow plots

Public members

get_mean_fig_xy(var, xlabel='x [m]', ylabel='y [m]', ...)[source]

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

get_mean_fig_xz(var, x_direction=270, xlabel='x [m]', ...)[source]

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

get_mean_fig_yz(var, x_direction=270, ylabel='x [m]', ...)[source]

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

gen_states_fig_xy(var, xlabel='x [m]', ylabel='y [m]', ...)[source]

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

gen_states_fig_xz(var, x_direction=270.0, xlabel='x [m]', ...)[source]

Generates 2D farm flow figure in a vertical xz-plane.

gen_states_fig_yz(var, x_direction=270.0, ylabel='y [m]', ...)[source]

Generates 2D farm flow figure in a vertical yz-plane.

FlowPlots2D(algo, farm_results, verbosity_delta=1, **kwargs)[source]

Constructor.

get_mean_data_xy(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in a horizontal xy-plane.

get_mean_data_xz(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in an xz-plane.

get_mean_data_yz(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in a yz-plane.

get_states_data_xy(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in a horizontal xy-plane.

get_states_data_xz(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in an xz-plane.

get_states_data_yz(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in a yz-plane.

get_fpath(fname)[source]

Gets the total file path

write(file_name, data, format_col2var={}, format_dict={}, **kwargs)[source]

Writes data to file via pandas.

classmethod print_models()[source]

Prints all model names.

classmethod new(output_type, *args, **kwargs)[source]

Run-time output model factory.