pymead.analysis.calc_aero_data.MPLOTSettings#

class MPLOTSettings(timeout: float = 15.0, grid_stats: bool = False, Mach: bool = False, streamline_grid: bool = False, Grid: bool = False, Grid_Zoom: bool = False, flow_field: bool = False, Tecplot: bool = False, Paraview: bool = False, CPK: bool = False)[source]#

Bases: object

__init__(timeout: float = 15.0, grid_stats: bool = False, Mach: bool = False, streamline_grid: bool = False, Grid: bool = False, Grid_Zoom: bool = False, flow_field: bool = False, Tecplot: bool = False, Paraview: bool = False, CPK: bool = False)[source]#

Defines the inputs for MPLOT. If directly running from run_mplot, only the timeout argument is used. If running from calculate_aero_data, run_mplot is executed once for each of the other parameters that is set to True.

Parameters:

  • timeout (float) – The time in seconds allotted to MPLOT before premature termination. Default: 15.0

  • grid_stats (bool) – Whether to output the grid statistics to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • Mach (bool) – Whether to output the Mach contour image in PDF format to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • streamline_grid (bool) – Whether to output the streamline grid data to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • Grid (bool) – Whether to output an image of the MSET grid in PDF format to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • Grid_Zoom (bool) – Whether to output a zoomed image of the MSET grid in PDF format to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • flow_field (bool) – Whether to dump the flow field data to the analysis directory. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

  • Tecplot (bool) – Whether to output field data and airfoil geometry to a Tecplot ASCII file (.dat). Default: False

  • Paraview (bool) – Whether to output field data and airfoil geometry to Paraview XML files (.vts and .vtp). Default: False

  • CPK (bool) – Whether to calculate the mechanical flow power coefficient and append the data to aero_data.json. Ignored if executing run_mplot directly instead of calculate_aero_data. Default: False

Methods

get_dict_rep()

Gets a dictionary representation of the MPLOT settings.
get_dict_rep() → dict[source]#

Gets a dictionary representation of the MPLOT settings. Used in run_mplot and calculate_aero-data.

Returns:

The MPLOT settings in dictionary form

Return type:

dict