t_maestroMode

Specifies the application for which the XL mode is to be ended.

Possible values:

• "explorer": Ends the OCEAN XL mode for ADE Explorer.
• "assembler": Ends the OCEAN XL mode for ADE Assembler.

Any other value ends the OCEAN XL mode for ADE XL.

Default value: nil

t

Returns t if the test setup completes.

nil

Returns nil otherwise.

t_maestroMode

Specifies the application for which simulations are to be run.

Possible values:

• "explorer": Sets the OCEAN XL mode for ADE Explorer and checks out the Virtuoso_ADE_Explorer (95250) license. If 95250 is not available, Virtuoso_ADE_Assembler (95260) can also be checked out.
• "assembler": Sets the OCEAN XL mode for ADE Assembler and checks out the Virtuoso_ADE_Assembler (95260) license.

Any other value sets the OCEAN XL mode for ADE XL and checks out the Analog_Design_Environment_XL (95210) license.

Default value: nil

t

Returns t if the mode is set to XL.

nil

Returns nil otherwise

t_testName

The name of the test.

t

Returns t if its able to begin the test.

nil

Returns nil otherwise.

t_testName

Name of the test.

t

Returns t if the test is disabled.

nil

Returns nil otherwise.

t

Returns t if the test setup completes.

nil

Returns nil otherwise.

t

Returns t if successful.

nil

Returns nil otherwise.

s_blockName

Specifies the name of the block that needs to be enabled for multi-technology simulation.

Valid values: a string

?isMtsBlock g_isMtsBlock

Specifies whether the block is enabled or disabled for multi-technology simulation.

Valid values: t, nil

Default Value: nil

?includeFile l_includeFile

Specifies the include files associated with the block.

Valid values: a list of strings or nil

Default value: nil

?modelFiles l_modelFiles

Specifies the model files associated with the block.

Valid values: a list of strings or nil

Default value: nil

?simOptions t_simOptions

Specifies simulator options.

t

Returns t if successful.

nil

Returns nil otherwise.

s_blockName

Specifies the name of the block that needs to be enabled for multi-technology simulation.

Valid values: a string

?enableMTS g_enableMTSBlock

Specifies whether the block is enabled or disabled for multi-technology simulation.

Valid values: t, nil

Default Value: nil

?modelFiles l_modelFiles

Specifies the model files associated with the block.

Valid values: a list of strings or nil

Default value: nil

?simOptions t_simOptions

Specifies simulator options.

t

Returns t if successful.

nil

Returns nil otherwise.

g_enable

Enables or disables MTS mode for the current test.

Valid values: t, nil

Default Value: nil

t

Returns t if successful.

nil

Returns nil otherwise.

t_testName

The name of the test.

t

Returns t if the test is selected.

nil

Returns nil otherwise.

t_item

Type of the element from which you need to delete a note.

Valid values: "test", "history", "corner", or "globalvar"

t_name

Name of the element for which you are deleting a note.

t

Returns t, when successful.

nil

Unsuccessful operation.

t_paramName

Name of the parameter.

t

Returns t if the sweep parameter is disabled.

nil

Returns nil otherwise.

t_varName

Name of the variable.

t

Returns t if the sweep variable is disabled.

nil

Returns nil otherwise.

t_paramPath

Name of the sweep parameter.

t

Returns t if successful.

nil

Returns nil otherwise.

t_varName

Name of the sweep variable.

t

Returns t if successful.

nil

Returns nil otherwise.

t_testName

Name of the test.

t

Returns t if successful.

nil

Returns nil otherwise.

x_jobId

Returns the job ID of the current simulation job

nil

Returns nil otherwise

t_sessionName

Returns the name of the session.

nil

Returns nil and prints an error message if there is no OCEAN XL session.

l_setupOptions

The list of setup options.

?name t_name

Specifies a name to be used to save the job setup.

-distributionmethod

Specifies the location where the job has to run. The possible values for distribution method are: Local, Remote-Host, Command, LBS. Default value: Local

When you choose LBS distribution method, by default OCEAN uses the LBS Distributed Resource Management Systems (DRMS). You can choose to use LSF or SGE DRMS by setting the LBS_CLUSTER_MASTER and LBS_BASE_SYSTEM environment variables in your .cshrc file. For more details, refer to Setting Up to Use Distributed Processing Option in Virtuoso Analog Distributed Processing Options User Guide.

-maxjobs

Specifies the maximum number of jobs that can run at any time during the given session. Default value: 1

-starttimeout

Specifies the time (number of seconds) to wait for the icrp process (a process that runs the specific job) to report back that it has started the job. The wait time starts as the job is submitted. Default value: 300

