Port Definitions
Variable | Type | Description |
---|---|---|
ports | Cell |
A cell array containing structs which have information about each port. Every struct must contain the following fields:
|
ele_cat_RELAY |
Number | The index of the cell in the 'ports' cell array, that corresponds to the electrical cathode. |
ele_an_RELAY |
The index of the cell in the 'ports' cell array, that corresponds to the electrical anode. |
|
ele_an_2_RELAY |
[Optional] The index of the cell in the 'ports' cell array, that corresponds to the second anode contact. [[Note]]: For a photodetector with a single anode contact, this parameter should not be provided. |
|
opt_1_RELAY |
The indices of the cells in the 'ports' cell array, that corresponds to the optical port. |
|
opt_2_RELAY |
[Optional] The index of the cell in the 'ports' cell array, that corresponds to the second optical input port. When this second optical port is included, the photocurrent will be generated from the sum of the two optical inputs. [[Note]]: For a photodetector with a single optical input, this parameter should not be provided. |
Photonic Model
Variable | Type | Description |
---|---|---|
photonic_model |
string |
String containing the name of the photonic model used for this template. Please visit here for a list of all available photonic models. |
Cosmetic Variables
Variable | Type | Description |
---|---|---|
description | String | A string containing a brief description of the model, which will be displayed to the end user. |
prefix | String | A string containing the prefix of the model, which will be used within INTERCONNECT to provide incrementing element names for each successive element that is added to the simulation layout. |
notes | Cell |
A cell array which provides model notes that will be displayed to the end user. Each element of the cell is a struct with the fields:
|
Parameter Variables
Variable | Type | Description |
---|---|---|
temperature | String or Number |
Default temperature which can be defined in one of two ways for the model:
|
Modeling Variables
Variable | Type | Description |
---|---|---|
data_filename | String | A string containing the filename of the data file for this element. This must include the extension of the file (.json or .mat). |
enable_shot_noise | Boolean |
Default choice for enabling/disabling the shot_noise model in the photodetector. Note that the compact model gives the end-user option to enable/disable this. |
DC_operation_only | Boolean |
Creates model for DC operation only (model will not work for AC operations). For photodetectors with very small cutoff frequencies (< 1 MHz) setting this flag to true will make the model computationally efficient. |
Built-in Variables
Variable | Type | Description |
---|---|---|
enable_transit_time_limited_BW | Boolean | Flag to enable/disable internal low-pass filter for the carrier transition effect. The default value is set to "true." |