Evaluate for Free

waveguide_simple parameter script file

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:

  • name: The name of the port, which will be visible to the end user. This name should be consistent with the name that will be used for netlisting.
  • dir: The directionality of the port, either "Input", "Output", or "Bidirectional"
  • type: The signal type of the port, which should be "Optical Signal" for waveguides
  • pos: The side of the model which the port will be displayed on, either "Left", "Right", "Top", or "Bottom"
  • loc: The placement of the port on the side defined by loc, provided as a coordinate between 0 and 1.
opt_1_RELAY ID The indices of the cells containing information about the first and second waveguide port in the 'ports' cell array.
opt_2_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:

  • property: The name of the note.
  • value: The contents of the note.

Parameter Variables

Variable Type Description
wg_length_name String Strings containing the name and unit of the wg_length parameter which will be displayed to the end user, if made visible.
wg_length_unit 
wg_length_visible_to_user  Boolean A boolean which will determine whether or not the waveguide length parameter will be made visible to the end user.
temperature String or Number

Temperature can be defined in one of two ways for the waveguide_simple model:

  1. A string containing "%temperature%", which will cause the INTERCONNECT model to inherit the temperature value from the Root Element.
  2. A number containing the temperature of the element, in degrees Kelvin.

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)
number_of_taps_estimation

A string containing the method of choosing the number of taps for the FIR filter of the element. Valid entries are:

  • "group delay" - Choose the number of FIR taps to match the expected group delay of the element, and allow the end user to use the delay compensation feature of INTERCONNECT
  • "disabled" - Disable the use of an FIR filter to model the waveguide's impulse response.

Associated files

Related articles