-startmaxjobsimmed

Immediately submits all the specified maximum number of jobs. Default value: 1

-configuretimeout

Specifies the time (number of seconds) to wait for the icrp process to report back that it has configured the job. The wait time starts as soon as a job configure command is sent. Default value: 300

-lingertimeout

Specifies the time (number of seconds) after which you want the program to kill the icrp process after the simulations finish. Default value: 300

-runtimeout

Specifies the time (number of seconds) to wait for the icrp process to report back that it has run the job. The wait time starts as soon as the run command for the job is sent. Default value: -1, which means ADE XL keeps waiting for infinite time for the icrp process to report back.

-showoutputlogerror

Displays the output log files of all error points in the test. Default value: 0

-showerrorwhenretrying

Displays the output log file on the occurrence of an error for a test, even if the ADE XL distribution system is retrying the test. Default value: 1

-reconfigureimmediately

When running multiple runs in the same ADE XL session, specifies that a completed job be reassigned from the current run to a new run. Default value: 1

-jobqueue

Specifies the name of the queue. If no queue is defined, the job is placed in the default queue. This option is used only when LBS or LSF DRMS is used.

-jobhostname

Specifies the name of the host on which the job will run. If no host is specified, the system assigns the job to any available host. This option is used when distributedmethod is set as Remote-Host or when distributedmethod is set as LBS and either LBS or LSF DRMS is used.

-parallelnumprocs

Specifies the number of parallel processors to be used. This option is used only when LSF DRMS is used.

-jobresourcerequirements

Specifies a string describing the resources required to run the job when LSF DRMS is used.

To know more about the format of the resource requirements string, refer to LSF Resource Requirement String Format in Virtuoso ADE Explorer User Guide.

-sgehardresource

Specifies requirements for hardware resources for the job to be run when SGE DRMS is used.

-sgesoftresource

Specifies requirements for software resources for the job to be run when SGE DRMS is used.

-sgepriority

Specifies priority for the job being submitted when SGE DRMS is used.

-sgeparallelenv

Specifies the name of a parallel environment for the job to be run when SGE DRMS is used.

-jobsubmitcommand

Specifies the command you want to use to start jobs. This option is used when distributionmethod is set as Command.

t

Returns t if the job setup information is set successfully.

nil

Returns nil otherwise.

t_state

The name of the setup state to be restored.

t_mode

Specifies the mode for restoring the settings in the setup state to the active setup.

Valid values: ‘retain, ‘merge, ‘overwrite

?test t_tests

Specifies whether the tests in the setup state should be restored to the active setup.

Valid values: t, nil

Default Value: t

?vars t_vars

Specifies whether the global variables in the setup state should be restored to the active setup.

Valid values: t, nil

Default Value: t

?parameters t_parameters

Specifies whether the parameters in the setup state should be restored to the active setup.

Valid values: t, nil

Default Value: t

?currentMode t_currentMode

Specifies whether the run mode in the setup state should be restored to the active setup

Valid values: t, nil

Default Value: t

?runOptions t_runOptions

Specifies whether the run options in the setup state should be restored to the active setup

Valid values: t, nil

Default Value: t

?specs t_specs

Specifies whether the parameter specifications in the setup state should be restored to the active setup

Valid values: t, nil

Default Value: t

?corners t_corners

Specifies whether the corners in the setup state should be restored to the active setup

Valid values: t, nil

Default Value: t

?modelGroups t_modelGroups

Specifies whether the model groups in the setup state should be restored to the active setup.

Valid values: t, nil

Default Value: t

?extensions t_extensions

Specifies whether the extensions in the setup state should be restored to the active setup.

Valid values: t, nil

Default Value: t

?relxanalysis t_relxanalysis

Specifies whether the details of reliability analysis should be restored to the active setup.

Valid values: t, nil

Default Value: t

t

Returns t if successful.

nil

Returns nil otherwise.

n_int

An integer ranging between 1 and 100000.

Default value: 20

g_session

Returns the session object for the main simulation session

nil

Returns nil otherwise

t_projectDir

Sets the location of the project directory.

t

Returns t if successful.

nil

Returns nil otherwise.

t_item

Type of the element to which you need to add a note.

Valid values: "test", "history", "corner", or "globalvar"

t_name

Name of the element to which you are adding a note.

t_note

Text to be added to the note.

A note can contain a maximum of 512 characters.

t

Returns t, when successful.

nil

Unsuccessful operation.

t_resultsDir

Location of the results directory.

t

Returns t if the results location is set.

nil

Returns nil otherwise.

t_lib

The name of the library in which the new adexl view is to be saved.

t_cell

The name of the cell in which the new adexl view is to be saved.

