supersolids.helper.simulate_case

Animation for the numerical solver for the non-linear time-dependent Schrodinger equation for 1D, 2D and 3D in single-core.

Module Contents

Functions

simulate_case(System, Anim, accuracy = 10**(-6), delete_input = True, dir_path = Path.home().joinpath('supersolids', 'results'), dir_name_result = '', slice_indices = [0, 0, 0], offscreen = False, x_lim = (-1.0, 1.0), y_lim = (-1.0, 1.0), z_lim = (-1.0, 1.0), filename_schroedinger = 'schroedinger.pkl', filename_steps = 'step_', steps_format = '%07d', steps_per_npz = 10, frame_start = 0)

Wrapper for Animation and Schroedinger to get a working Animation
supersolids.helper.simulate_case.simulate_case(System, Anim, accuracy=10 ** - 6, delete_input=True, dir_path=Path.home().joinpath('supersolids', 'results'), dir_name_result='', slice_indices=[0, 0, 0], offscreen=False, x_lim=(- 1.0, 1.0), y_lim=(- 1.0, 1.0), z_lim=(- 1.0, 1.0), filename_schroedinger='schroedinger.pkl', filename_steps='step_', steps_format='%07d', steps_per_npz=10, frame_start=0)

Wrapper for Animation and Schroedinger to get a working Animation of a System through the equations given by Schroedinger.

Parameters

  • System (supersolids.Schroedinger.Schroedinger) – Schrödinger equations for the specified system

  • Anim (supersolids.Animation.Animation.Animation) –

    class

    Animation with configured properties

  • accuracy (float) – Convergence is reached when relative error of mu is smaller than accuracy, where \(\mu = - \log(\psi_{normed}) / (2 dt)\)

  • offscreen (bool) – Condition for interactive mode. When camera functions are used, then interaction is not possible. So interactive=True turn the usage of camera functions off.

  • delete_input (bool) – Condition if the input pictures should be deleted, after creation the creation of the animation as e.g. mp4

  • dir_path (pathlib.Path) – Path where to look for old directories (movie data)

  • dir_name_result (str) – Name of directory where to save the results at. For example the standard naming convention is movie002”)

  • slice_indices (numpy.ndarray) – Numpy array with indices of grid points in the directions x, y, z (in terms of System.x, System.y, System.z) to produce a slice/plane in mayavi, where \(\psi_{prob}\) = \(|\psi|^2\) is used for the slice Max values is for e.g. System.Res.x - 1.

  • x_lim (Tuple[float, float]) – Limits of plot in x direction

  • y_lim (Tuple[float, float]) – Limits of plot in y direction

  • z_lim (Tuple[float, float]) – Limits of plot in z direction

  • filename_schroedinger (str) – Name of file, where the Schroedinger object is saved

  • filename_steps (str) – Name of file, without enumerator for the files. For example the standard naming convention is step_000001.npz, the string needed is step_

  • steps_format (str) – Formatting string for the enumeration of steps.

  • steps_per_npz (int) – Number of dt steps skipped between saved npz.

  • frame_start (int) – Number of named file, where psi_val is loaded from. For example the standard naming convention is step_000001.npz

Returns

Reference to Schroedinger System

Return type

supersolids.Schroedinger.Schroedinger