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. |
|
opt_1_RELAY |
The indices of the cells in the 'ports' cell array, that corresponds to the optical ports. |
|
opt_2_RELAY |
||
ele_term_RELAY |
[Optional] Termination port RELAY for devices with traveling wave electrodes. Note: For devices using a lumped electrode model, 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 |
---|---|---|
L_active_name | String |
Name of the parameter setting the length of the active waveguide region. |
L_active_unit |
Default unit of the length parameter. |
|
L_active_visible_to_user | Boolean |
Flag to enable if the active waveguide length property is available to the user. If not, the default value will be used always. |
L_active_min | Number |
Minimum allowed value of of the active region length (m). |
L_active_max | Number |
Maximum allowed value of of the active region length (m). |
temperature | String or Number |
Temperature 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). |
Tuning Variables
Variable | Type | Description |
---|---|---|
lock_loss |
Boolean |
Enable/disable tuning of the insertion loss (dB) of the phase shifter. Note:
|