pdaModelTypeItem
Define a compact model per BB typeStructure
The attributes and elements are shown below, in a sorted per type fashion.In case a list is printed after an element, it indicates that you can have many, otherwise it should be a single element. With a optional it tells the element is not required.
<modeltype name="..." ... > ...
<Script> ... </Script> list
<doc> ... </doc> list
<groupRef> ... </groupRef> list
<markup> ... </markup> list
<parameter> ... </parameter> list
<property> ... </property> list
<pycall> ... </pycall> list
<tex> ... </tex> list
<ticket> ... </ticket> list
</modeltype>
XSD The schema file can be downloaded or viewed at xPDK_CompactModel_List.
Details
Script
Type Script documentation:doc
Type pdaDocumentation documentation:This field allows some (short, single line) documentation to be written. It can be a long string, but the idea is not to replace a design manual.
This field is like
tex
which allows documentation in LaTex format; doc
is restricted to plain text.groupRef
Type groupRef documentation:markup
Type pdaMarkupDocumentation documentation: actual html.name
Short name of the model. Type pdaIdentifierExtended documentation:Those names are mostly XML scope and thus for readability support more general naming then the pdaIdentifier.
parameter
Define the parameters that are expected in a model.The parameters of the model define what a simulator can use to vary within a model. So for a spectral tansfer, you can set the wavelength for example.
If the circuit simulator does not set the value, the model will use the default.
Type pdaModelParameterValue documentation: Define a property.
property
The properties of a model define what per port/mode combination needs to be defined in the model tables (or equations). This is mostly relevant for the data tables in CSV format as it may be unclear what options there are. Type pdaPropertyValue documentation:pycall
Type pycall documentation: This is intended for Luceda's data processing on the model data, so is used in thetex
Type pdaTexDocumentation documentation:doc
, but tex can be a long text in LaTex format to
document the layer in more detail if needed.You can document anything relevant for the topic you want to define.
Multiple paragraphs is fine. Format is Latex, so more complex content is possible.