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. Note: For a ring without electrical modulation, this parameter should not be provided. |
ele_an_RELAY |
The index of the cell in the 'ports' cell array, that corresponds to the electrical anode. Note: For a ring without electrical modulation, this parameter should not be provided. |
|
ele_th_1_RELAY |
The index of the cell in the 'ports' cell array, that corresponds to contact 1 of the thermal tuner. Note: For a ring without thermal tuner, this parameter should not be provided. |
|
ele_th_2_RELAY |
The index of the cell in the 'ports' cell array, that corresponds to contact 2 of the thermal tuner. Note: For a ring without thermal tuner, this parameter should not be provided. |
|
opt_1_RELAY |
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 |
||
opt_3_RELAY |
The indices of the cells in the 'ports' cell array, that corresponds to the third and fourth optical ports (on the second bus). Note: For a single bus ring, these two parameter values should not be provided. |
|
opt_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:
|
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). |
thermal_tuner_data_format | Number |
Defines the format of the thermal tuner data. The options are: 1 = phase shift as a function of heater power. 2 = resonance wavelength shift as a function of heater power. Note: For a ring without thermal tuner, this parameter should not be provided. |
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
If the source physical data provided for the model is not consistent with figures of merit (FOMs) provided (meaning the actual FOM values resulting from physical parameters differ from provided FOM data), the model can tune the provided physical data to match the FOMs to the provided values.
Variable | Type | Description |
---|---|---|
lock_resonant_wavelength |
Boolean |
Enable/disable tuning of the resonant wavelength. Note:
|
lock_FSR |
Enable/disable tuning of the free spectral range. Note:
|
|
lock_resonance_peak_shape |
Enable/disable tuning of resonance peak shape. Here insertion loss at through and drop port (if present), extinction ratio and quality factor will be tuned. Note:
|
|
lock_mod_eff |
Enable/disable tuning of the modulation efficiency of the ring modulator. Note:
|
|
lock_mod_eff_thermal |
Enable/disable tuning of the modulation efficiency of the thermal tuner. Note: For a ring without thermal tuner, this parameter should not be provided. |