t_view

The name of the new adexl view.

t

Returns t if the save is successful.

nil

Returns nil otherwise.

l_varValueList

List of variable and values combination. Each list item contains the name of sensitivity variable, a list of sweep values for that variable, and a reference value.

t

Returns t if the list of sensitivity variables is set.

nil

Returns nil otherwise.

t_testName

Name of the test for which the variable value is to be set.

nil

Returns nil otherwise

g_disabled

Specify t to disable all variables, and nil to enable all variables.

t

Returns t if all variables are enabled or disabled.

nil

Returns nil otherwise.

t_setupDir

Location of the setup directory.

t

Returns t if the location of the setup directory is set.

nil

Returns nil otherwise.

t_simResultsDir

Sets the location of the simulation results directory.

t

Returns t if successful.

nil

Returns nil otherwise.

?inputs t_inputs

Specifies the input stimuli.

?globals t_globals

Specifies the global sources.

t

Returns t if the analog stimuli is set successfully.

nil

Returns nil otherwise.

t_paramName

Name of the parameter.

t_paramValue

Value of the parameter.

t

Returns t if sweep for the parameter is set.

nil

Returns nil otherwise.

t_varName

Name of the variable.

t_varValue

Value of the variable and the specification for the sweep.

t

Returns t if the sweep is set.

nil

Returns nil otherwise.

t_lib

Name of the library.

t_cell

Name of the cell.

t_view

Name of the view.

?mode t_mode

Specifies the mode of the target cellview.

Valid values:

• r - Opens the target cellview in read mode
• a - Opens the target cellview in edit mode.

Default value: a

t

Returns t if it is able to use the given library, cell, and view as the target.

nil

Returns nil otherwise.

t_cornerName

Name of the corner.

l_cornerDetails

Details of the corner. Details is a list of items where each item has a tag, name, and a value. The tag can be of 3 types:

• variable
• parameter
• model

t

Returns t if the corner is defined.

nil

Returns nil otherwise.

t_cornerName

The name of the corner to be disabled.

t

Returns t if the corner is disabled.

nil

Returns nil otherwise.

t_cornerName

Name of the corner.

t_testName

Name of the test.

t

Returns t if the corner of the test is disabled.

nil

Returns nil otherwise.

t_cornerName

The name of the corner to be enabled.

t

Returns t if the corner is disabled.

nil

Returns nil otherwise.

t_cornerName

Name of the corner.

t_testName

Name of the test.

t

Returns t if successful.

nil

Returns nil otherwise.

t

Returns t if successful.

nil

Returns nil otherwise.

t_modelGroupName

Name of the new model group.

l_modelFileSetup

List of model file spec.

Model file spec:

• t_modelFilePath
• [?section t_section]
• [?enabled g_enabled]
• [?test t_test]
• [?block t_block]

t

Returns t if a new model is defined.

nil

Returns nil otherwise.

t_outputName

Output name

t_outputVal

Output value

t

Returns t if output is successfully added or updated

nil

Returns nil otherwise

t_fileName

Path and name of file to which the results need to be exported. Append .htm or .html to the filename to write in HTML format and .csv to write in CSV format.

If no file extension is specified, a .csv file is created by default.

The file is saved in the current working directory.

t_viewType

Name of the view type that needs to be exported.

Possible values:

"" or Current: writes the currently visible view

Detail

Detail-Transpose

Optimization

Summary

Yield

Default value: ""

t

Successful export of output view.

t_error

If unsuccessful, returns an error message.

t_expr

The expression that you want to add.

?name t_outputName

The name of the expression.

?plot t_plot

Whether to plot or not.

?save t_save

Whether to save or not.

t

Returns t if the output expression is set.

nil

Returns nil otherwise.

t_expr

The expression that you want to add.

?name t_outputName

The name of the expression.

?plot plot

Whether to plot or not.

?save save

Whether to save or not.

?evaltype t_evaltype

Evaluation type of the expression

Possible values:

• "point": Calculates the expression for every design point
• "corners": Calculates the expression across all the corners
• "sweeps": Calculates the expression across all the sweep points
• "maa": Calculates the expression across all the corners and sweep points

Default value: "point"

t

Returns t if the output expression is set.

nil

Returns nil otherwise.

t_expr

The MATLAB expression that you want to add to the output.

?name t_name

The name of the MATLAB expression.

?plot b_flag

Specifies whether to plot or not.

?save b_flag

Specifies whether to save or not.

?evaltype s_type

Evaluation type of the expression

Possible values:

• "point": Specifies that the MATLAB expression is to be evaluated for every design point
• "maa": Specifies that the MATLAB expression is to be evaluated across all design points

