TRL_Cal

Deembed the raw measured data using measured data of TRL (thru-reflect-line) calibration standards. The function calculates the error coefficients and returns the corrected S-parameters data. The reference plane is defined at the middle of the thru standard, or at the interface to the DUT when it is installed in the compatible carrier.

Inputs:
Freq Data:    S data:    Thru:    Short:    Line A:    Line B:    Line C:    Freq 1 Trans:    Freq 2 Trans:	Frequency Inputs Raw (uncalibrated) S-parameters measured S-parameters of the Thru standard measured S-parameters of the Short standard measured S-parameters of Line A standard measured S-parameters of Line B standard measured S-parameters of Line C standard transition frequency Line A to Line B transition frequency Line B to Line C
Output:	Corrected (calibrated) S-parameters data

 

TwoPort

Converts the data in a data set from one 2-port parameter type
(S, Y, H, Z, K, A) to another. Enter the name of the data set that is to be converted, the old 2-port type, and the new 2-port type. Use K for Cascaded Scattering Matrix and A for ABCD Matrix. Note:   TWOPORT does not read TWOPORT_Z0 at execution time, only at measurement and simulation time.

Input Arguments:
Data Sets:	Input
Strings/Pars/Vars:	From [SYHZKA], To [SYHZKA]
Output:	Matrix array; size determined by inputs
Automatic Invocation:	On Data Set Input Change

Example PEL Statement:

h_dataset = TwoPort(s_dataset,"S","H")

TwoPort2

Same as TwoPort function except the characteristic impedance, Z0, is an input parameter. This allows execution-time conversion of 2-port data to a new Z0.

Input Arguments:
Data Sets:	Input
Reals or Integers:	Z0
Strings/Pars/Vars:	From (SYHZKA) To (SYHZKA)
Output:	Matrix array; size determined by inputs
Automatic Invocation:	On Data Set Input Change

Example PEL Statement:

h_dataset = TwoPort2(s_dataset,75,"S","H")

USERC_avg_2

Averages 2 DC data sets, point-by-point. Provided as an example of a math function implemented in User C code. The source code is in $ICCAP_ROOT/src/userc.c.

Input Arguments:
Data Sets:	Data 1, Data 2
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

USERC_avg_3

Averages 3 DC data sets, point-by-point. Provided as an example of a math function implemented in User C code. The source code is in $ICCAP_ROOT/src/userc.c.

Input Arguments:
Data Sets:	Data 1, Data 2, Data 3
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

USERC_close

Closes an open file. See USERC_open for essential additional information about this function.

Input Arguments:
Reals or Integers:	File Descriptor (generated by earlier USERC_open call)
Output:	0 or -1 (-1 indicates an error)
Automatic Invocation:	None

USERC_conjg

Produces the conjugate of the input data set. This function is similar to the function named conjg, but is provided as an example of a User C math function manipulating complex numbers. The source code is in $ICCAP_ROOT/src/userc.c.

Input Arguments:
Data Sets:	Cplx DS
Output:	Complex number or array of complex numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

USERC_data_w_check

Returns a complex number designated by a name, row, and column. Example of C library function data_w_check() in userc.c.

Input Arguments:
Reals or Integers:	Row, Col, Index, Data Set name, Type
Output:	A single complex number.
Automatic Invocation:	None

USERC_get_object_name

If the variable name exists, returns the name of the calling Transform or Macro. Note that the leading / in the name is not returned.

Syntax

USERC_get_object_name(<varname>)

Where

<varname> is a string naming a variable in the variable table within the scope of the caller. This variable returns the names of the calling Transform or Macro.

Examples:

If macro /npn/tester contains the following line:

x=USERC_get_object_name("objname")

And if objname is in the Model Variables or system variables, then it returns npn/tester.

If Transform /npn/dc/fgummel/tester contains the following line:

x=USERC_get_object_name("xformName")

And if xformName exists in the Setup Variables, DUT Variables, Model Variables, or System Variables, then it returns npn/dc/fgummel/tester.

USERC_init_param

Demonstrates in C code how to assign a value to a model parameter, a DUT parameter, or an IC-CAP system variable. Demonstrates use of the User C utility function named set_par_or_var(). The source code is in the set_param function in $ICCAP_ROOT/src/userc.c.

