import_hole_fermi_level{ }¶

Calling sequence

currents{ import_hole_fermi_level{ } }

Properties

using: \(\mathrm{\textcolor{ForestGreen}{optional\;within\;the\;scope}}\)
items: \(\mathrm{maximum\;1}\)

Dependencies

The global group import{ } and the nested group import_electron_fermi_level{ } must be defined.

Functionality

The group allows importing hole quasi-Fermi level to initialize related solver.

Please note that, in case importing an already converged result from solving a (classical or quantum) current-Poisson equation, one should import the electrostatic potential as well to obtain the best convergence.

Moreover, if the imported quasi-Fermi levels and electrostatic potential are resulting from a self-consistent simulation including the Schrödinger equation, and the current simulation is also aiming at solving all three equations self-consistently, then one should omit the running the classical mode of simulation, namely should not call any of the groups poisson{ } and current_poisson{ }. The simulation should begin already with solving the Schrödinger equation to get the best convergence, i.e., quantum_current_poisson{ }.

In case of changed contact bias, one should note that quasi-Fermi levels and electric potential are only imported for areas where they are not defined by boundary conditions (see contacts{ }), i.e., they cannot be used to replace these definitions.

Warning

Importing Fermi levels or potential from a simulation with different contact biases results in discontinuities of both quasi-Fermi levels and electric potential at the edge of the contacts, which may lead either to nonphysical results without subsequent iteration or to very poor convergence in subsequent iterations.

Example

currents{
    recombination_model{}
    import_electron_fermi_level{...}
    import_hole_fermi_level{...}
}

import{...}

Nested keywords

Maintained Keywords¶

The keywords below are available in at least one of currently published releases and are planned to be included also in the next release.

import_from¶

Calling sequence

currents{ import_hole_fermi_level{ import_from } }

Properties

using: \(\mathrm{\textcolor{WildStrawberry}{required\;within\;the\;scope}}\)
type: \(\mathrm{character\;string}\)

Functionality

A reference name to the path of the imported file defined in import{ }.

Example

currents{
    recombination_model{}
    import_electron_fermi_level{
        import_from = "reference_name_1"
    }
    import_hole_fermi_level{
        import_from = "reference_name_2"
    }
}

import{
    file{
        name = "reference_name_1"
        ...
    }
    analytic_function{
        name = "reference_name_2"
        ...
    }
}

component_number¶

Calling sequence

currents{ import_hole_fermi_level{ component_number } }

Properties

using: \(\mathrm{\textcolor{ForestGreen}{optional\;within\;the\;scope}}\)
type: \(\mathrm{integer}\)
unit: \(\mathrm{-}\)
values: {1, 2, 3, 4, ...}
default: 1

Functionality

A number referring to the column of numbers in the imported file to be used as the electron quasi-Fermi level.

Example

currents{
    recombination_model{}
    import_electron_fermi_level{
        import_from = "reference_name"
        component_number = 2
    }
    import_hole_fermi_level{
        import_from = "reference_name"
        component_number = 3
    }
}

import{
    file{
        name = "reference_name"
        ...
    }
}