Default value: "point"

t

Returns t if the MATLAB expression is set.

nil

Returns nil otherwise.

t_script

Name and location of the script file.

t_outputName

Name of the output file.

plot

Specifies if the values are to be plotted.

save

Specifies if the output are to be saved.

t

Returns t if the output is generated.

nil

Returns nil otherwise.

t_script

Name and location of the script file.

?name t_outputName

Name of the output file.

?plot plot

Specifies if the values are to be plotted.

?save save

Specifies if the output are to be saved.

?evalType t_evaltype

Whether to evaluate the OCEAN script for a design point or across all corners for a design points.

Valid Values: corners, point

Default Value: point

t

Returns t if the output is generated.

nil

Returns nil otherwise.

t_expr

Operating region expression

?name t_name

Name of the operating region output

?plot t_plot

Specifies if the results for the output are to be plotted

Specify:

• t to plot the results
• nil to disable plotting of the results

?save t_save

Specifies if the results for the output are to be saved

Specify:

• t to save the results
• nil to disable saving of the results

t

Returns t if the output is added

nil

Returns nil otherwise

t_signal

The name of the signal.

?plot plot

Whether to plot or not.

?save save

Whether to save or not.

t

Returns t if the output signal is set.

nil

Returns nil otherwise.

t_term

The name of the terminal.

?plot plot

Specifies whether to plot or not.

?save save

Specifies whether to save or not.

?type type

If type is set to 'terminalV', a terminal voltage output is created instead of a normal terminal current output. If type is not specified, a current terminal is saved.

t

Returns t if the output terminal is set.

nil

Returns nil otherwise.

?netlist g_netlist

Specifies whether the checks and asserts defined in the Checks/Asserts assistant will be netlisted or not. This provides an overall control over the netlisting of checks and asserts.

Valid values:

• t: Enables overall netlisting of checks and asserts. However, netlisting of the checks and asserts defined for the cellviews under a particular test is controlled by the ocnxlPutChecksAssertsTest command.
• nil: Checks and asserts are not netlisted

Default value: nil

t

Returns t f the checks and asserts are successfully added in the active setup

nil

Returns nil if the checks and asserts already exist in the active setup.

t_expr

Expression to be used for the output. The format for the expression contains the following parts:

• Name of the operation or aggregate function. For example, Avg, Max, Min, or Sum.
• Name of the field to be accessed in the function
• Name of the violation filter on which you need to run the aggregate function

Example:

"Max 'Duration (s)' on 'Dynamic Excessive Rise, Fall, Undefined State Time Check'" 

where, Max is the aggregate function name, Duration (s) is the field name, and Dynamic Excessive Rise, Fall, Undefined State Time Check is the violation filter name.

"Count '<field-name>'"

Example:

"Count 'All Checks/Asserts'"

?name t_name

Name to be assigned to the output.

?plot g_plot

Specifies if the value of this output is to be plotted.

?save g_save

Specifies if the value of this output is to be saved.

t

Returns t if the output is added successfully.

nil

Returns nil otherwise.

?testName t_testName

Name of the test

?netlist g_netlist

Controls whether checks and asserts are to be netlisted.

Valid values: t, nil

Default value: nil

?netlistScope g_netlistScope

Specifies the scope for netlist.

Valid values:

• "all": Checks and asserts of all the cellviews beneath the top level schematic/config view will be netlisted.
• "partial": Checks and asserts of selected cellviews will be netlisted. Use ocnxlPutEnabledChecksAssertsCellViews to specify the cellviews.
• "none": Nothing beneath the test bench top level schematic/config view will be netlisted.

Default value: "none"

t

Returns t if the test and its netlisting setting for checks and asserts are successfully applied

nil

Returns nil in the following cases:

• The checksasserts node does not exist in the active setup
• The test is already added under the checksasserts node in the active setup
• t_testName is not a valid string
• t_netlistScope is not a valid string

?testName t_testName

Name of the test for which the cellview list is to be applied.

?enabledCellViews l_enabledCellViews

List containing list of library, cell, and view names for which the checks and asserts defined in the Checks/Asserts assistant will be netlisted.

The list must be given in the following format:

list(list(“lib1 “cell1” “view1”) list(“lib2 “cell2” “view2”) ...)

t

Returns t if the list of cellview names is successfully added under the given testname within the checksasserts node.

nil

Returns nil in the following cases:

• The test specified using t_testName does not exist in the setup
• t_testName is not a valid string
• Format of the l_enabledCellviews list is incorrect
• l_enabledCellviews does not contain any list item

t

Returns t if successful.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

t_thresholdValue

The threshold value.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

t_thresholdValue

The threshold value.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_resultName