Input Arguments:
Reals or Integers:	New Value
Strings/Pars/Vars:	Parameter to set (this should be the name of a model parameter, a DUT parameter, or an IC-CAP system variable)
Output:	None
Extracts:	N/A
Automatic Invocation:	By Extract menu function

USERC_num_of_points

Returns the number of points for a given sweep. Example of C library function get_num_of_points() in userc.c.

Input Arguments:
Reals or Integers:	Sweep order, Sweep path
Output:	A positive real number, or -1 for error.
Automatic Invocation:	None

Example PEL Statement:

nop = USERC_num_of_points(1, "") 
! A blank path is current Setup

USERC_open

Accesses a disk file for reading, writing or both. For instrument control, use HPIB_open() and related HPIB functions. This function can be used in conjunction with USERC_readnum, USERC_readstr, USERC_read_reals, USERC_seek, USERC_tell, USERC_write, and USERC_close to perform I/O operations. A more complete description of these functions and examples of their use in performing I/O operations with disk files are available in Appendix H, "User C Functions." The source code for these functions is provided in $ICCAP_ROOT/src/userc_io.c.

Input Arguments:
Strings/Pars/Vars:	Filename, Access Mode
Output:	-1 on failure, or else a positive integer file designator that you should save to use with the other User C I/O functions mentioned in the description.
Automatic Invocation:	None

Example PEL Statement:

file_num = USERC_open("datafile","r") ! read access

USERC_read_reals

Opens a file, reads and returns an array of real numbers, and closes the file. For additional information about this function, see Appendix H, "User C Functions."

Input Arguments:
Strings/Pars/Vars:	Filename
Output:	Array of real numbers, with size determined by the Setup
Automatic Invocation:	None

Example PEL Statement:

data_array = USERC_read_reals("datafile")

USERC_readnum

Reads 1 real number from an open file, 1.0E6, for example. See USERC_open for essential additional information about this function.

Input Arguments:
Reals or Integers:	File Descriptor (generated by earlier USERC_open call), Device File Flag
Strings/Pars/Vars:	Scanf Format
Output:	a real number (the value 9.99998E+37 means an error occurred)
Automatic Invocation:	None

Example PEL Statement:

VTO = USERC_readnum(file_num,0,"VTO = %lf")

USERC_readstr

Reads a string from an open file and sets the specified IC-CAP variable equal to it. See USERC_open for essential additional information about this function.

Input Arguments:
Reals or Integers:	File Descriptor (generated by earlier USERC_open call), Device File Flag (use 1 if reading from an instrument driver device file, 0 if reading from an ASCII file)
Strings/Pars/Vars:	Scanf Format, Var Name
Output:	0 on success, or -1 on failure
Automatic Invocation:	None

Example PEL Statement:

! read and set SIMULATOR name from a file 
read_result = USERC_readstr(file_num,0,"%s", 
                            IC-CAP_variable)

USERC_seek

Goes to a particular byte offset in an open file. See USERC_open for essential additional information about this function.

Input Arguments:
Reals or Integers:	File Descriptor (generated by earlier USERC_open call), Offset Value, Offset Type
Output:	0 on success, or -1 on failure
Automatic Invocation:	None

USERC_set_param

Sets the parameter specified by the second argument to the value of the first argument.

Input Arguments:
Data Sets:	None
Reals or Integers:	Value of the parameter
Strings/Pars/Vars:	Name of the parameter to set
Output:	None
Automatic Invocation:	MANUAL

Example PEL Statement:

x = USERC_set_param(100,NPN,BF)

USERC_set_param_quiet

set the value of a parameter or variable referenced by a string. Unlike USERC_set_param(), this version makes no output to the status window.

Example PEL Statement:

 x=USERC_set_param_quiet(1e-15,"/npn/IS")

USERC_size

Returns the array size of the data set whose name is given by a string.

Input Arguments:
Strings/Pars/Vars:	Data Set name
Output:	A positive real number.
Automatic Invocation:	None

Example PEL Statement:

data_size = USERC_size("id")

USERC_sweep_mode

