open_viewmin.open_viewmin

open_viewmin.open_viewmin#

Executable “front-end” file

Attributes#

filenames

names of files to import

plotter_class

subtype of FilterTreePlot to set up

Classes#

NematicPlot

Plotter class for nematic liquid crystals visualization,

Module Contents#

class NematicPlot(filenames=None, q0=0.0, user_settings=None, data_format='open-Qmin', sep='\t', reader=None, theme=None, dims=None, data_stride=1, **kwargs)#

Bases: open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt, open_viewmin.nematic.nematic_plot.nematic_plot_no_qt.NematicPlotNoQt

Plotter class for nematic liquid crystals visualization, with the filters tree, in a Qt window.

Parameters:

  • filenames (list[str], str, or None, optional) – Files to import.

  • q0 (float, optional) – Chiral wavenumber for cholesteric (chiral nematic) ground state, used in free energy calculations.

  • user_settings (dict or None, optional) – Customizations to default plotter settings.

  • data_format (['open-Qmin' | 'Qmin' | 'director'], optional) – Formatting style of data text files to import; used only if parameter reader has value None.

  • sep (str, optional) – Column delimiter for imported text file(s)

  • reader (callable() or None, optional) – Function for reading data from text files; set to None to use the data_format (and, optionally, sep) parameters to determine data import behavior.

  • theme (['dark' | 'document' | 'paraview' | None], optional) – PyVista plot theme

  • dims (tuple(int) or None) – System size; used only if filenames is None.

  • data_stride (int, optional) – Data spacing; used only if filenames is None.

  • kwargs (dict, optional) – Keyword arguments to FilterTreePlot

auto_setup(notebook=False)#
finish_setup_calculate_menu()#

Add nematic-specific items to the “Calculate” menu

setup_defects()#

Automatic setup for defects visualization

setup_director()#

Automatic setup for director visualization

show_jones(**kwargs)#

Display optical transmission, calculated from Jones matrices, on three planes.

Parameters:

kwargs (dict, optional)

Returns:

callback that refreshes Jones planes by re-applying the control slider widgets

Return type:

callable()

filenames = []#

names of files to import

plotter_class#

subtype of FilterTreePlot to set up

Contents