Name of the result.

If you do not specify any name for a result, the expression itself is used as the name of that result. Therefore, in case of unnamed results or outputs, you can specify the expression as a value for this argument.

t_maxValue

The maximum target value.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

t_minValue

The minimum target value.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

t_value

The target value.

s_toleranceType

The type of tolerance.

t_toleranceValue

The tolerance value.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_outputName

Name of the output.

If you do not specify any name for an output, the expression itself is used as the name of that output. Therefore, in case of unnamed outputs, you can specify the expression as a value for this argument.

t_maxValue

The maximum value of the range.

t_minValue

The minimum value of the range.

?weight g_weight

The weighting factor for the spec.

?corner g_cornerName

Name of the corner for which the spec is to be used. This argument helps in overridding a spec for the given corner.

t

Returns t if the specifications are specified.

nil

Returns nil otherwise.

t_specName

Name of the spec.

t

Returns t if successful.

nil

Returns nil otherwise.

t_runFullEvaluation

Sets to run full evaluation.

Possible Values: “1” and “0”.

Default Value: “1”

t_meetAllGoals

Sets to run only until all goals are met.

Possible Values: “1” and “0”.

Default Value: “1”

t_timeLimit

Sets a time limit (in seconds) for the run.

t_numPoints

Sets the limit in the number of points to be run.

t

Returns t if options are specified for conjugate gradient run.

nil

Returns nil otherwise.

l_varValueList

List of corner variable-value combination list. Each list item contains a list of variable name, minimum and maximum values for the variable, and a reference value.

t

Returns t if the corner variables for Create Worst Care Corner simulation run mode are set successfully.

nil

Returns nil otherwise.

?refPoint t_refPoint

Specifies whether to use a reference point that you have created as a starting place for sizing. It is optional to set this argument when the algorithm specified with the t_effort argument is neocircuitGlobal. For other values of t_effort, set this as 1.

Default value is 0.

?meetAllGoals t_meetAllGoals

Specifies the stopping criteria for the analysis. By default, it is set to 1 and all operating region specifications are to be met.

?effort t_effort

Specifies the name of algorithm for optimizing the design to meet the operating region specifications. Possible values are: neocircuitGlobal, conjugateGradient, brentPowell, hookeJeeves. The default algorithm is neocircuitGlobal.

t

Returns t when successful

nil

Otherwise, returns nil

l_params

Returns a list of the best point parameters if successful.

nil

Returns nil otherwise.

?runFullEvaluation t_runFullEvaluation

Sets the program to run full optimization. Default for runFullEvaluation is 0. Possible values are 0 and 1.

?refPoint t_refPoint

Sets the current point as a starting place for sizing. Default for refPoint is 0. Possible values are 0 and 1.

?meetAllGoals t_meetAllGoals

Sets the program to run optimization only until all specifications are met. Default for meetAllGloals is 0. Possible values are 0 and 1.

?timelimit t_timeLimit

Sets the time limit (in minutes) for the optimization run. Default for timeLimit is "".

?numPoints t_numPoints

The maximum number of points for the optimization run. Default for numPoints is "".

?noImprvPoints t_noImprvPoints

Default for noImprvPoints is "".

?pointsAfterAllSpecsSatisfied t_pointsAfterAllSpecsSatisfied

Sets the number of points to be run after all specifications are satisfied. Default for t_pointsAfterAllSpecsSatisfied is "".

?startingstateorpoint     t_startingstateorpoint

Sets the starting point for the simulation run as reference point or starting state. Default for t_startingstateorpoint is "". Possible values are Starting State or Reference Point.

?startingstatename t_startingstatename

Sets the starting state if the startingstateorpoint argument is set to Starting State.

t

Returns t if options are specified for global optimization run.

nil

Returns nil otherwise.

?effort t_effort

Value for effort. Default for effort is coarse. Possible values are fine and coarse.

?runFullEvaluation t_runFullEvaluation

Sets the program to run full optimization. Default for runFullEvaluation is 0. Possible values are 0 and 1.

?meetAllGoals t_meetAllGoals

Sets the program to run optimization only until all specifications are met. Default for meetAllGloals is 0. Possible values are 0 and 1.

?timeLimit t_timeLimit

Sets the time limit (in minutes) for the optimization run. Default for timeLimit is "".

?numPoints t_numPoints

Sets the maximum number of points for the optimization run. Default for numPoints is "".

?startingstateorpoint t_startingstateorpoint

Sets the starting point for the simulation run as reference point or starting state. Default for t_startingstateorpoint is "". Possible values are Starting State or Reference Point.

?startingstatename t_startingstatename

Sets the starting state if the startingstateorpoint argument is set to Starting State.