Returns the sweep mode for the input with sweep order N.

Usage:	x=USERC_sweep_mode(N, <path>)
Returns:	0 for V 1 for I 2 for T 3 for F 4 for P 5 for U 6 for W
Extracts:	Example C library function of get_sweep_mode() in userc.c. Use USERC_num_of_points() to check the existence of a sweep.

USERC_sweep_name

Returns a sweep name through a variable. Example C library function of get_sweep_name() in userc.c. Use USERC_num_of_points() to check the existence of a sweep.

Input Arguments:
Strings/Pars/Vars:	Sweep order, Sweep path, Variable name
Output:	0 for success, -1 for error
Automatic Invocation:	None

Example PEL Statement:

x = USERC_sweep_name(1, "/npn/dc/fearly", "first_sweep")

USERC_sweep_start

Returns a sweep start value. Example C library function of get_sweep_start() in userc.c. Use USERC_num_of_points() to check the existence of a sweep.

Input Arguments:
Strings/Pars/Vars:	Sweep order, Sweep path
Output:	0 for error
Automatic Invocation:	None

Example PEL Statement:

x = USERC_sweep_start(1, "/npn/dc/fearly")

USERC_sweep_stepsize

Returns a (LIN) sweep step value. Example C library function of get_sweep_stepsize() in userc.c. Use USERC_num_of_points() to check the existence of a sweep.

Input Arguments:
Strings/Pars/Vars:	Sweep order, Sweep path
Output:	0 for error
Automatic Invocation:	None

Example PEL Statement:

x = USERC_sweep_stepsize(1, "/npn/dc/fearly")

USERC_sweep_stop

Returns a sweep stop value. Example C library function of get_sweep_stop() in userc.c. Use USERC_num_of_points() to check the existence of a sweep.

Input Arguments:
Strings/Pars/Vars:	Sweep order, Sweep path
Output:	0 for error.
Automatic Invocation:	None

Example PEL Statement:

x = USERC_sweep_stop(1, "") ! within current Setup

USERC_system

Demonstrates the invocation of an operating system command from User C code.

Input Arguments:
Strings/Pars/Vars:	operating system command
Output:	Single number with exit status of the operating system command
Automatic Invocation:	None

USERC_tell

Tells current byte offset in an open file. See USERC_open for essential additional information about this function.

Input Arguments:
Reals or Integers:	File Descriptor (generated by earlier USERC_open call)
Output:	-1 on error, or else current byte offset into file
Automatic Invocation:	None

USERC_transpose

Returns a data set of matrices, in which each of the input data set's matrices has been transposed. Provided as an example of a matrix math function implemented in User C code. The source code is in $ICCAP_ROOT/src/userc.c.

Input Arguments:
Data Sets:	Matrix DS
Output:	Matrix or matrix array; size determined by inputs
Automatic Invocation:	On Data Set Input Change

USERC_write

Prints any string expression into an open file, in ASCII. (To convert a number to a string expression, refer to the VAL$ function described in the Built-in Functions. Refer to USERC_open for additional essential information about this function.)

Input Arguments:
Reals or Integers:	File Descriptor (generated by USERC_open call), Device File Flag
Strings/Pars/Vars:	String to Write
Output:	0 or -1 (-1 indicates an error)
Automatic Invocation:	None

Example PEL Statement:

write_result = USERC_write(file_num,0,"VTO="&VAL$(VTO))

variance

Calculates the statistical variance of a data set. Adequate for a real or complex data set, but if a data set of matrices is received, only the 1,1 data is considered. A data set specification like S.21 is adequate, since this is a data set of complex numbers.

Input Arguments:
Data Sets:	Input 1
Output:	Single real or complex number
Automatic Invocation:	On Data Set Input Change

VBIC_ac_solver

Given the 4 terminal voltages, solves for 2-port network parameters. VE and VS are assumed to be 0.

Input Arguments:
VC	(Collector Voltage)
VB	(Base Voltage)
FREQ	(Cut-off Frequency])
Output {FT|BETA|Y|H|Z|S}	Output code specifying current gain, or parameters. This code should be placed in the Output field.
Outputs:	The output depends on the code set in the Output field:
Code	Output
FT	Current gain cutoff frequency
BETA	Current gain
Y	The 2-port network y-parameters
H	The 2-port network h-parameters
Z	The 2-port network z-parameters
S	The 2-port network s-parameters

