Template List

This appendix contains a list of default templates currently available in the standard list of templates. In each of the tables, the parenthesis containing the specific simulators ( <simulator> ) indicates that the parameter is available in that particular simulator.

The following sections contain the currently defined default templates:

Analysis Templates

This section contains the default analysis templates.

The "parameter" for all of the analysis templates defines the simulation or device parameter to be swept. If that parameter is part of a device, device should be set to the name of the instance defining the device. For more information on adding a sweep plan and output plans, refer to Adding a Sweepplan and Adding an OutputPlan.

AC Analysis Template

TemplateName: AC
Description: Small signal AC analysis
Parameters:  
device (ads) (hspice) (spectre)
frequency (ads) (hspice) (spectre)
parameter (ads) (hspice) (spectre)

DC Analysis Template

TemplateName: DC
Description: DC analysis
Parameters:  
device (ads) (hspice) (spectre)
parameter (ads) (hspice) (spectre)

Noise Analysis Template

TemplateName: NOISE
Description: Noise analysis
Parameters:  
device (ads) (hspice) (spectre)
frequency (ads) (hspice) (spectre)
noiseNode (ads) (hspice) (spectre)
noiseReference   (hspice)  
parameter (ads) (hspice) (spectre)

S-parameter Analysis Template

TemplateName: SP
Description: S-parameter analysis
Parameter:  
device (ads) (hspice) (spectre)
frequency (ads) (hspice) (spectre)
parameter (ads) (hspice) (spectre)

Transient Analysis Template

TemplateName: TRAN
Description: Transient analysis
Parameter:  
start (ads) (hspice) (spectre)
stop (ads) (hspice) (spectre)
step (ads) (hspice) (spectre)
timeStepMethod (ads) (hspice)  
maxIterations (ads) (hspice) (spectre)
useInitCondADS (ads)    

SWEEP Analysis Template

TemplateName: SWEEP
Description: Sweep analysis
Parameters:  
device (ads) (hspice) (spectre)
parameter (ads) (hspice) (spectre)

Outputplan Templates

This section contains the default outputplan templates.

ADS does not support OUTPUTPLAN_CURRENTS, and OUTPUTPLAN_DOPS will give all parameters for all devices if at least one parameter of one device is given. Outputplans added to S-parameter analyses will be ignored.

Outputplan for Device Currents Template

TemplateName: OUTPUTPLAN_CURRENTS
Description: Default outputplan for device currents.
Format: List of device:terminal, supplied as a space delimited string.
Parameters:  
deviceTerminals   (hspice) (spectre)

Outputplan for Device Operating Point (DOP) Template

TemplateName: OUTPUTPLAN_DOPS
Description: Default outputplan for device operating points.
Format: List of device:parameter, supplied as a space delimited string.
Parameters:  
deviceParameters (ads) (hspice) (spectre)

Outputplan for Nodes Template

TemplateName: OUTPUTPLAN_NODES
Description: Default outputplan for nodes.
Format: List of Nodenames, supplied as a space delimited string.
Parameters:  
nodes (ads) (hspice) (spectre)

Sweepplan Templates

This section contains the default sweepplan templates.

It is possible to add an offset or scale the values of the sweeplan for a specific simulator using the <dialect> Scale and <dialect> Offset parameters. To re-normalize the values in the results, the functions dKitResults->sweepVaribleScale and dKitResults->sweepVariableOffset can be used.

Linear Sweep Plan Template

TemplateName: SWEEPPLAN_LIN
Description: Linear sweep plan.
Parameters:  
numPts (ads) (hspice) (spectre)
start (ads) (hspice) (spectre)
step (ads) (hspice) (spectre)
stop (ads) (hspice) (spectre)
hspiceScale   (hspice)  
hspiceOffset   (hspice)  
adsScale (ads)    
adsOffset (ads)    
spectreScale     (spectre)
spectreOffset     (spectre)

Discrete Point Sweep Plan Template

The value parameter is a list of values, supplied as a space delimited string. For example:

$PointSweep->parameterValue('values', "1 2 3 4");