t

Returns t if options are specified for local optimization run.

nil

Returns nil otherwise.

?mcmethod t_mcmethod

Sets the statistical variation method for Monte Carlo runs. Default for mcmethod is all. Possible values are global, mismatch and all.

?mcNumPoints t_mcNumPoints

Sets the number of points you want to simulate for Monte Carlo runs. Default for mcNumPoints is 100.

?samplingMode t_samplingMode

Sets the default statistical sampling method for Monte Carlo runs. Default for samplingMode is random. Possible values are random, orthogonal, and lhs (Latin Hypercube).

?saveAllPlots t_saveAllPlots

Saves raw data (psf files) for every Monte Carlo iteration so that you can plot a family of curves. Default for saveAllPlots is 0. Possible values are 0 and 1.

?saveProcess t_saveProcess

Controls whether ‘process’ parameters need to be saved to the results database. Default value is 1. Possible values are 0 and 1.

?saveMismatch t_saveMismatch

Controls whether ‘mismatch’ parameters need to be saved to the results database. Default value is 0. Possible values are 0 and 1.

?useReference t_useReference

Specifies whether to use a schematic point or a reference point that you have created as a starting place for sizing.

Possible values are 0 and 1. The default value is 0.

?donominal t_donominal

Specifies whether to run a simulation at the reference point prior to beginning the Monte Carlo process. Possible values are 0 and 1. If set to 1, Spectre will run a simulation at the reference point, and, if this fails, then the sampling process is not initiated and the simulation stops.

The default value is 1.

?monteCarloSeed t_monteCarloSeed

Specifies a different seed for Monte Carlo runs. Default for monteCarloSeed is 12345.

?mcStartingRunNumber t_mcStartingRunNumber

Specifies a starting run number for Monte Carlo runs. Default for mcStartingRunNumber is 1.

?dutSummary t_dutSummary

Specifies a list of design under test (DUT) instances for Monte Carlo runs. In this list, you can specify the instances and devices to which mismatch variations must be applied. The format to specify the list is as given below:

<testname%instances%Libname/Cellname/Viewname%Master#testname%instances%modelname%Subcircuit#testname%instances%Schematic%Schematic>

where two DUT instances in the list are separated by a # (hash).

For example:
“opamp090:full_diff_opamp_AC:2:1%/I21%acOpenDiff%Subcircuit#opamp090:full_diff_opamp_AC:2:1%/I0/I1%opamp090/ampn/schematic%Master#opamp090:full_diff_opamp_AC:2:1%/I0/M5A, /I0/M3A%Schematic%Schematic”

Default for dutSummary is "".

?dutSubckts t_dutSubckts

Specifies a list of design under test (DUT) instances for Monte Carlo runs that are subcircuits.

The valid value is semicolon-separated list of DUT instances that are subcircuits.

For example:

"/I0/I0/I1;/I0/I1/I0;/I0/I1/I1"

?ignoreFlag t_ignoreFlag

Argument to specify if the user wants to apply mismatch variations to instances specified with dutSummary.

Default value is 0. Set it to 1 if you do not want to apply mismatch variations to instances.

?mcNumBins t_mcNumBins

Argument to specify the number of bins. Set this value when samplingMode is lhs.

Default for mcNumBins is "". If not set, simulator uses its own default number of bins. For example, Spectre calculates the number of bins as given below:

numBins = max(t_mcNumBins, (t_mcNumPoints + t_mcStartingRunNumber -1))

?designUnderTest t_designUnderTest

Design picked up for the test

?dutIntances t_dutIntances

Number of occurance of DUT intances

?mcYieldTarget tmcYieldTarget

Target yield percentage

?mcStopMethod t_mcStopMethod

Sets the statistical variation method to stop Monte Carlo.

?mcSigmaScaleValue t_mcSigmaScaleValue

Sets a sigma scale value

t

Returns t if options for montecarlo run are specified.

nil

Returns nil otherwise.

?points t_numberOfPoints

Specifies the number of points. The default value for points is 200.

t

Returns t if the options for the run are specified.

nil

Returns nil otherwise.

?haveDesignParams t_haveDesignParams

Specifies if you want to vary global variables and device parameters. Default value is 0. If you set this to 1, ensure that you have specified at least one sweep variable or parameter and also created a reference point. You also need to set either t_haveDesignParamSteps or t_designParamPercentage.

?haveProcessParams t_haveProcessParams

Specifies if you want to vary the statistical process and mismatch parameters. Default value is 0.

?haveDcOp t_haveDcOp

Specifies if you want to save the sensitivity data for specific DC operating point parameters. Default value is 0.