VBIC_avc

Calculates avalanche collector voltage (AVC1) based on the model parameter PC.

Where

For an NPN, a = 7.05E05 cm^-1 and b = 1.23E06 V/cm

For a PNP, a = 1.58E06 cm^-1 and b = 2.04E06 V/cm

PC = b-c grading coefficient

Input Arguments:	None
Output:	Model parameter AVC1

VBIC_cbc

Calculates the depletion capacitance versus bias.

Input Arguments:
VBC	Base-Collector Voltage
Output:	Depletion base-collector capacitance based on the VBIC formulation: SPICE model for AJC 0 and single-piece smooth model for AJC > 0.

VBIC_cbe

Calculates the depletion capacitance versus bias.

Input Arguments:
VBE	Base-Emitter Voltage
Output:	Depletion base-emitter capacitance based on the VBIC formulation: SPICE model for AJC 0 and single-piece smooth model for AJC > 0.

VBIC_cj0

Calculates (extracts) the junction zero-bias capacitance.

Input Arguments:
VJ	Junction voltage
CJ	Capacitance
Output:	E/C/S   Junction {E|C|S} for CJE, CJC, or CJCP
Output:	The zero-bias junction capacitance stored in CJE, CJC, or CJCP.

VBIC_clean_data

This routine looks at each data point and scans ahead by the number of points specified by the input argument IN A ROW. If the data does not monotonically increase for the number of data points specified by IN A ROW, then zero is written to the output array. If the data does monotonically increase for the number of data points specified by IN A ROW, then from that data point onward, the INPUT DATA is written directly to the output (result) array.

Input Arguments:
INPUT DATA
IN A ROW
Output:	Either the INPUT DATA or zero values.

VBIC_csc

Calculates the depletion capacitance versus bias.

Input Arguments:
VSC	(Substrate-Collector Voltage)
Output:	Depletion collector-substrate capacitance based on the VBIC formulation: SPICE model for AJC 0 and single-piece smooth model for AJC>0.

VBIC_dc_approx

This function calculates Ic, Ib, beta, intrinsic and extrinsic base-emitter voltage, and base charge for a bipolar transistor, using the terminal voltages Ve, Vb, and Vc as inputs. Vs is assumed to be 0. The first parameter should be set to the output of interest, which defaults to Ic. This approximate solution does not take quasi-saturation effects into account.

Input Arguments:
VC	Collector Voltage
VB	Base Voltage
VE	Emitter Voltage
Output:IC|IB|BETA|VBEI|VBEX|QB
	Set this field to the output of interest
Output:	The output depends on the setting of the Output field.
Code	Output
IC	Collector current
IB	Base current
BETA	Current gain
VBEI	Intrinsic base-emitter voltage
VBEX	Extrinsic base-emitter voltage
QB	Base charge

VBIC_dci_solver

This function calculates Ic, Vb, Ie, Is, or beta for a bipolar transistor, using the terminal voltages Ve, Vc, and Vs and Ib as inputs. The first parameter should be set to the output of interest, which defaults to Ic.

Input Arguments:
VC	Collector Voltage
IB	Base Current
VE	Emitter Voltage
VS	Substrate Voltage
Output: IC|VB|IE|IS|BETA
	Set this field to the output of interest.
Output:	The output depends on the code set in the Output field.
Code	Output
IC	Collector current
VB	Base voltage
IE	Emitter current
IS	Substrate current
BETA	Current gain

VBIC_dcv_solver

This function calculates Ic, Ib, Ie, Is, or beta for a bipolar transistor, using the terminal voltages Ve, Vb, Vc, and Vs as inputs. The first parameter should be set to the output of interest, which defaults to Ic.

Input Arguments:
VC	Collector Voltage
VB	Base Voltage
VE	Emitter Voltage
VS	Substrate Voltage
Output: IC|IB|IE|IS|BETA
	Set this field to the output of interest.
