"""
概要:
    別ファイルの関数をimportして、占有された状態密度を描画するスクリプトです。

詳細説明:
    フェルミ・ディラック分布関数と状態密度の計算関数を用いて、
    エネルギーに対する占有された状態密度を算出し、グラフとして表示します。

関連リンク:
    ne_usage
"""
import numpy as np
import matplotlib.pyplot as plt
from fd import fd
from dos import dos


def plot(E, nE):
    """
    概要:
        占有された状態密度のグラフを描画します。

    詳細説明:
        matplotlibを用いて、エネルギーを横軸、占有状態密度を縦軸とした折れ線グラフを表示します。

    引数:
        :param E: エネルギー値の配列。
        :type E: numpy.ndarray
        :param nE: 占有状態密度の配列。
        :type nE: numpy.ndarray
    """
    plt.figure()
    plt.plot(E, nE)
    plt.xlabel("Energy (eV)")
    plt.ylabel("DOS x f (electrons / (eV m$^3$))")
    plt.title("Occupied density of states")
    plt.grid()
    plt.tight_layout()
    plt.show()


def main():
    """
    概要:
        パラメータを設定して占有状態密度の計算と描画を実行します。

    詳細説明:
        温度、フェルミ準位、伝導帯下端エネルギー、有効質量などの物理パラメータを指定し、
        エネルギーの範囲配列を生成したうえで、分布関数と状態密度の積を計算してグラフ描画関数を呼び出します。
    """
    T = 1000  # K
    EF = 1
    EC = 0
    meff = 1
    Emin, Emax = -1, 2
    E = np.linspace(Emin, Emax, 501)
    nE = fd(T, E, EF) * dos(E, EC, meff)
    plot(E, nE)


if __name__ == "__main__":
    main()