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:
|
opt_1_RELAY |
Number | The indices of the cells in the "ports" cell array, that corresponds to the first and second optical ports (on the first bus). |
opt_2_RELAY |
||
ele_th_1_RELAY |
The indices of the cells in the "ports" cell array, that corresponds to the contacts of the "top-arm" thermal tuner. | |
ele_th_2_RELAY |
||
ele_th_3_RELAY |
The indices of the cells in the "ports" cell array, that corresponds to the contacts of the "bottom-arm" thermal tuner. |
|
ele_th_4_RELAY |
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:
|
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_notch_wavelength |
Boolean |
Enable/disable tuning of the resonant wavelength for imbalanced modulators. Note:
|
lock_FSR |
Enable/disable tuning of the free spectral range for imbalanced modulators. Note:
|
|
lock_IL |
Enable/disable tuning of the insertion loss. Note:
|
|
lock_ER |
Enable/disable tuning of the extinction ratio at resonance for imbalanced modulators. |
|
lock_Ppi_thermal |
Enable/disable tuning of the power for pi phase shift (Ppi) of the thermal tuner (if applicable). Note:
|
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) |
splitter | Struct |
Struct containing information about modeling the MMIs with fields:
|
number_of_taps_estimation |
String |
A string containing the method of choosing the number of taps for the FIR filter of the MMI elements. Valid entries are:
|