Arguments (Graph tab only)

Parent Previous Next

The Sonnet analysis engine, em, generates, s, y, or z parameters when a simulation is performed. These s, y, or z parameters are the typical arguments that you will use in your custom equations. The Args tab on the right hand side of the User Equation Editor window provides examples of how you may specify arguments within your equations. Note that arguments may be specified explicitly, for example, "y11" (y-parameter for port 1-1 combination and nothing else). Arguments may also be specified implicitly. If an implicit specification is used here, then you will have the ability to vary the argument later in the Sonnet graph. For example, if you simply specify an argument as "y" here, then the argument will be fixed as a y-parameter, but you will have the ability to set the port-combination for the y parameter later in the Sonnet graph.

In addition to using s, y, or z-parameter arguments, you may also specify a custom argument using the ARG keyword. The syntax is:


ARG <Name> = <Value>


Here, the ARG keyword must be capitalized, <Name> is the name of a custom argument, and <Value> is an s, y, or z-parameter. An example custom argument is as follows:


ARG Impedance = Z11


Arguments may only be used as equations in the response viewer; they cannot be used as equations in the project editor. Arguments are defined by the user. The names must consist of only alpha-numeric characters. You may use upper or lowercase characters. For more information on defining an argument,  see the Add/Edit Argument Definition dialog box. All arguments may be in complex values.

The FREQ constant and all user defined arguments can be indexed by appending "[f]" to the argument. The indexing starts at f = 0 and ends at f = (Nf  - 1) where Nf is the total number of frequencies. FREQ[f] represents the frequency in hertz at the present frequency index "f". Arg[f], where "Arg" is a user defined argument, represents the value of "Arg" at the frequency index "f". Arg [ f + 1] represents the next value of the Arg at frequency index "f + 1".

For example, suppose you have analyzed a circuit at 5, 10, 15, 20 and 25 GHz. Nf would be equal to five, so the index f would start at 0 and end at 4. The values for FREQ[f], FREQ[f-1], and FREQ [f+1] are shown in the table below.

Frequency

FREQ [ f ]

FREQ [ f - 1]

FREQ [f + 1]

5 GHz f = 0

5 GHz

No data point

10 GHz


10 GHz f = 1

10 GHz

5 GHz

15 GHz


15 GHz f = 2

15 GHz

10 GHz

20 GHz


20 GHz f = 3

20 GHz

15 GHz

25 GHz


25 GHz f = 4

25 GHz

20 GHz

No data point

In the same manner, if you index an argument, then the value of the argument for any given data point is the value at the frequency identified by the index.

Indexing may only be used in the response viewer. Indexing is not available when entering equations in the project editor.