optics{ light_propagation{ } }#
Calling sequence
optics{ light_propagation{ } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: maximum 1
Functionality
Specifies options related to the light field propagating through the device and defines energy grid for optical field and optical spectra used.
Note
Energy resolution is properly inherited based on the absorption spectra used.
Dependencies
optics{ global_illumination{ } } is specified in the input file.
Exactly one of the following must be defined: wavelength_min, energy_min within this group.
Exactly one of the following must be defined: wavelength_max, energy_max within this group.
Maximum one of use_local_spectra{ } and use_computed_spectra{ } can be defined within this group.
Nested keywords
wavelength_min#
Changed in version 3.0.0.
Calling sequence
optics{ light_propagation{ wavelength_min = ... } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: real number
values: \(10.0 \leq r \leq 10^{6}\)
unit: \(\mathrm{nm}\)
Functionality
Low-energy boundary of the energy grid for propagating photons expressed by a wavelength.
Note
This limit is also used for spectra computed for the entire device (absorption and emission) which can be used for photogeneration by calling use_global_spectra{ } or use_local_spectra{ }.
wavelength_max#
Changed in version 3.0.0.
Calling sequence
optics{ light_propagation{ wavelength_max = ... } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: real number
values: \(10.0 \leq r \leq 10^{6}\)
unit: \(\mathrm{nm}\)
Functionality
High-energy boundary of the energy grid for propagating photons expressed by a wavelength.
Note
This limit is also used for spectra computed for the entire device (absorption and emission) which can be used for photogeneration by calling use_global_spectra{ } or use_local_spectra{ }.
energy_min#
Changed in version 3.0.0.
Calling sequence
optics{ light_propagation{ energy_min = ... } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: real number
values: \(10^{-6} \leq r \leq 10^{2}\)
unit: \(\mathrm{eV}\)
Functionality
Low-energy boundary of the energy grid for propagating photons.
Note
This limit is also used for spectra computed for the entire device (absorption and emission) which can be used for photogeneration by calling use_global_spectra{ } or use_local_spectra{ }.
energy_max#
Changed in version 3.0.0.
Calling sequence
optics{ light_propagation{ energy_max = ... } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: real number
values: \(10^{-6} \leq r \leq 10^{2}\)
unit: \(\mathrm{eV}\)
Functionality
High-energy boundary of the energy grid for propagating photons.
Note
This limit is also used for spectra computed for the entire device (absorption and emission) which can be used for photogeneration by calling use_global_spectra{ } or use_local_spectra{ }.
use_global_spectra{ }#
Calling sequence
optics{ light_propagation{ use_global_spectra{ } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: maximum 1
Functionality
Light propagation model uses single imported global absorption spectrum for all regions. It cannot be computed during the runtime. The absorption spectrum is also assigned to every region with any boundary conditions (contact regions).
use_global_spectra{ energy_resolution }#
Calling sequence
optics{ light_propagation{ use_global_spectra{ energy_resolution = ... } } }
Properties
usage: \(\mathrm{\textcolor{Dandelion}{conditional}}\)
type: real number
values:
[1e-6, ...)unit: \(\mathrm{eV}\)
default: \(r=1e-2\)
Functionality
Spacing between subsequent energy grid points for the light field and optical spectra used.
use_local_spectra{ }#
Calling sequence
optics{ light_propagation{ use_local_spectra{ } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: maximum 1
Functionality
Light propagation model uses single imported global absorption spectrum within local absorption framework. Regions with boundary conditions imposed on the Poisson equation (electric potential) are treated as perfectly transparent, zero absorption coefficient is assigned.
Note
In the future, this feature is planned to use imported position-dependent optical absorption spectra.
Hint
See contacts{ } for further reference on boundary conditions.
use_local_spectra{ energy_resolution }#
Calling sequence
optics{ light_propagation{ use_local_spectra{ energy_resolution = ... } } }
Properties
usage: \(\mathrm{\textcolor{Dandelion}{conditional}}\)
type: real number
values:
[1e-6, ...)unit: \(\mathrm{eV}\)
default: \(r=1e-2\)
Functionality
Spacing between subsequent energy grid points for the light field and optical spectra used.
use_computed_spectra{ }#
Calling sequence
optics{ light_propagation{ use_computed_spectra{ } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: maximum 1
Functionality
Light propagation model uses absorption spectrum within local absorption framework which is computed within the runtime. Regions with boundary conditions imposed on the Poisson equation (electric potential) are treated as perfectly transparent, zero absorption coefficient is assigned.
Hint
See contacts{ } for further reference on boundary conditions.
Note
Bias ramping set by reuse_previous is ignored when this group is called.
Dependencies
energy_grid{ } must be defined.
optics{ semiclassical_spectra{ } } must be defined.
local_absorption must be defined.
optics{ global_absorption_coeff{ } } is not specified in the input file.
optics{ global_refractive_index{ } } is not specified in the input file.
output_global_spectra{ }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: maximum 1
Functionality
This group is used to output optical spectra which entered the calculation of the light propagation through the device.
output_global_spectra{ reflectivity }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ reflectivity = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the reflectivity spectrum is outputted.
output_global_spectra{ absorption_coeff }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ absorption_coeff = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the absorption spectrum is outputted.
output_global_spectra{ decadic_absorption_coeff }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ decadic_absorption_coeff = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the absorption spectrum in decadic units is outputted.
output_global_spectra{ refractive_index }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ refractive_index = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the refractive index spectrum is outputted.
output_global_spectra{ spectra_over_energy }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ spectra_over_energy = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes then the selected spectra are outputted over photon energy.
output_global_spectra{ spectra_over_frequency }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ spectra_over_frequency = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon frequency.
output_global_spectra{ spectra_over_wavenumber }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ spectra_over_wavenumber = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavenumber.
output_global_spectra{ spectra_over_wavelength }#
Calling sequence
optics{ light_propagation{ output_global_spectra{ spectra_over_wavelength = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavelength.
output_local_spectra{ }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
items: exactly 1
Functionality
This group is used to output optical spectra which entered the calculation of the light propagation through the device within the framework of locally defined spectra.
output_local_spectra{ absorption_coeff }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ absorption_coeff = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the absorption spectrum is outputted.
output_local_spectra{ decadic_absorption_coeff }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ decadic_absorption_coeff = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then the absorption spectrum in decadic units is outputted.
output_local_spectra{ spectra_over_energy }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ spectra_over_energy = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes then the selected spectra are outputted over photon energy.
output_local_spectra{ spectra_over_frequency }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ spectra_over_frequency = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon frequency.
output_local_spectra{ spectra_over_wavenumber }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ spectra_over_wavenumber = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavenumber.
output_local_spectra{ spectra_over_wavelength }#
Calling sequence
optics{ light_propagation{ output_local_spectra{ spectra_over_wavelength = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavelength.
output_light{ }#
Calling sequence
optics{ light_propagation{ output_light{ } } }
Properties
usage: \(\mathrm{\textcolor{WildStrawberry}{required}}\)
items: exactly 1
Functionality
—
output_light{ illumination }#
Calling sequence
optics{ light_propagation{ output_light{ illumination = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes, then the illumination spectrum is outputted.
output_light{ total_absorption }#
Calling sequence
optics{ light_propagation{ output_light{ total_absorption = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes, then the total_absorption is outputted, i.e. the fraction of absorbed photons in the device relative to the number of incident photons for each wavelength.
output_light{ total_transmission }#
Calling sequence
optics{ light_propagation{ output_light{ total_transmission = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes, then the total_transmission is outputted, i.e. the fraction of absorbed photons in the device relative to the number of incident photons for each wavelength, i.e. the fraction of transmitted photons through the device relative to the number of incident photons for each wavelength.
output_light{ lightflux }#
Calling sequence
optics{ light_propagation{ output_light{ lightflux = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes, then the light flux \(I(x,E)\) of the light propagating through the device
output_light{ spectra_over_energy }#
Calling sequence
optics{ light_propagation{ output_light{ spectra_over_energy = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes then the selected spectra are outputted over photon energy.
output_light{ spectra_over_frequency }#
Calling sequence
optics{ light_propagation{ output_light{ spectra_over_frequency = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon frequency.
output_light{ spectra_over_wavenumber }#
Calling sequence
optics{ light_propagation{ output_light{ spectra_over_wavenumber = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavenumber.
output_light{ spectra_over_wavelength }#
Calling sequence
optics{ light_propagation{ output_light{ spectra_over_wavelength = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes then the selected spectra are outputted over photon wavelength.
output_light{ photon_spectra }#
Calling sequence
optics{ light_propagation{ output_light{ photon_spectra = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
yes
Functionality
If set to yes, then spectrum of photon number is outputted in one of the following units cm-2 s-1 eV-1, cm-2 s-1 nm-1, cm-2 s-1 THz-1, or cm-2 s-1 / cm-1.
output_light{ power_spectra }#
Changed in version 3.0.0.
Calling sequence
optics{ light_propagation{ output_light{ power_spectra = "..." } } }
Properties
usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)
type: choice
values:
yesornodefault:
no
Functionality
If set to yes, then photon power spectrum is outputted in units W m-2 eV-1.