TemplateName: SWEEPPLAN_PT
Description: Sweep plan consisting of discrete points.
Parameters:  
values (ads) (hspice) (spectre)
hspiceScale   (hspice)  
hspiceOffset   (hspice)  
adsScale (ads)    
adsOffset (ads)    
spectreScale     (spectre)
spectreOffset     (spectre)

Simulator Options Templates

This section contains the default simulator options templates.

Circuit Simulator Options Template

For each simulator, the options should be specified as a list using a space delimited string as they need to be specified for the simulator. For example:

$myOption->parameterValue('hspiceOptions', "nopage acct=0 dccap=1 numdgt=10");

TemplateName: SIMULATOROPTION
Description: Circuit options.
Parameters:  
adsOptions (ads)    
hspiceOptions   (hspice)  
spectreOption     (spectre)

Circuit Temperature Template

TemplateName: TEMPERATURE
Description: Circuit Temperature.
Parameters:  
temperature (ads) (hspice) (spectre)

ModelLibrary Template

This section contains the default model library templates.
<dialect> ModelLibrary should contain the path to the <dialect> library, <dialect> SectionName is the section of that library to be activated, if it is omitted the whole library is included.

TemplateName: MODELLIBRARY
Description: Includes one modellibrary.
Parameters:  
adsModelLibrary (ads)    
adsSectionName (ads)    
hspiceModelLibrary   (hspice)  
hspiceSectionName   (hspice)  
spectreModelLibrary     (spectre)
spectreSectionName     (spectre)

Components/Instance Templates

This section contains a description of the default instance templates to be added to the circuit using the addInstance function from the Circuit module.

Parameter Template

This template defines a circuit parameter. value can be a numerical value (single parameter) or an equation. Be sure to add all single parameters to the circuit before adding equation parameters, otherwise the simulation results can be very awkward.

TemplateName: PARAMETER
Description: Netlist parameter.
Parameters:  
value (ads) (hspice) (spectre)

Capacitor Template

