Container element to merge multiple elements into a single element. Here the container model contains two MMI models; One supports TE mode and the other one supports TM mode.
Note: You are now visiting legacy data format page (2022 R2.4 and older). For current data format page (2023 R1.1 onwards) please visit following link:
Container - Lumfoundry Template (Legacy)
Template: container_example
Photonic Model: container_element
Parameters: Polarization (TE/TM)
Virtuoso/Verilog-A Support: No
Required Data
Parameter Script File
Sub-elements List
Variable | Type | Description |
---|---|---|
sub_elements | Cell | A cell array containing strings specifying the name of the sub-elements included in the container element |
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:
|
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 |
---|---|---|
top_parameters |
Cell |
A cell array containing structs which have information about top level parameters used to choose between sub-elements. Every struct must contain the following fields:
|
selection_code | String |
This should be a Lumerical script code that will create a variable named "selected_name" which must have a value equal to the sub-element name we want to be selected (specified in sub_elements cell array) |
sub_element_parameters |
Cell |
A cell array containing structs which have information about all the parameters that should be present in sub-elements. Every struct must contain the following fields:
|
Modeling Variables
Variable | Type | Description |
---|---|---|
delay_comp_parent |
Boolean |
When this variable is true, a "delay compensation" parameter is added for the parent and the value is passed to the sub-elements. This should only be used when the sub-elements have a "delay compensation" parameter. |
int_delay_comp_parent |
Boolean |
When this variable is true, an "internal delay compensation" parameter is added for the parent and the value is passed to the sub-elements. This should only be used when the sub-elements have an "internal delay compensation" parameter. |
Sub-elements
sub-elements (children) |
The sub-elements (children) that are contained within the container element to be combined into one element. .XML data file and .LSF source files should be set up properly for the container element and container element children.
|