Welcome to Wave_Function_Propagation’s documentation!¶
Contents:
Welcome to the very first Manual for the wave function propagtaion module¶
Brief introduction to the module structure¶
Here is a short list for module’s sub-modules:
Stage_1.py
Stage_2.py
Locpot_class.py
Help_function_library_yair.py
Structure_vis.py
Main_execution.py
In the next sections, each one of the sub-modules will be described with more details about its capalities, and about its role in the bigger work-flow of the wave-function propagation module
Stage_1¶
The user also have to supply the standard deviation, :math:`sigma` , of the gaussian wave-function. The electron initial wave-function is of the form of gaussians wave-packets that centered at \(z_0\). This is the initial position where the most likelyhood to find the electorn at the initial conditions.
To sum up this section:¶
Stage_1: > - The importance of extracting the necessary parameters for the electron wave-function such as: :math:`E_0`, grid-density, :math:`sigma`.> These parameters will be given as an input for the next step of the algorithm with no dependence whether the grid-density convergence test was held or not. > - Performing the Convergence test for the grid density. Usually it will be preferable to converge the simplest system we have. Namely, if we can apply the convergence test to one of the bulk-material system it will end with cheaper computitional cost. > - All kind of systems should be undergone a grid-density convergence test: an interface system, slabs (with or without a vaccuum), and bulk continiuos materials. > - None of the changes that will be performed at this level will not affect the next steps in the algorithm. It just passes the crucial parameters for the next steps.
Stage_2¶
System size
It stands for acheiving the convegred system’s length in which the transmission coefficient difference between two consecutive iterations does not surpass 0.01. In addition, it demands energy conservation thus two successive iterations yeild initial total energies that do not deviate in more than 0.01 eV.
Time step convergence test
Some more capabilties of Stage_2:
Stage_2: > - It enables to elongate to local potential vector of any form of system. > - It enables to apply all the parameters describing the wave-function that found in Stage_1 in the new local potential interface system. > - It allows to propagte the wave-function in time across our system applying the split-step method. > - It offers the option of creating the simultion animation. > - It can calculates the cumulative probabilty through the interface position or any other specified reference position. > - System size and time step convergence tests.
Using the Gui for executing some opertaions¶
First what it requires to be installed in order to use: > - python 3.7 and above > - installed packages and modules: >> - Anaconda environment >> - Pymatgen >> - PySimpleGUI
How it looks like :
Work-flow: > - Loading the locpot file. If you have an interface, you can load the bulk-materials locpots too. > - Define your system. Do you have an interface? Do you refer to a certain range within your local potential (in cases of vaccum or any slabs form). Pay attention that chossing this will result in popping up another window to supply the range. (It will pop-up after submiting the entire form). > - The next step is choosing whether or not to perform any kind of convergence test. Please notice that if you decided not to perform any convergence test you will be asked to provide the initial conditions manually after submitting the entire form. > - Providing initial paramters for initializing the wave-function. > - Choosing the main axis that all the calculations will be referenced at. The default is z. > - Last but not least, you can choose what operations you would like to do. |image|
> NOTE: Do not try to test all the combinations of all possibilites, it will fail. It desined to perform only the reasonable paths, and it has not have a self-failiure proof. |
)
