"""

name: square_well.py

Computes the energy levels of a finite square well.

Problem 6.14 from Newman's Computational Physics.

author: Sam Wilson
date created: 29/3/2021


"""


# part a
# function name: calc_ys

    """
    Calculate the y functions for given energy values.

    Parameters
    ----------
    Es : array of FLOAT
        Energy values to calculate y functions at.

    Returns
    -------
    y1 : array of FLOAT
        y1 at Es values.
    y2 : array of FLOAT
        y2 at Es values.
    y3 : array of FLOAT
        y3 at Es values.

    """

    return np.array(y1), np.array(y2), np.array(y3)
    
#function name: plot_functions

    """
    Plots the lefthand and righthand sides of the transcendental equation

    Parameters
    ----------
    Es : array of FLOAT
        Energy values to calculate y functions at.
    y1 : array of FLOAT
        y1 at Es values.
    y2 : array of FLOAT
        y2 at Es values.
    y3 : array of FLOAT
        y3 at Es values.

    Returns
    -------
    None.

    """
        


    
        
# funton name: calc_Es 

    """
    Compute the first 6 energy levels of the finite square well

    Returns
    -------
    E0 : FLOAT
        Ground state energy level.
    E1 : FLOAT
        1st excited state.
    E2 : FLOAT
        2nd excited state.
    E3 : FLOAT
        3rd excited state.
    E4 : FLOAT
        4th excited state.
    E5 : FLOAT
        5th excited state.

    """

    
def main(): 
    


if __name__ == "__main__":
    main()

