run_calculations

ThomasFermi.run_calculations(*, include_energy_matrix=False, include_current=False, include_transitions=False, n_guess=None)

Run the simulation.

Parameters:
  • include_energy_matrix (bool) – Whether to include the capacitance model and WKB probabilities in the output.

  • include_current (bool) – Whether to perform current calculations and include the results in the output.

  • include_transitions (bool) – Whether to perform current calculations and include the transition count in the output.

  • n_guess (ndarray[float], optional) – Initial guess (in 1/nm) for the particle density n(x). If absent, an array of zeros will be used.

Returns:

output – The results of the calculation.

Return type:

ThomasFermiOutput