Output:	The output depends on the code set in the Output field:
Code	Output
IC	Collector current
VB	Base voltage
IE	Emitter current
IS	Substrate current
BETA	Current gain

VBIC_fg_currents

Given the 4 terminal voltages, calculates parameters related to forward current.

Input Arguments:
Data Sets:	VC  Collector Voltage VB  Base Voltage VE  Emitter Voltage VS  Substrate Voltage IC  Collector Current IB  Base Current
Parameters:	The parameter indicates the region where the transform will limit its simulated output. VBIC_AUTO_RANGE must be set to 1.
IS|NF	Calculate over the region dominated by NF
IBEI|NEI	Calculate over the region dominated by NEI
IBEN|NEN	Calculate over the region dominated by NEN
IKF	Calculate over the region dominated by IKF
Output: {IB|B|IC|C|IE|E|IS|S}
	Code to indicate which current to output.
Output:	A subset of the current where zeros replace any range where data was not extracted (based on the auto-ranging algorithm). The output depends on the code set in the Output field:
Code	Output
IB|B	Base current
IC|C	Collector current
IE|E	Emitter current
IS|S	Substrate current
Extracts:	Nothing

VBIC_ibci_nci

Calculates the parameters IBCI and NCI.

Input Arguments:
VB	Base Voltage
VC	Collector Voltage
IB	Base Current
Output:	NCI at each bias point (unaveraged).
Extracts:	IBCI, NCI

VBIC_ibei_nei

Calculates the parameters IBEI and NEI.

Input Arguments:
VB	Base Voltage
VE	Emitter Voltage
IB	Base Current
Output:	NEI at each bias point (unaveraged).
Extracts:	IBEI, NEI

VBIC_ikf

Calculates the parameter IKF.

Input Arguments:
VB	Base Voltage
VE	Emitter Voltage
IC	Collector Current
IB	Base Current
Output:	IKF at each bias point
Extracts:	IKF (maximum value in range, 0.1 indicates failed extraction).

VBIC_ikr

Calculates the parameter IKR.

Input Arguments:
VB	Base Voltage
VC	Collector Voltage
IE	Emitter Current
IB	Base Current
Output:	Reverse beta versus bias.
Extracts:	IKR (maximum value in range, 0.1 indicates failed extraction).

VBIC_is_nf

Calculates the parameters IS and NF.

Input Arguments:
VB	Base Voltage
VE	Emitter Voltage
IC	Collector Current
Output:	NF versus bias with 0's where out of auto-range.
Extracts:	IS, NF (average values in range).

VBIC_isp_nfp

Calculates the parameters ISP and NFP.

Input Arguments:
VB	Base Voltage
VC	Collector Voltage
IS	Substrate Current
Output:	NFP versus bias with 0's where out of auto-range.
Extracts:	ISP, NFP (average values in range).

VBIC_nr

Calculates the parameter NR.

Input Arguments:
VB	Base Voltage
VC	Collector Voltage
IE	Emitter Current
Output:	NR versus bias with 0's where out of auto-range.
Extracts:	NR (average value in range).

VBIC_qcdepl

Calculates depletion charge or capacitance based on VBIC formulation using SPICE model for A 0 and single-piece, smooth model for A > 0.

Input Arguments:
Junction V	Junction voltage
P Param	Built-in potential
M Param	Grading coefficient
F Param	Fwd bias depletion capacitance limit
A Param	Smoothing factor
Mode : {Q|C}	Charge or capacitance
Output:	Charge or capacitance versus bias.
Extracts:	Nothing

VBIC_rcx

Calculates RCX.

Input Arguments:
VB	Base Voltage
VE	Emitter Voltage
IC	Collector Current
IS	Substrate Current
IB	Base Current
Output:	RCX versus bias with 0's where out of auto-range.
Extracts:	RCX (maximum value in auto-range, if failed, value of 60 set).

VBIC_rg_currents

Given the 4 terminal voltages, calculates reverse currents.

