Finds the root of func using the bisection method.
| Parameters: | func : function
a : number
b : number
xtol : number, optional
maxiter : number, optional
|
|---|
Bases: object
Methods
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
Adds a Parameter object to the instance.
If a Parameter with the same name or alias has already been added and overload is False (the default), a ValueError is thrown.
If a class member or method with the same name or alias is already defined, a ValueError is thrown, regardless of the value of overload.
Bases: openbandparams.alloy.Alloy
The base class for all III-V alloys.
Methods
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
Bases: openbandparams.iii_v_alloy.IIIVAlloy
The base class for all III-V zinc blende alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| F | |
| a | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_X_DOS | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface.
| Parameters: | target : Alloy with a parameter or float
|
|---|
Bases: openbandparams.iii_v_zinc_blende_alloy.IIIVZincBlendeAlloy
The base class for all III-V zinc blende binary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| F | |
| a | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the fractional concentration of element with respect to its sublattice. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_X_DOS | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
Bases: openbandparams.iii_v_zinc_blende_alloy.IIIVZincBlendeAlloy
The base class for all III-V zinc blende mixed alloys, i.e. ternaries, quaternaries, quinaries, etc.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Delta_SO | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| Ep | |
| F | |
| VBO | |
| __call__(**kwargs) | Used to specify the alloy composition. |
| a | |
| a_300K | |
| a_c | |
| a_v | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| b | |
| c11 | |
| c12 | |
| c44 | |
| d | |
| dielectric | |
| dielectric_high_frequency | |
| electron_affinity | |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| luttinger1 | |
| luttinger2 | |
| luttinger3 | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_L_long | |
| meff_e_L_trans | |
| meff_e_X_DOS | |
| meff_e_X_long | |
| meff_e_X_trans | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
| thermal_expansion |
Bases: openbandparams.iii_v_zinc_blende_mixed_alloy.IIIVZincBlendeMixedAlloy
The base class for all III-V zinc blende quaternary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Delta_SO | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| Ep | |
| F | |
| VBO | |
| __call__(**kwargs) | Used to specify the alloy composition. |
| a | |
| a_300K | |
| a_c | |
| a_v | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| b | |
| c11 | |
| c12 | |
| c44 | |
| d | |
| dielectric | |
| dielectric_high_frequency | |
| electron_affinity | |
| element_fraction(element) | |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger1 | |
| luttinger2 | |
| luttinger3 | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_L_long | |
| meff_e_L_trans | |
| meff_e_X_DOS | |
| meff_e_X_long | |
| meff_e_X_trans | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
| thermal_expansion |
Bases: openbandparams.iii_v_alloy.IIIVAlloy
The base class for biaxial-strained III-V zinc blende binary alloys grown on a (001) surface.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| CBO_hydrostatic_strain_shift | |
| CBO_strain_shift | |
| Eg | |
| Eg_hh | |
| Eg_lh | |
| Eg_strain_shift | |
| VBO | |
| VBO_hh | |
| VBO_hh_strain_shift | |
| VBO_hydrostatic_strain_shift | |
| VBO_lh | |
| VBO_lh_strain_shift | |
| VBO_strain_shift | |
| VBO_uniaxial_strain_shift | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the fractional concentration of element with respect to its sublattice. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| meff_e_Gamma | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strain_in_plane | |
| strain_out_of_plane | |
| substrate_a |
Bases: openbandparams.iii_v_zinc_blende_mixed_alloy.IIIVZincBlendeMixedAlloy
The base class for all III-V zinc blende ternary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Delta_SO | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| Ep | |
| F | |
| VBO | |
| __call__(**kwargs) | Used to specify the alloy composition. |
| a | |
| a_300K | |
| a_c | |
| a_v | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| b | |
| c11 | |
| c12 | |
| c44 | |
| d | |
| dielectric | |
| dielectric_high_frequency | |
| electron_affinity | |
| element_fraction(element) | |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger1 | |
| luttinger2 | |
| luttinger3 | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_L_long | |
| meff_e_L_trans | |
| meff_e_X_DOS | |
| meff_e_X_long | |
| meff_e_X_trans | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
| thermal_expansion |
Bases: object
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: openbandparams.parameter.Parameter
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: openbandparams.parameter.Parameter
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: object
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: openbandparams.parameter.Parameter
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: openbandparams.parameter.Parameter
Methods
| __call__(*args, **kwargs) | |
| get_references() |
Bases: object
Methods
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
Adds a Parameter object to the instance.
If a Parameter with the same name or alias has already been added and overload is False (the default), a ValueError is thrown.
If a class member or method with the same name or alias is already defined, a ValueError is thrown, regardless of the value of overload.
Returns the atomic fraction of the given element.
Returns the named parameter if present, or the value of default, otherwise.
Returns a list of the unique parameters (no duplicates).
Returns True if the named parameter is present, or False, otherwise.
Returns a LaTeX representation of the alloy.
Same as calling add_parameter with overload=True
Bases: openbandparams.iii_v_alloy.IIIVAlloy
The base class for all III-V zinc blende alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| F | |
| a | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the atomic fraction of the given element. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | Returns a LaTeX representation of the alloy. |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_X_DOS | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface.
| Parameters: | target : Alloy with a parameter or float
|
|---|
Bases: openbandparams.iii_v_zinc_blende_alloy.IIIVZincBlendeAlloy
The base class for all III-V zinc blende binary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| F | |
| a | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| electron_affinity | |
| element_fraction(element) | Returns the fractional concentration of element with respect to its sublattice. |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_X_DOS | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
Returns the fractional concentration of element with respect to its sublattice. In a III-V binary, the fraction is either 1 if element is present, or 0 if it is not.
Bases: openbandparams.iii_v_zinc_blende_mixed_alloy.IIIVZincBlendeMixedAlloy
The base class for all III-V zinc blende ternary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Delta_SO | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| Ep | |
| F | |
| VBO | |
| __call__(**kwargs) | Used to specify the alloy composition. |
| a | |
| a_300K | |
| a_c | |
| a_v | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| b | |
| c11 | |
| c12 | |
| c44 | |
| d | |
| dielectric | |
| dielectric_high_frequency | |
| electron_affinity | |
| element_fraction(element) | |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger1 | |
| luttinger2 | |
| luttinger3 | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_L_long | |
| meff_e_L_trans | |
| meff_e_X_DOS | |
| meff_e_X_long | |
| meff_e_X_trans | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
| thermal_expansion |
Bases: openbandparams.iii_v_zinc_blende_mixed_alloy.IIIVZincBlendeMixedAlloy
The base class for all III-V zinc blende quaternary alloys.
Methods
| CBO | |
| CBO_Gamma | |
| CBO_L | |
| CBO_X | |
| Delta_SO | |
| Eg | |
| Eg_Gamma | |
| Eg_L | |
| Eg_X | |
| Ep | |
| F | |
| VBO | |
| __call__(**kwargs) | Used to specify the alloy composition. |
| a | |
| a_300K | |
| a_c | |
| a_v | |
| add_parameter(parameter[, overload]) | Adds a Parameter object to the instance. |
| b | |
| c11 | |
| c12 | |
| c44 | |
| d | |
| dielectric | |
| dielectric_high_frequency | |
| electron_affinity | |
| element_fraction(element) | |
| get_parameter(name[, default]) | Returns the named parameter if present, or the value of default, otherwise. |
| get_unique_parameters() | Returns a list of the unique parameters (no duplicates). |
| has_parameter(name) | Returns True if the named parameter is present, or False, otherwise. |
| latex() | |
| luttinger1 | |
| luttinger2 | |
| luttinger3 | |
| luttinger32 | |
| meff_SO | |
| meff_e_Gamma | |
| meff_e_L_DOS | |
| meff_e_L_long | |
| meff_e_L_trans | |
| meff_e_X_DOS | |
| meff_e_X_long | |
| meff_e_X_trans | |
| meff_hh_100 | |
| meff_hh_110 | |
| meff_hh_111 | |
| meff_lh_100 | |
| meff_lh_110 | |
| meff_lh_111 | |
| nonparabolicity | |
| set_parameter(parameter) | Same as calling add_parameter with overload=True |
| strained_001(target) | Returns an instance of IIIVZincBlendeStrained001, which is a biaxial-strained III-V zinc blende binary alloy grown on a (001) surface. |
| thermal_expansion |