?haveDesignParamSteps t_haveDesignParamSteps

Specifies that you want to vary global variable and device parameter values by a single step from the reference values specified for global variables and parameters in the reference point.

?designParamPercentage t_designParamPercentage

Specifies the percentage of the range of a variable or parameter's value from the reference values by which the process parameters need to be varied. Value range is between 0 and 100.

?processSigmaSteps t_processSigmaSteps

Specifies the number of standard deviations for statistical parameters with normal or log normal distribution. Default value is 1.

?processConfidenceIntervalUniform t_processConfidenceIntervalUniform

Specifies the percentage range by which statistical parameters with uniform distribution need to be varied. Value range is between 0 and 50.

?processMethod t_processMethod

Specifies whether the statistical parameters to be used are process, mismatch or both. Default value is process. Possible values are process, mismatch and all.

?dcOpInfo t_dcOpInfo

Specifies DC operating point parameters as input parameters for the sensitivity analysis run.

?algorithm t_algorithm

Name of the algorithm to be used.

nil

Returns nil

?socoptmethod t_socoptmethod

Specifies between Optimization algorithms for iteration sizing runs. The default value is neocircuitGlobal. Other values are brentPowell, hookeJeeves, and conjugateGradient.

?socreferencepoint t_socreferencepoint

Specifies if reference point should be used. The default value is 0.

?soceffort t_soceffort

This argument is currently not supported.

?soctimelimit t_soctimelimit

Specifies the time limit for the run.

?socmaxpoints t_socmaxpoints

Specifies the maximum number of points processed per iteration. The default value is 3000.

?sociterations t_sociterations

Specifies the maximum number of sizing iterations for the Size Over Corners run. The default value is 3.

?socstopifnoimprovement t_socstopifnoimprovement

Specifies if the optimization run should stop if there is no improvement. The default value is 0.

nil

Returns nil.

l_startingPointDetails

A list of elements where each element is:

(t_type t_varName t_value)

Where:

• t_type can be a variable or parameter.
• t_varName is the name of the variable or parameter
• t_value is the value of the variable or parameter.

t

Returns t if successful.

nil

Returns nil otherwise.

?submitpointenabled t_submitpointenabled

Specify t to override the active setup with the submit point information.

t

Returns t if the options are set successfully.

nil

Returns nil otherwise.

?algorithm t_algorithm

Specifies the algorithm based on which you want to create the worst case corners.

Possible values: OFAT 3-level, OFAT Sweep, 2^K Factorial, Central Composite Design, and Full Factorial.

t

Returns t if the option is set successfully.

nil

Returns nil otherwise.

?useReference t_useReference

Specifies whether to use a schematic point or a reference point that you have created as a starting place for sizing. The possible values are 0 and 1. The default value is 0.

?mcMethod t_mcMethod

Specifies the yield estimation method to be used. The default value is all. The possible values are global, mismatch and all.

?samplingMethod t_samplingMethod

Sets the default statistical sampling method for improve yield runs. The default value is random. Possible values are random, orthogonal, and lhs (Latin Hypercube).

?mcNumPoints t_mcNumPoints

Sets the number of Monte Carlo points you want to simulate. The default value is 200.

?mcNumBins t_mcNumBins

If the selected sampling method is lhs, this argument specifies the number of bins (or subdivisions) for lhs. Set this value when samplingMode is lhs.

Default for mcNumBins is "". If not set, simulator uses its own default number of bins. For example, Spectre calculates the number of bins as given below:

numBins = max(t_mcNumBins, (t_mcNumPoints + t_mcStartingRunNumber -1))

?monteCarloSeed t_monteCarloSeed

Specifies a different seed for Monte Carlo runs. Default for monteCarloSeed is 12345.

?haveYieldToStart t_haveYieldToStart

Specifies if there is a yield in sigma value from which the high yield estimation method should be applied. The default value is 1. Possible values 0 and 1.

?yisToStart t_yisToStart

Specifies a yield in sigma value from which the high yield estimation method should be applied. The default value is 3.0.

UseVarReduction

Enables or disables the statistical variable reduction method.

Default value auto, enables this method. Possible values auto and disabled.

varReductionParam

Specifies the parameters for variable reduction method.

iterations

Optional argument to specify the number of sizing/Monte Carlo iterations run for each specification.

The default value is 10.

dutSummary

Optional argument to specify a list of design under test (DUT) instances for improve yield runs. In this list, you can specify the instances and devices to which mismatch variations must be applied. The format to specify the list is as given below:

<testname%instances%Libname/Cellname/Viewname%Master#testname%instances%modelname%Subcircuit#testname%instances%Schematic%Schematic>

where two DUT instances in the list are separated by a #(hash).