TemplateName: C
RequiredPrefix: c
Description: Capacitor.
Nodes: n1, n2
Parameters:  
capacitance (ads) (hspice) (spectre)
dtemp   (hspice) (spectre)
initialCurrent (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
scale   (hspice)  
temp (ads)    
tempCoef1 (ads) (hspice) (spectre)
tempCoef2 (ads) (hspice) (spectre)
tnom (ads)    

Capacitor with Model Template

TemplateName: CM
RequiredPrefix: c
Description: Capacitor with model.
Nodes: n1, n2
Parameters:  
capacitance (ads) (hspice) (spectre)
dtemp   (hspice) (spectre)
initialCurrent (ads) (hspice) (spectre)
length (ads) (hspice) (spectre)
modelName (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
scale   (hspice)  
temp (ads)    
tempCoef1 (ads) (hspice) (spectre)
tempCoef2 (ads) (hspice) (spectre)
tnom (ads)    
width (ads) (hspice) (spectre)

Diode Template

TemplateName: D
RequiredPrefix: d
Description: diode.
Nodes: nplus, nminus
Parameters:  
area (ads) (hspice) (spectre)
dtemp   (hspice)  
initialVoltage   (hspice)  
lengthPolySilicon   (hspice)  
length   (hspice)  
lengthMetalCapacitor   (hspice)  
modelName (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
off   (hspice)  
periphery (ads)    
peripheryJunction   (hspice)  
temp (ads)    
tnom (ads)    
width   (hspice)  
widthMetalCapacitor   (hspice)  
widthPolySilicon   (hspice)  

Initial Conditions Template

TemplateName: IC
RequiredPrefix: N/A
Description: Initial Conditions.
Nodes: N/A
Parameters:  
nodeName (ads) (hspice) (spectre)
value (ads) (hspice) (spectre)

Independent Current Source Template

TemplateName: I
RequiredPrefix: i
Description: Independent current source.
Nodes: nplus, nminus
Parameters:  
Iac_Mag (ads) (hspice) (spectre)
Iac_Phase=0 (ads) (hspice) (spectre)
Idc (ads) (hspice) (spectre)
multiplicity   (hspice) (spectre)
transientFunction (ads) (hspice)  
type     (spectre)
typeParams     (spectre)

Independent Damped Sinusoidal Current Source Template

TemplateName: ISIN
RequiredPrefix: i
Description: Independent damped sinusoidal current source.
Nodes: nplus, nminus
Parameters:  
amplitude (ads) (hspice) (spectre)
damping (ads) (hspice) (spectre)
Idc (ads) (hspice) (spectre)
delay (ads) (hspice) (spectre)
freq (ads) (hspice) (spectre)
phase (ads) (hspice) (spectre)

Independent Pulse Current Source Template

TemplateName: IPULSE
RequiredPrefix: i
Description: Independent pulse current source.
Nodes: nplus, nminus
Parameters:  
Ilow (ads) (hspice) (spectre)
Ihigh (ads) (hspice) (spectre)
delay (ads) (hspice) (spectre)
rise (ads) (hspice) (spectre)
fall (ads) (hspice) (spectre)
width (ads) (hspice) (spectre)
period (ads) (hspice) (spectre)

JFET Template

TemplateName: J
RequiredPrefix: j
Description: JFET.
Nodes: nd, ng, ns, nb
Parameters:  
area (ads) (hspice) (spectre)
dtemp   (hspice)  
length   (hspice)  
modelName (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
off   (hspice)  
region (ads)   (spectre)
temp (ads)    
tnom (ads)    
vdsval   (hspice)  
vgsval   (hspice)  
width   (hspice)  

Mutual Inductor Template

TemplateName: K
RequiredPrefix: k
Description: Mutual Inductor.
Nodes:  
Parameters:  
coupling (ads) (hspice) (spectre)
inductor1 (ads) (hspice) (spectre)
inductor2 (ads) (hspice) (spectre)
mutualInductance (ads)    

Inductor Template

TemplateName: L
RequiredPrefix: l
Description: Inductor.
Nodes: n1, n2
Parameters:  
dtemp   (hspice)  
inductance (ads) (hspice) (spectre)
initialCurrent (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
resistance (ads) (hspice) (spectre)
scale   (hspice)  
temp (ads)   (spectre)
tempCoef1 (ads) (hspice) (spectre)
tempCoef2 (ads) (hspice) (spectre)
tnom (ads)   (spectre)

Inductor with Model Template

TemplateName: LM
RequiredPrefix: l
Description: Inductor with Model.
Nodes: n1, n2
Parameters:  
dtemp     (spectre)
inductance (ads)   (spectre)
initialCurrent (ads)   (spectre)
modelName (ads)   (spectre)
multiplicity (ads)   (spectre)
resistance (ads)    
temp (ads)    
tempCoef1 (ads)    
tempCoef2 (ads)    
tnom (ads)    

MOSFET Template

TemplateName: M
RequiredPrefix: m
Description: MOSFET.
Nodes: nd, ng, ns, nb
Parameters:  
drainDiffusionArea (ads) (hspice) (spectre)
drainDiffusionSquares (ads) (hspice) (spectre)
drainPerimeter (ads) (hspice) (spectre)
drainResistanceAddl   (hspice)  
dtemp   (hspice) (spectre)
geoSharing   (hspice)  
length (ads) (hspice) (spectre)
modelName (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
off   (hspice)  
region (ads)   (spectre)
sourceDiffusionArea (ads) (hspice) (spectre)
sourceDiffusionSquares (ads) (hspice) (spectre)
sourcePerimeter (ads) (hspice) (spectre)
sourceResistanceAddl   (hspice)  
temp (ads)    
thresholdVoltageShift   (hspice)  
tnom (ads)    
vbsval   (hspice)  
vdsval   (hspice)  
vgsval   (hspice)  
width (ads) (hspice) (spectre)

PORT Template

TemplateName: PORT
RequiredPrefix: v
Description: Port for S-Parameter Analysis.
Nodes: nplus, nminus
Parameters:  
Vac_Mag   (hspice)  
Vdc (ads) (hspice) (spectre)
portNr (ads)   (spectre)
referenceImpedance (ads)   (spectre)
transientFunction   (hspice)  

BJT Template

TemplateName: Q
RequiredPrefix: q
Description: Bipolar Junction Transistor.
Nodes: nc, nb, ne, ns
Parameters:  
areaBasis   (hspice)  
areaCollector   (hspice)  
areaEmittor (ads) (hspice) (spectre)
dtemp   (hspice) (spectre)
modelName (ads) (hspice) (spectre)
multiplicity (ads) (hspice) (spectre)
off   (hspice)  
region (ads)   (spectre)
temp (ads)    
tnom (ads)    
vbeval   (hspice)  
vceval   (hspice)  

Resistor with Model Template

TemplateName: RM
RequiredPrefix: r
Description: Resistor with model.
Nodes: n1, n2
Parameters:  
dtemp     (spectre)
length (ads)   (spectre)
modelName (ads)   (spectre)
multiplicity (ads)   (spectre)
narrow (ads)    
narrowLength (ads)    
narrowWidth (ads)    
noise     (spectre)
resistance (ads)   (spectre)
sheetResistance (ads)    
temp (ads)    
tempCoef1 (ads)   (spectre)
tempCoef2 (ads)   (spectre)
tnom (ads)    
width (ads)   (spectre)

Independent Voltage Source Template

TemplateName: V
RequiredPrefix: v
Description: Independent voltage source.
Nodes: nplus, nminus
Parameters:  
Vac_Mag (ads) (hspice) (spectre)
Vac_Phase=0 (ads) (hspice) (spectre)
Vdc (ads) (hspice) (spectre)
multiplicity     (spectre)
transientFunction (ads) (hspice)  
type     (spectre)
typeParams     (spectre)

Independent Damped Sinusoidal Voltage Source Template

TemplateName: VSIN
RequiredPrefix: v
Description: Independent damped sinusoidal voltage source.
Nodes: nplus, nminus
Parameters:  
amplitude (ads) (hspice) (spectre)
damping (ads) (hspice) (spectre)
Vdc (ads) (hspice) (spectre)
delay (ads) (hspice) (spectre)
freq (ads) (hspice) (spectre)
phase (ads) (hspice) (spectre)

Independent Pulse Voltage Source Template

TemplateName: VPULSE
RequiredPrefix: v
Description: Independent pulse voltage source.
Nodes: nplus, nminus
Parameters:  
Vlow (ads) (hspice) (spectre)
Vhigh (ads) (hspice) (spectre)
delay (ads) (hspice) (spectre)
rise (ads) (hspice) (spectre)
fall (ads) (hspice) (spectre)
width (ads) (hspice) (spectre)
period (ads) (hspice) (spectre)

MESFET Template

TemplateName: Z
RequiredPrefix: z
Description: MESFET.
Nodes: nd, ng, ns, nb
Parameters:  
area (ads) (hspice) (spectre)
dtemp   (hspice)  
length   (hspice)  
modelName (ads) (hspice) (spectre)
multiplicity   (hspice) (spectre)
off   (hspice)  
region (ads)   (spectre)
vdsval   (hspice)  
vgsval   (hspice)  
width   (hspice)  

Circuit Initialization

This section contains the default circuit initialization templates.

Circuit End Deck Card Template

TemplateName: CIRCUITENDDECKCARD
Description: If defined, added as last card of the deck.
Parameters:  
adsEndDeckcard (ads)    
hspiceEndDeckcard=.end   (hspice)  
spectreEndDeckcard     (spectre)

Command to Invoke Simulator Template

TemplateName: CIRCUITINVOKECOMMAND
Description: Command to invoke the simulator.
Parameters:  
cleanup (ads) (hspice) (spectre)
netlistFilename (ads) (hspice) (spectre)

Netlistnames for the Different Simulators Template

TemplateName: CIRCUITNETLISTNAME
Description: Netlist names for the different simulators.
Parameters:  
adsNetlistSuffix=.ckt (ads)    
hspiceNetlistSuffix=.hsp   (hspice)  
projectName     (spectre)
spectreNetlistSuffix=.scs (ads) (hspice) (spectre)

Circuit Start Deck Card Template

TemplateName: CIRCUITSTARTDECKCARD
Description: If defined, added as first card of the deck.
Parameters:  
adsStartDeckcard (ads)    
hspiceStartDeckcard   (hspice)  
spectreStartDeckcard= simulator lang=spectre     (spectre)
 

Privacy Statement  | Terms of Use  | Legal | Contact Us  | © Agilent 2000-2008 

Contents
Additional Resources