flowx.io._interface package

Submodules

flowx.io._interface._display_stats module

Module with I/O functions.

flowx.io._interface._display_stats.display_stats(scalars)

Display stats specified by user.

Parameters

scalars (object) – Scalar class object containing neccesary information for head up display

flowx.io._interface._plot_contour module

Module with I/O functions.

flowx.io._interface._plot_contour._fmt(x, pos)
flowx.io._interface._plot_contour.plot_contour(grid, ivar, auxvars=[], particle=None, scalars=None, levels=None)

Plot the filled contour of a variable on a meshgrid.

Parameters
  • grid (Grid object) – Grid containing the data.

  • ivar (string) – Name of the variable to plot.

flowx.io._interface._plot_line module

Module with I/O functions.

flowx.io._interface._plot_line.plot_line(particle)

Plot the vector for given x, y data.

flowx.io._interface._plot_mesh module

Module with I/O functions.

flowx.io._interface._plot_mesh.plot_mesh(grid, particle=None)

Plot the mesh on a meshgrid.

Parameters
  • grid (Grid object) – Grid containing the data.

  • var (string) – Name of the variable to plot.

flowx.io._interface._plot_scatter module

Module with I/O functions.

flowx.io._interface._plot_scatter.plot_scatter(particles)

Plot the vector for given x, y data.

flowx.io._interface._plot_vector module

Module with I/O functions.

flowx.io._interface._plot_vector.plot_vector(gridx, gridy, ivar)

Plot the vector for given x, y data.

Parameters
  • gridx (Grid object) – Grid containing the data on x-face.

  • gridy (Grid object) – Grid containing the data on y-face.

  • ivar (string) – Name of the ivariable to plot.

flowx.io._interface._write_hdf5_checkpoint module

flowx.io._interface._write_hdf5_checkpoint.write_hdf5_checkpoint(domain_data_struct=[None, None, None, None, None], center_vars=None, face_vars=None)

Subroutine to write checkpoint to hdf5 file.

Parameters
  • domain_data_struct (object list) –

  • [gridc

  • gridx

  • gridy

  • scalars

  • particles]

  • center_vars (string list) – List containing center var variable names

  • face_vars (string list) – List containing face var variable names

flowx.io._interface._write_hdf5_output module

flowx.io._interface._write_hdf5_output.map_center_to_edge(grid, ivar)
flowx.io._interface._write_hdf5_output.map_facex_to_edge(grid, ivar)
flowx.io._interface._write_hdf5_output.map_facey_to_edge(grid, ivar)
flowx.io._interface._write_hdf5_output.write_hdf5_output(domain_data_struct=[None, None, None, None, None], center_vars=None, face_vars=None)

Subroutine to write output to hdf5 file.

Parameters
  • domain_data_struct (object list) –

  • [gridc

  • gridx

  • gridy

  • scalars

  • particles]

  • center_vars (string list) – List containing center var variable names

  • face_vars (string list) – List containing face var variable names

Module contents