Input Arguments:
VC	Collector Voltage
VB	Base Voltage
VE	Emitter Voltage
VS	Substrate Voltage
IE	Emitter Current
IB	Base Current
IS	Substrate Current
Parameters	The parameter indicates the region where the transform will limit its simulated output. VBIC_AUTO_RANGE must be set to 1.
IS|NR	Calculate over the region dominated by NR
IBCI|NCI	Calculate over the region dominated by NCI
IBCN|NCN	Calculate over the region dominated by NCN
IKR	Calculate over the region dominated by IKR
ISP|NFP	Calculate over the region dominated by NFP
IKP	Calculate over the region dominated by IKP
Output: {IB|B|IC|C|IE|E|IS|S}
	Code to indicate which current to output.
Output:	A subset of the current where zeros replace any range where data was not extracted (based on the auto-ranging algorithm).
The output depends on the code set in the Output field:
Code	Output
IB|B	Base current
IC|C	Collector current
IE|E	Emitter current
IS|S	Substrate current
Extracts:	Nothing.

VBIC_stoc

This function calculates capacitance data from S-parameter data, allowing base-collector and base-emitter capacitance to be calculated from network analyzer measurements. The output of this function can be used in place of actual capacitance data to extract capacitance-related parameters.

Input Arguments:
FREQ data	Frequency
S data	S-parameter data (de-embedded)
Node (C/E/S)	Code to indicate type of extraction: E  base-emitter capacitance C  base-collector capacitance S  substrate-collector capacitance
Output:	Capacitance versus frequency data
Extracts:	Nothing

VBIC_vef_ver

Calculates the forward and reverse early voltages given the collector, base, and emitter voltages in the forward and reverse modes, as well as the collector current in the forward mode and the emitter current in the reverse mode. The algorithm is based on the method described in "SPICE Early Modeling" by C. McAndrew & L. Nagel, BCTM 94, p. 144.

Input Arguments:
Forward VC	Collector Voltage
Forward VB	Base Voltage
Forward VE	Emitter Voltage
Forward IC	Collector Current
Reverse VE	Emitter Voltage
Reverse VB	Base Voltage
Reverse VC	Collector Voltage
Reverse IE	Emitter Current
Forward IB	Base Current
Output:	VEF versus bias with 0's where out of auto-range.
Extracts:	VEF, VER (average values in auto-range).

Wait

Switching matrix function. Used to pause for a specified number of seconds to accomplish dry switching. Refer to Chapter 2, "MOSFET Characterization," in the IC-CAP Nonlinear Device Models, Volume 1 manual for more information.

Input Arguments:
Reals or Integers:	Period [sec]
Output:	Single number with exit status
Automatic Invocation:	None

wirexfX

A wire function. Wire functions permit optimization of time-domain measurements in the X and Y dimensions. Time-domain measurements involve effects specifically related to the Y axis (voltage or current level) or the X axis (when a pulse occurs).

Because X-axis data is typically the forced data set, it cannot normally be optimized. This makes it very difficult to optimize measured and simulated pulses that do not start with some amount of overlap in time. To solve this problem, the data can be transformed to create an independent X data set that can be optimized together with the Y data set. There are 2 ways of doing this.

Input Arguments:
Data Sets:	X Data, Y Data
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

wirexfXY

One of the wire functions that permit optimization of time domain measurements in the X and Y dimensions; for more details, refer to the wirexfX function. This function calculates the X data set produced when the X and Y axes are normalized and the curve is divided into segments of equal length. This function should be used in conjunction with wirexfYX during an optimization.

Input Arguments:
Data Sets:	X Data, Y Data
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

wirexfY

One of the wire functions that permit optimization of time domain measurements in the X and Y dimensions; for more details, refer to the wirexfX function. This function calculates the Y data set when X values are evenly spaced. This function is supplied for completeness because Y data sets are normally collected in this manner.

Input Arguments:
Data Sets:	X Data, Y Data
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change

wirexfYX

One of the wire functions that permit optimization of time domain measurements in the X and Y dimensions; for more details, refer to the wirexfX function. This function calculates the Y data set produced when the X and Y axes are normalized and the curve is divided into segments of equal length. This function should be used in conjunction with wirexfXY during an optimization.

Input Arguments:
Data Sets:	X Data, Y Data
Output:	Array of real numbers; size determined by inputs
Automatic Invocation:	On Data Set Input Change