For example:
“opamp090:full_diff_opamp_AC:2:1%/I21%acOpenDiff%Subcircuit#opamp090:full_diff_opamp_AC:2:1%/I0/I1%opamp090/ampn/schematic%Master#opamp090:full_diff_opamp_AC:2:1%/I0/M5A, /I0/M3A%Schematic%Schematic”

Default for dutSummary is "".

dutSubckts

Specifies a list of design under test (DUT) instances for Monte Carlo runs that are subcircuits.

The valid value is semicolon-separated list of DUT instances that are subcircuits.

For example:

"/I0/I0/I1;/I0/I1/I0;/I0/I1/I1"

ignoreFlag

Optional argument to specify if the user wants to apply mismatch variations to instances specified with dutSummary.

Default for ignoreFlag is 0. Set it to 1 if you do not want to apply mismatch variations to instances.

yeMethod

Specifies the estimation method to be used. This argument takes only one value Worst Case Distance.

yeSpecTolerance

Specifies the specification tolerance value. This argument is used to modify the convergence criteria to be used for WCD calculation.

Default value: 0.02

Valid value range: 0.01 to 0.1

• Specification value error ratio is less than the value specified by yeSpecTolerance, where the specification value error ratio is calculated as:
  

  spec_value_error_ratio = abs(spec_value - spec_target) / abs(nominal_spec_value - spec_target)

• Angle between the WCD point vector and gradient vector is less than the value specified by yeAngleTolerance.
  

yeAngleTolerance

Specifies the angle tolerance value between WCD point vector and gradient vector.

Default value: 8.0

Valid value range: 1.0 to 15.0

For more details, refer to the note given for yeSpecTolerance.

t

Returns t if the options are specified.

nil

Returns nil otherwise

t_iymethod

The yield improvement method to be used. The default value is all. The possible values are global, mismatch and all.

t_refPoint

Specifies whether to use a schematic point or a reference point that you have created as a starting place for sizing.

Possible values are 0 and 1. The default value is 0.

t_algorithm

The default value is 0. The possible values are 0 and 1.

t_timeLimit

Sets a time limit for the improve yield run.

The default value is "". The timeLimit is in minutes.

t_iterations

Specifies the number of sizing/Monte Carlo iterations,

The default value is 3.

t_numPoints

Specifies the maximum number of points processed per iteration.

The default value is 3000.

t_sigmaTarget

Allows you to increase the mean of the goal distribution to target (of goal) value even after achieving 100% yield. ADE GXL allows you to achieve 4, 5, or even 6 sigma designs.

The default value is 6. The possible values are 4, 5, and 6.

t_stopIfNoImprovement

Specifies if the yield improvement run must be stopped if there is no yield improvement. The default value is 0. The possible values are 0 and 1.

t_runFullEvaluation

Sets the program to run full optimization. Default for runFullEvaluation is 0. Possible values are 0 and 1.

t_optimizationMethod

Sets the optimization method. Default for optimizationMethod is global. Possible values are global and local.

t_effort

Specifies the effort level if you are using local optimization. Default for effort is fine. Possible values are fine and coarse.

t_saveCorner

Specifies if the corner is to be saved.

t_iysamplingmethod

Sets the default statistical sampling method for improve yield runs. The default value is random. Possible values are random and lhs.

t_iymontecarlodonominal

Specifies whether to run a simulation at the reference point prior to beginning the improve yield process. Possible values are 0 and 1. If set to 1, Spectre will run a simulation at the reference point, and, if this fails, then the sampling process is not initiated and the simulation stops.

The default value is 1.

t_iymontecarloseed

Specifies a different seed for Monte Carlo runs. Default for monteCarloSeed is 12345.

t_iymcnumpoints

Sets the number of Monte Carlo points you want to simulate. The default value is nil.

t_iymontecarlostartingrun

Specifies the run that Monte Carlo begins with. The default value is 1.

t_dutSummary

Specifies a list of design under test (DUT) instances for improve yield runs. In this list, you can specify the instances and devices to which mismatch variations must be applied. The format to specify the list is as given below:

<testname%instances%Libname/Cellname/Viewname%Master#testname%instances%modelname%Subcircuit#testname%instances%Schematic%Schematic>

where two DUT instances in the list are separated by a #(hash).

For example:
“opamp090:full_diff_opamp_AC:2:1%/I21%acOpenDiff%Subcircuit#opamp090:full_diff_opamp_AC:2:1%/I0/I1%opamp090/ampn/schematic%Master#opamp090:full_diff_opamp_AC:2:1%/I0/M5A, /I0/M3A%Schematic%Schematic”

Default for dutSummary is "".