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_h1_RELAY |
Number | The index of the cell in the 'ports' cell array, that corresponds to the electrical signal port. |
ele_g1_RELAY |
The index of the cell in the 'ports' cell array, that corresponds to the electrical ground port. |
|
opt_1_RELAY |
The indices of the cells in the 'ports' cell array, that corresponds to the optical ports. |
|
opt_2_RELAY |
||
ele_h2_RELAY |
[Optional] The index of the cell in the 'ports' cell array, that corresponds to the electrical signal port for the second heat (if applicable). |
|
ele_g2_RELAY |
[Optional] The index of the cell in the 'ports' cell array, that corresponds to the electrical ground port for the second heat (if applicable) |
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 |
---|---|---|
wg_length_name | String |
Name of the parameter setting the length of the phase shifter. |
wg_length_unit |
Default unit of the length parameter. |
|
wg_length_visible_to_user | Boolean |
Flag to enable if the waveguide length property is available to the user. If not, the default value will be used always. |
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). |
Built-in Variables
Variable | Type | Description |
---|---|---|
enable_thermal_time_constant | Boolean | Flag to enable/disable internal low-pass filter for thermal tuner transient bandwidth. The default value is set to "true." |
Tuning Variables
Variable | Type | Description |
---|---|---|
lock_Ppi |
Boolean |
Enable/disable tuning of the Ppi (W) of the phase shifter. This should be a 1X2 matrix with Boolean elements in which the first element is referring to tuning for TE mode and the second for TM mode. Note:
|
lock_loss |
Enable/disable tuning of the insertion loss (dB) of the phase shifter. This should be a 1X2 matrix with Boolean elements in which the first element is referring to tuning for TE mode and the second for TM mode. Note:
|