Verilog-A Functions - SIMPLIS

Maybe your like

User Manual
- Welcome
- Introduction
  - About SIMetrix/SIMPLIS Documentation
  - What is Simetrix?
  - What is SIMPLIS?
  - Why Simulate?
  - System Requirements
  - Acknowledgements
- Quick Start
  - Introduction
  - Tutorial 1 - A Simple Ready to Run Circuit
  - Tutorial 2 - A Simple SMPS Circuit
  - Tutorial 3 - Installing Third Party Models
- Getting Started
  - Getting Started
  - Simulation Modes - SIMetrix or SIMPLIS
  - Using the Schematic Editor
  - Circuit Rules
  - Analysis Modes
  - Running the Simulator
  - Plotting Simulation Results
- SIMetrix GUI Environment
  - Overview
  - Interaction
  - Directory Viewer
  - Interface Styles
- Schematic Editor
  - Fundamentals
  - Hierarchical Schematic Entry
  - Schematic Annotations
  - Schematic Styles
  - Schematic Grouping
  - Schematic Printing
  - File Operations
  - Properties
  - Template Property
  - LTspice® Compatibility
  - Netlist to Schematic Converter
  - Load Component Values
  - Using Schematic Editor for CMOS IC Design
  - Further Information
- Symbol Editor and Library
  - Creating Schematic Symbols - Overview
  - Graphical Symbol Editor
  - Creating a Symbol from a Script
  - Symbol Library Manager
- Parts
  - Parts
  - How to Find and Place Parts
  - Part Selector
  - Part Search
  - Model Library Browser
  - Numbered Parts in SIMPLIS
  - Circuit Stimulus
  - Generic Analog Parts
  - Generic Digital Parts
  - Creating Models
  - Subcircuits
  - Special Parts
  - IBIS Models
  - Parameters and Expressions
- Analog Behavioural Modelling
  - Introduction
  - Non-linear Transfer Function
  - Laplace Transfer Function
- Device Library and Parts Management
  - Device Library and Parts Management
  - Using Model Library Browser
  - Parts Management - Installing Models
  - Parts Management - Configuring the Part Selector
  - Parts Management - Advanced Topics
  - Sundry Topics
- Analysis Modes
  - Analysis Modes
  - Running Simulations
  - Transient Analysis
  - Operating Point
  - Sweep Modes
  - DC Sweep
  - AC Sweep
  - Noise Analysis
  - Real Time Noise
  - Transfer Function
  - DC Sensitivity
  - Convergence
  - Data Handling and Keeps
  - Simulator Options
  - Multi-step Analyses
  - Safe Operating Area Testing
- SIMPLIS Analysis Modes
  - SIMPLIS Analysis Modes
  - Transient Analysis
  - Periodic Operating Point (POP)
  - AC Analysis
  - SIMPLIS Options
  - Multi-step and Monte Carlo Analyses
  - Initial Condition Back-annotation
- Graphs, Probes and Data Analysis
  - Graphs, Probes and Data Analysis
  - Elements of the Graph Window
  - Probes: Fixed vs. Random
  - Fixed Probes
  - Random Probes
  - Plot Journals and Updating Curves
  - Graph Layout
  - Curve Operations
  - Graph Cursors
  - Curve Measurements
  - Efficiency Calculator
  - Graph Zooming and Scrolling
  - Annotating a Graph
  - Exporting/Importing Graphs and Data
  - Saving Graphs
  - Saving Data
  - Viewing DC Operating Point Results
  - Performance Analysis and Histograms
- The Command Shell
  - Command Line
  - Editing the Menu System
  - User Defined Toolbars and Buttons
  - Message Window
- Command and Function Reference
  - Introduction
  - Command Summary
  - Reference
  - Function Summary
  - Function Reference
- Monte Carlo, Sensitivity and Worst-case
  - Monte Carlo, Sensitivity and Worst-case Analyses
  - A Monte Carlo Example
  - Sensitivity/Worst-case Example
  - Part Tolerance Specification
  - Running Monte Carlo
  - Running Sensitivity and Worst-case
  - Analysing Monte-Carlo Results
  - Analysing Sensitivity and Worst-case Results
- Optimisation
  - Introduction
  - A First Example (SIMetrix)
  - A SIMPLIS Example
  - Curve Fitting Example (SIMetrix)
  - Running Curve Fitting Example (SIMetrix)
  - Optimiser GUI Description
  - Optimiser Algorithms
- Verilog-HDL Simulation
  - Overview
  - Documentation
  - Supported Verilog Simulators
  - Basic Operation
  - Using Verilog-HDL in SIMetrix Schematics
  - Module Cache
  - Simulation Options
  - Tutorial
  - Verilog Simulator Interface
- Sundry Topics
  - Saving and Restoring Sessions
  - Symbolic Path Names
  - SIMetrix Command Line Parameters
  - Configuration Settings
  - Options
  - Startup Auto Configuration
  - Colours and Fonts
  - Startup Script
  - International Character Sets
  - Installation and Licensing
Simulator Reference
- Introduction
  - Overview
  - The SIMetrix Simulator - What is it?
  - What is in This Manual
- Running the Simulator
  - Using the Simulator with the Schematic Editor
  - Running in non-GUI Mode
  - Configuration Settings
  - Netlist Format
  - Simulator Output
  - Data Handling - Controlling Data Saved
- Simulator Devices
  - Overview
  - Using XSPICE Devices
  - Using Expressions
  - Subcircuits
  - Model Binning
  - Language Differences
  - Customising Device Configuration
  - Initial Conditions
- Analog Device Reference
  - Overview
  - Further Documentation
  - ASM HEMT Gallium Nitride FET Model
  - AC Table Lookup (including S-Parameters)
  - Arbitrary Source
  - Bipolar Junction Transistor (SPICE Gummel Poon)
  - Bipolar Junction Transistor ( VBIC without self heating)
  - Bipolar Junction Transistor (VBIC with self heating)
  - Bipolar Junction Transistor (MEXTRAM)
  - Bipolar Junction Transistor (HICUM)
  - Capacitor
  - Current Controlled Current Source
  - Current Controlled Switch
  - Current Controlled Voltage Source
  - Current Source
  - Diode - Level 1 and Level 3
  - Diode - Soft Recovery
  - Diode CMC
  - Diode - Perfect
  - Inductor (Ideal)
  - Inductor (Saturable)
  - Inductor (Table lookup)
  - Insulated Gate Bipolar Transistor
  - Junction FET
  - Laplace Transfer Function - Lumped Implementation
  - Laplace Transfer Function - Convolution Implementation
  - Lossy Transmission Line
  - MOSFET
  - BSIM3 MOSFETs
  - BSIM4 MOSFETs
  - BSIM-BULK MOSFET (formerly BSIM6)
  - BSIM-CMG MOSFET (FinFET)
  - HiSim HV MOSFET
  - PSP MOSFET
  - MOSFET GMIN Implementation
  - Resistor
  - Resistor - Hspice Compatible
  - CMC Resistor
  - Subcircuit Instance
  - Transmission Line
  - Voltage Controlled Current Source
  - Voltage Controlled Switch
  - Voltage Controlled Switch - Perfect
  - Voltage Controlled Voltage Source
  - Voltage Source
  - Mutual Inductor
  - Verilog-HDL Interface (VSXA)
  - NXP Compact Models
  - LTspice® Devices
- Digital/Mixed Signal Device Reference
  - Device List
  - Digital Device Overview
  - Gates
  - Flip-Flops and Latches
  - Sources
  - Mixed Signal
  - Functions
- Command Reference
  - Overview
  - General Sweep Specification
  - Multi Step Analyses
  - .AC
  - .ALIAS
  - .DATA
  - .DC
  - .FILE and .ENDF
  - .FUNC
  - .GLOBAL
  - .GRAPH
  - .IC
  - .INC
  - .KEEP
  - .LOAD
  - .LIB
  - .MAP
  - .MODEL
  - .NOCONV
  - .NODESET
  - .NOISE
  - .OP
  - .OPTIMISER
  - .OPTIONS
  - .OPTSPEC
  - Notes
  - .PARAM
  - .POST_PROCESS
  - .PRINT
  - .PROBE
  - .SENS
  - .SETSOA
  - .STEP
  - .SUBCKT and .ENDS
  - .TEMP
  - .TF
  - .TRACE
  - .TRAN
  - .VAR
  - .VECALIAS
  - Real Time Noise Analysis
- Monte Carlo, Sensitivity and Worst-case
  - Overview
  - Monte Carlo Analysis
  - Sensitivity and Worst-case Analyses
  - Specifying Tolerances
- Optimisation
  - Introduction
  - Optimiser Modes
  - Algorithms
- Convergence, Accuracy and Performance
  - Overview
  - DC Operating Point
  - Transient Analysis
  - DC Sweep
  - DC Operating Point Algorithms
  - Singular Matrix Errors
  - Transient Analysis - `Time step too small' Error
  - Accuracy and Integration Methods
  - Using Multiple Core Systems
  - Matrix Solver
- Digital Simulation
  - Overview
  - Logic States
  - Analog to Digital Interfaces
  - Load Delay
  - Digital Model Libraries
  - Arbitrary Logic Block - User Defined Models
  - Mixed-mode Simulator - How it Works
  - Enhancements over XSPICE
SIMetrix Script Manual
- Introduction
- The SIMetrix Script Language
  - A Tutorial
  - Variables, Constants and Types
  - Expressions
  - Statements and Commands
  - Accessing Simulation Data
  - User Interface to Scripts
  - Errors
  - Executing Scripts
  - Unsupported Functions and Commands
- Function Summary
  - Functions by Application
  - abs Function
  - acos Function
  - acosh Function
  - ACSourceDialog Function
  - ACSourceDialogStr Function
  - AddConfigCollection Function
  - AddGraphCrossHair Function
  - AddModelFiles Function
  - AddPropertyDialog Function
  - AddRemoveDialog Function
  - AddRemoveDialogNew Function
  - AddSymbolFiles Function
  - AppendSensitivityData Function
  - area Function
  - arg Function
  - arg_rad Function
  - Ascii Function
  - asin Function
  - asinh Function
  - AssociateModel Function
  - atan Function
  - atan2 Function
  - atan2_deg Function
  - atan_deg Function
  - atanh Function
  - avg Function
  - BoolSelect Function
  - Branch Function
  - BuildMclogHTML Function
  - BuildParameterString Function
  - BuildSensitivityCsv Function
  - BuildSensitivityHTML Function
  - BuildWorstCaseHTML Function
  - CanOpenFile Function
  - ChangeDir Function
  - Char Function
  - CheckLaplaceExpression Function
  - ChooseDir Function
  - ChooseDirectory Function
  - Chr Function
  - CleanPath Function
  - CloseEchoFile Function
  - CloseFile Function
  - CloseSchematic Function
  - CloseSchematicTab Function
  - Coll Function
  - CollateNested Function
  - CollateVectors Function
  - CommandStatus Function
  - CompareSymbols Function
  - ComposeDigital Function
  - ConvertFromBase64 Function
  - ConvertHTMLcolourToRGB Function
  - ConvertIsoTimeToUnix Function
  - ConvertLocalToUnix Function
  - ConvertNumberFromBase64 Function
  - ConvertNumberToBase64 Function
  - ConvertRGBcolourToHTML Function
  - ConvertSchematicFormat Function
  - ConvertToBase64 Function
  - ConvertUnixTimeToIso Function
  - ConvertUnixToLocal Function
  - CopyDivisionData Function
  - CopyTree Function
  - CopyURL Function
  - cos Function
  - cos_deg Function
  - cosh Function
  - CountChars Function
  - CreateDiodeDialog Function
  - CreateGraphMeasurement Function
  - CreateLockFile Function
  - CreateMutex Function
  - CreateNewTitleBlockDialog Function
  - CreateSharedAxisConnector Function
  - CreateShortcut Function
  - CreateTimer Function
  - CurveEditDialog Function
  - CurveFit Function
  - CurveFitLog Function
  - CurveFitLogX Function
  - CurveFitLogY Function
  - cv Function
  - CyclePeriod Function
  - Date Function
  - db Function
  - DCSourceDialog Function
  - DCSourceDialogStr Function
  - DefineADCDialog Function
  - DefineArbSourceDialog Function
  - DefineBusPlotDialog Function
  - DefineCounterDialog Function
  - DefineCurveDialog Function
  - DefineDACDialog Function
  - DefineFourierDialog Function
  - DefineFourierProbeDialog Function
  - DefineIdealTxDialog Function
  - DefineLaplaceDialog Function
  - DefineLogicGateDialog Function
  - DefinePerfAnalysisDialog Function
  - DefineRegisterDialog Function
  - DefineRipperDialog Function
  - DefineSaturableTxDialog Function
  - DefineShiftRegDialog Function
  - DefineSimplisMultiStepDialog Function
  - DeleteConfigCollection Function
  - DeleteTimer Function
  - DeleteTouchstone Function
  - DeleteTree Function
  - DeleteTreeProgress Function
  - DelSchemProp Function
  - DescendDirectories Function
  - DescendHierarchy Function
  - DestroyMutex Function
  - DialogDesigner Function
  - diff Function
  - DirectoryIsWriteable Function
  - Distribution Function
  - EditArcDialog Function
  - EditAxisDialog Function
  - EditBodePlotProbeDialog Function
  - EditBodePlotProbeDialog2 Function
  - EditCrosshairDimensionDialog Function
  - EditCurveMarkerDialog Function
  - EditDeviceDialog Function
  - EditDigInitDialog Function
  - EditFileDefinedPWLDialog Function
  - EditFreeTextDialog Function
  - EditGraphMeasurement Function
  - EditGraphTextBoxDialog Function
  - EditJumperDialog Function
  - EditLegendBoxDialog Function
  - EditObjectPropertiesDialog Function
  - EditPinDialog Function
  - EditPotDialog Function
  - EditProbeDialog Function
  - EditPropertyDialog Function
  - EditReactiveDialog Function
  - EditSelect Function
  - EditSimplisLaplaceFilterDialog Function
  - EditSimplisMosfetDriverDialog Function
  - EditStylesDialog Function
  - EditSymbolBusDialog Function
  - EditTimer Function
  - EditWaveformDialog Function
  - EditWaveformStrDialog Function
  - ElementProps Function
  - EncodeImageToBase64 Function
  - EnterTextDialog Function
  - EpochTime Function
  - erf Function
  - erfc Function
  - EscapeString Function
  - EscapeStringEncode Function
  - ev Function
  - Execute Function
  - ExistCommand Function
  - ExistDir Function
  - ExistFile Function
  - ExistFunction Function
  - ExistSymbol Function
  - ExistVec Function
  - exp Function
  - fd Function
  - fft Function
  - Field Function
  - FileToString Function
  - FilterEditMenu Function
  - FilterFile Function
  - FilterNested Function
  - FinalDivision Function
  - FindGraphMeasurement Function
  - FindModel Function
  - FIR Function
  - Floor Function
  - floorv Function
  - FormatNumber Function
  - Fourier Function
  - FourierOptionsDialog Function
  - FourierWindow Function
  - FullPath Function
  - gamma Function
  - Gauss Function
  - GaussLim Function
  - GaussTrunc Function
  - GenPrintDialog Function
  - GetActualPath Function
  - GetAllAxes Function
  - GetAllCurves Function
  - GetAllSimulatorDevices Function
  - GetAllSymbolPropertyNames Function
  - GetAllXAxes Function
  - GetAllYAxes Function
  - GetAnalysisInfo Function
  - GetAnalysisLines Function
  - GetAnnotationText Function
  - GetAxisCurves Function
  - GetAxisLimits Function
  - GetAxisType Function
  - GetAxisUnits Function
  - GetChildModulePorts Function
  - GetCodecNames Function
  - GetColours Function
  - GetColourSpec Function
  - GetCompatiblePathName Function
  - GetComponentValue Function
  - GetConfigLoc Function
  - GetConnectedPins Function
  - GetConvergenceDevNames Function
  - GetConvergenceInfo Function
  - GetConvergenceNodeNames Function
  - GetCurDir Function
  - GetCurrentGraph Function
  - GetCurrentStepValue Function
  - GetCursorCurve Function
  - GetCurveAxes Function
  - GetCurveAxis Function
  - GetCurveCreationIds Function
  - GetCurveName Function
  - GetCurves Function
  - GetCurveVector Function
  - GetDatumCurve Function
  - GetDeviceDefinition Function
  - GetDeviceInfo Function
  - GetDeviceParameterNames Function
  - GetDevicePins Function
  - GetDeviceStats Function
  - GetDisabledInstances Function
  - GetDivisionLabels Function
  - GetDotParamNames Function
  - GetDotParamValue Function
  - GetDriveType Function
  - GetEnvVar Function
  - GetEthernetAddresses Function
  - GetF11Lines Function
  - GetFailedNodesFromIterNum Function
  - GetFile Function
  - GetFileCD Function
  - GetFileDir Function
  - GetFileExtensions Function
  - GetFileInfo Function
  - GetFileProductName Function
  - GetFileSave Function
  - GetFileVersionStamp Function
  - GetFileViewerSelectedDirectories Function
  - GetFileViewerSelectedFiles Function
  - GetFirstSelectedElementOfType Function
  - GetFonts Function
  - GetFontSpec Function
  - GetFreeDiskSpace Function
  - GetGraphFromWindow Function
  - GetGraphObjects Function
  - GetGraphObjectsWithProperty Function
  - GetGraphObjPropNames Function
  - GetGraphObjPropValue Function
  - GetGraphObjPropValues Function
  - GetGraphTabs Function
  - GetGraphTitle Function
  - GetGridAxes Function
  - GetGridCurves Function
  - GetGroupAnalysisInfo Function
  - GetGroupFromAnalysisId Function
  - GetGroupInfo Function
  - GetGroupStepParameter Function
  - GetGroupStepVals Function
  - GetGUID Function
  - GetHighlightedWidgetId Function
  - GetHostId Function
  - GetHttpContentSize Function
  - GetInstanceBounds Function
  - GetInstanceConvergenceInfo Function
  - GetInstanceParamValues Function
  - GetInstancePinLocs Function
  - GetInstsAtPoint Function
  - GetInternalDeviceName Function
  - GetKeyDefs Function
  - GetKnownFolderPath Function
  - GetLaplaceErrorMessage Function
  - GetLastCommand Function
  - GetLastError Function
  - GetLastGraphObjectAdded Function
  - GetLegendProperties Function
  - GetLibraryModels Function
  - GetLicenseInfo Function
  - GetLicenseStats Function
  - GetLine Function
  - GetListSelected Function
  - GetListUnselected Function
  - GetLongPathName Function
  - GetMaxCores Function
  - GetMD5 Function
  - GetMD5String Function
  - GetMenuItems Function
  - GetModelFiles Function
  - GetModelLibraryErrors Function
  - GetModelName Function
  - GetModelParameterNames Function
  - GetModelParameters Function
  - GetModelParameterValues Function
  - GetModelType Function
  - GetModifiedStatus Function
  - GetNamedSymbolPins Function
  - GetNamedSymbolPropNames Function
  - GetNamedSymbolPropValue Function
  - GetNearestNet Function
  - GetNextDefaultStyleName Function
  - GetNodeConvergenceInfo Function
  - GetNodeNames Function
  - GetNonDefaultOptions Function
  - GetNumCurves Function
  - GetOpenSchematics Function
  - GetOption Function
  - GetPath Function
  - GetPlatformFeatures Function
  - GetPrinterInfo Function
  - GetPrintValues Function
  - GetReadOnlyStatus Function
  - GetRegistryClassesRootKeys Function
  - GetSchematicFileVersion Function
  - GetSchematicTabs Function
  - GetSchematicVersion Function
  - GetSchemTitle Function
  - GetSelectedAnnotationText Function
  - GetSelectedCurves Function
  - GetSelectedGraphAnno Function
  - GetSelectedGraphAnnotations Function
  - GetSelectedGrid Function
  - GetSelectedStyleNames Function
  - GetSelectedXAxis Function
  - GetSelectedYAxis Function
  - GetShortPathName Function
  - GetSimConfigLoc Function
  - GetSimetrixFile Function
  - GetSIMPLISExitCode Function
  - GetSimulationErrors Function
  - GetSimulationInfo Function
  - GetSimulationSeeds Function
  - GetSimulatorEvents Function
  - GetSimulatorMode Function
  - GetSimulatorOption Function
  - GetSimulatorOptionInfo Function
  - GetSimulatorOptions Function
  - GetSimulatorStats Function
  - GetSimulatorStatus Function
  - GetSoaDefinitions Function
  - GetSoaMaxMinResults Function
  - GetSoaOverloadResults Function
  - GetSoaResults Function
  - GetSymbolArcInfo Function
  - GetSymbolFiles Function
  - GetSymbolInfo Function
  - GetSymbolOrigin Function
  - GetSymbolPropertyInfo Function
  - GetSymbolPropertyNames Function
  - GetSymbols Function
  - GetSystemInfo Function
  - GetTempFile Function
  - GetTextEditorText Function
  - GetThreadTimes Function
  - GetTimerInfo Function
  - GetTitleBlockInfo Function
  - GetToolBarDefinition Function
  - GetToolButtons Function
  - GetTouchstoneErrors Function
  - GetUncPath Function
  - GetURLFromLocalPath Function
  - GetUsedStyles Function
  - GetUserFile Function
  - GetVecStepParameter Function
  - GetVecStepVals Function
  - GetWidgetInfo Function
  - GetXAxis Function
  - GraphImageCapture Function
  - GraphImageParameter Function
  - GraphLimits Function
  - GroupDelay Function
  - Groups Function
  - GuiType Function
  - Hash Function
  - HashAdd Function
  - HashCreate Function
  - HashDelete Function
  - HashKeys Function
  - HashRemove Function
  - HashSearch Function
  - HasLogSpacing Function
  - HasProperty Function
  - HaveFeature Function
  - HaveInternalClipboardData Function
  - HierarchyHighlighting Function
  - HighlightedNets Function
  - Histogram Function
  - HistoryDepthDialog Function
  - Iff Function
  - IffV Function
  - IIR Function
  - im Function
  - imag Function
  - InitRandom Function
  - InputGraph Function
  - InputSchem Function
  - Instances Function
  - InstNets Function
  - InstNets2 Function
  - InstPins Function
  - InstPoints Function
  - InstProps Function
  - integ Function
  - Interp Function
  - IsComplex Function
  - IsComponent Function
  - IsDocumented Function
  - IsFileOfType Function
  - IsFullPath Function
  - IsImageFile Function
  - IsModelFile Function
  - IsNum Function
  - IsOptionMigrateable Function
  - IsSameFile Function
  - IsScript Function
  - IsStr Function
  - IsTextEditor Function
  - IsTextEditorModified Function
  - Jitter Function
  - Join Function
  - JoinStringArray Function
  - JoinVectors Function
  - length Function
  - ListDirectory Function
  - ListSchemProps Function
  - ln Function
  - LoadFile Function
  - LoadSensitivityReport Function
  - LoadTouchstone Function
  - Locate Function
  - log Function
  - log10 Function
  - LPF Function
  - mag Function
  - magnitude Function
  - makecomplexvec Function
  - MakeDir Function
  - MakeLogicalPath Function
  - MakeString Function
  - makevec Function
  - ManageDataGroupsDialog Function
  - ManageMeasureDialog Function
  - MapArray Function
  - max Function
  - maxidx Function
  - Maxima Function
  - Maximum Function
  - MaxN Function
  - mean Function
  - Mean1 Function
  - MeasureDialog Function
  - MessageBox Function
  - Mid Function
  - min Function
  - minidx Function
  - Minima Function
  - Minimum Function
  - MinN Function
  - MkVec Function
  - MLRidgeRegressionFit Function
  - MLSplineFit Function
  - MLVector Function
  - ModelLibsChanged Function
  - MSWReadHeader Function
  - Navigate Function
  - NearestInst Function
  - NetName Function
  - NetNames Function
  - NetToCirc Function
  - NetWires Function
  - NewPassiveDialog Function
  - NewValueDialog Function
  - norm Function
  - NumberSelectedAnnotations Function
  - NumDivisions Function
  - NumElems Function
  - OpenEchoFile Function
  - OpenFile Function
  - OpenPDFPrinter Function
  - OpenPrinter Function
  - OpenSchem Function
  - OpenSchematic Function
  - OptimiserAnalysisLine Function
  - OptimiserApplyFailedRun Function
  - OptimiserApplySpecification Function
  - OptimiserCloseDef Function
  - OptimiserCreateFromXML Function
  - OptimiserCreateFromXMLString Function
  - OptimiserErrorMessage Function
  - OptimiserFinish Function
  - OptimiserGetDataObject Function
  - OptimiserGetDataObjectNames Function
  - OptimiserGetInfo Function
  - OptimiserGetIteration Function
  - OptimiserGetOptions Function
  - OptimiserGetParameters Function
  - OptimiserGetParameterValues Function
  - OptimiserGetSpecification Function
  - OptimiserLoadWidgetFromXML Function
  - OptimiserParameterLine Function
  - OptimiserResults Function
  - OptimiserRunning Function
  - OptimiserSimulatorGetDef Function
  - OptimiserSimulatorGetInfo Function
  - OptimiserSimulatorResults Function
  - OptimiserSimulatorStatus Function
  - OptimiserSimulatorUserMessage Function
  - OptimiserSimulatorWriteXMLString Function
  - OptimiserStart Function
  - OptimiserStatus Function
  - OptimiserSuccess Function
  - OptimiserUserMessage Function
  - OptimiserWidgetCreateOptDef Function
  - OptimiserWidgetGetDataObject Function
  - OptimiserWidgetGetDataObjectNames Function
  - OptimiserWidgetGetInfo Function
  - OptimiserWidgetPreFlightChecks Function
  - OptimiserWidgetWriteCommandFile Function
  - OptimiserWidgetWriteXML Function
  - OptimiserWidgetWriteXMLString Function
  - OptimiserWriteCommandFile Function
  - OptimiserWriteHTMLReport Function
  - OptimiserWriteXML Function
  - OptimiserWriteXMLString Function
  - Parse Function
  - ParseAnalysis Function
  - ParseEscape Function
  - ParseLaplace Function
  - ParseParameterString Function
  - ParseParameterString2 Function
  - ParseProbeExpression Function
  - ParseSIMPLISInit Function
  - ParseSpiceLines Function
  - PathEqual Function
  - PerCycleTiming Function
  - PerCycleValue Function
  - ph Function
  - phase Function
  - phase_rad Function
  - PhysType Function
  - PinName Function
  - PrepareSetComponentValue Function
  - PreProcessNetlist Function
  - Probe Function
  - ProcessingAccelerator Function
  - ProcessingDragAndDrop Function
  - ProcessingGuiAction Function
  - Progress Function
  - PropFlags Function
  - PropFlags2 Function
  - PropFlagsAll Function
  - PropFlagsAnnotations Function
  - PropFlagsWires Function
  - PropOverrideStyle Function
  - PropValue Function
  - PropValues Function
  - PropValues2 Function
  - PropValuesAll Function
  - PropValuesAnnotations Function
  - PropValuesWires Function
  - PutEnvVar Function
  - PWLCurveFit Function
  - PWLDialog Function
  - QueryData Function
  - RadioSelect Function
  - Range Function
  - re Function
  - ReadClipboard Function
  - ReadConfigCollection Function
  - ReadConfigSetting Function
  - ReadF11Analyses Function
  - ReadF11Options Function
  - ReadFile Function
  - ReadIniKey Function
  - ReadRegSetting Function
  - ReadSchemProp Function
  - ReadSIMPLISF11Data Function
  - ReadSpiceFile Function
  - ReadTextEditorProp Function
  - ReadTouchstone Function
  - real Function
  - Ref Function
  - RefName Function
  - RegExContains Function
  - RegExIsValid Function
  - RegExMatch Function
  - RegExp Function
  - RegExReplace Function
  - RegExSearch Function
  - RegExSearchAll Function
  - RegExSplit Function
  - RegExStrStr Function
  - RelativePath Function
  - RemapDevice Function
  - RemoveConfigCollection Function
  - RemoveModelFile Function
  - RemoveSymbolFiles Function
  - ResolveGraphTemplate Function
  - ResolveTemplate Function
  - RestartTranDialog Function
  - Rms Function
  - RMS1 Function
  - RMS1_AC Function
  - rnd Function
  - RootSumOfSquares Function
  - rt Function
  - SaveSpecialDialog Function
  - Scan Function
  - ScanEscape Function
  - ScriptName Function
  - Search Function
  - SearchDialog Function
  - SearchModels Function
  - Seconds Function
  - Select2Dialog Function
  - SelectAnalysis Function
  - SelectColourDialog Function
  - SelectColumns Function
  - SelectCount Function
  - SelectDevice Function
  - SelectDialog Function
  - SelectedProperties Function
  - SelectedStyleInfo Function
  - SelectedWires Function
  - SelectFontDialog Function
  - SelectRows Function
  - SelectSIMPLISAnalysis Function
  - SelectSymbolDialog Function
  - SelGraph Function
  - SelSchem Function
  - SetComponentValue Function
  - SetDifference Function
  - SetInstanceParamValue Function
  - SetIntersect Function
  - SetModelParamValue Function
  - SetPropertyStyles Function
  - SetReadOnlyStatus Function
  - SetSymmetricDifference Function
  - SetUnion Function
  - Shell Function
  - ShellExecute Function
  - ShiftRef Function
  - sign Function
  - SimetrixFileInfo Function
  - SIMPLISRunStatus Function
  - SIMPLISSearchIdx Function
  - SimulationHasErrors Function
  - sin Function
  - sin_deg Function
  - sinh Function
  - Sleep Function
  - Sort Function
  - SortIdx Function
  - SortIdx2 Function
  - SourceDialog Function
  - Spectrum Function
  - SpectrumUniv Function
  - SplitPath Function
  - SplitString Function
  - SprintfNumber Function
  - sqrt Function
  - Str Function
  - StringLength Function
  - StringStartsWith Function
  - StripRef Function
  - StrStr Function
  - StyleInfo Function
  - StyleLineTypes Function
  - StyleNames Function
  - SubstChar Function
  - SubstProbeExpression Function
  - SubstString Function
  - sum Function
  - SumNoise Function
  - SupportedReadFormats Function
  - SupportedWriteFormats Function
  - SxUUID Function
  - SymbolInfoDialog Function
  - SymbolLibraryManagerDialog Function
  - SymbolName Function
  - SymbolNames Function
  - SymbolPinOrder Function
  - SymbolPinPoints Function
  - SystemValue Function
  - SystemValuePath Function
  - SystemWidgetExistsInSelectedWindow Function
  - TableDialog Function
  - TableEditor Function
  - tan Function
  - tan_deg Function
  - tanh Function
  - TemplateGetPropValue Function
  - TemplateResolve Function
  - TextEditorHasComments Function
  - ThdWeight Function
  - TickCount Function
  - Time Function
  - ToLower Function
  - ToUpper Function
  - TranslateLogicalPath Function
  - TreeListDialog Function
  - True Function
  - Truncate Function
  - TwoFileSelectionDialog Function
  - UD Function
  - UngroupCurve Function
  - Unif Function
  - Units Function
  - UnitsNew Function
  - unitvec Function
  - UpDownDialog Function
  - UserParametersDialog Function
  - Val Function
  - ValueDialog Function
  - Vec Function
  - vector Function
  - VectorsInGroup Function
  - VersionInfo Function
  - ViewFormattedFile Function
  - ViewFormattedText Function
  - WAV_CloseFile Function
  - WAV_OpenFile Function
  - WAV_ReadData Function
  - WAV_WriteFile Function
  - WC Function
  - WC2 Function
  - WirePoints Function
  - Wires Function
  - WM_CanRevertToSaved Function
  - WM_GetAllVisibleContentWidgetNames Function
  - WM_GetCentralWidgetGeometry Function
  - WM_GetContentWidgetNames Function
  - WM_GetContentWidgetSessionInfo Function
  - WM_GetContentWidgetsLayout Function
  - WM_GetContentWidgetsOfType Function
  - WM_GetContentWidgetTypes Function
  - WM_GetCurrentWidgetInfo Function
  - WM_GetCurrentWindowName Function
  - WM_GetLastAccessedContentWidget Function
  - WM_GetNumberModifiedEditors Function
  - WM_GetPrimaryWindowName Function
  - WM_GetSystemWidgetSessionInfo Function
  - WM_GetSystemWidgetsLayout Function
  - WM_GetWidgetInstanceInfo Function
  - WM_GetWindowGeometry Function
  - WM_GetWindowNames Function
  - WM_NumberContentWidgets Function
  - WM_NumberSystemWidgets Function
  - WriteConfigSetting Function
  - WriteF11Lines Function
  - WriteF11Options Function
  - WriteIniKey Function
  - WriteRawData Function
  - WriteRegSetting Function
  - WriteSchemProp Function
  - XCursor Function
  - XDatum Function
  - XFromY Function
  - XMLCountElements Function
  - XMLGetAttribute Function
  - XMLGetElements Function
  - XMLGetText Function
  - XMLSchematic Function
  - XMLSchematicFile Function
  - XMLSchematicFromWindow Function
  - XMLToString Function
  - XY Function
  - XYOrdered Function
  - YCursor Function
  - YDatum Function
  - YFromX Function
- Command Summary
  - Abort Command
  - AbortSIMPLIS Command
  - About Command
  - AddAnnotationText Command
  - AddArc Command
  - AddCirc Command
  - AddCurveData Command
  - AddCurveMarker Command
  - AddDoubleClickAction Command
  - AddFileViewMenuItem Command
  - AddFloodFill Command
  - AddFreeText Command
  - AddGlobalStyle Command
  - AddImage Command
  - AddImageScript Command
  - AddLegend Command
  - AddLegendProp Command
  - AddPin Command
  - AddProp Command
  - AddProperty Command
  - AddSeg Command
  - AddSymbolProperty Command
  - AddTextBox Command
  - AddTitleBlock Command
  - AlignText Command
  - Anno Command
  - AppendGroup Command
  - AppendTextWindow Command
  - Arguments Command
  - Cancel Command
  - CaptureWaveformImage Command
  - Cd Command
  - ChangeArcAttributes Command
  - ChangeSelectedStyleNames Command
  - ChangeStyle Command
  - ChangeSymbolProperty Command
  - ClearMessageWindow Command
  - Close Command
  - CloseGraphSheet Command
  - CloseLinkedRun Command
  - ClosePrinter Command
  - CloseSchem Command
  - CloseSheet Command
  - CloseSimplisStatusBox Command
  - CloseTextEditor Command
  - CollectGarbage Command
  - CombineMenu Command
  - CompareSymbolLibs Command
  - ConvertBinaryGraph Command
  - Copy Command
  - CopyClipGraph Command
  - CopyClipSchem Command
  - CopyFile Command
  - CopyLocalSymbol Command
  - CreateFont Command
  - CreateGroup Command
  - CreateRunningDialog Command
  - CreateSym Command
  - CreateToolBar Command
  - CreateToolButton Command
  - CursorMode Command
  - Curve Command
  - CurveEditCopy Command
  - DefButton Command
  - DefineToolBar Command
  - DefKey Command
  - DefMenu Command
  - Del Command
  - DelCrv Command
  - Delete Command
  - DeleteAxis Command
  - DeleteGlobalStyle Command
  - DeleteGraphAnno Command
  - DeleteGraphObject Command
  - DeleteShortWires Command
  - DeleteSymbolProperty Command
  - DeleteToolBar Command
  - DelGroup Command
  - DelLegendProp Command
  - DelMenu Command
  - DelProp Command
  - DelSym Command
  - DestroyRunningDialog Command
  - Detach Command
  - Discard Command
  - Display Command
  - DrawArc Command
  - DrawArrow Command
  - DrawPin Command
  - Echo Command
  - EditColour Command
  - EditCopy Command
  - EditCut Command
  - EditFile Command
  - EditFont Command
  - EditGroupTitle Command
  - EditPaste Command
  - EditPin Command
  - EndAllInteractions Command
  - EndSym Command
  - Execute Command
  - FileViewCleanUpFileWatchers Command
  - FloodFillSymbol Command
  - Focus Command
  - FocusCommandShell Command
  - FocusShell Command
  - GroupSelected Command
  - Help Command
  - HideCurve Command
  - HighlightCurve Command
  - HighlightWidget Command
  - Hint Command
  - HourGlass Command
  - ImportSymbol Command
  - Inst Command
  - KeepGroup Command
  - Let Command
  - Listing Command
  - ListModels Command
  - ListOptions Command
  - LoadModelIndex Command
  - LoadSimulatorStyleSheet Command
  - LoadStyleSheet Command
  - LocalDeclAll Command
  - MakeAlias Command
  - MakeCatalog Command
  - MakeSymbolScript Command
  - MakeTree Command
  - MCD Command
  - MD Command
  - Message Command
  - MessageBox Command
  - Move Command
  - MoveCurve Command
  - MoveFile Command
  - MoveMenu Command
  - MoveProperty Command
  - Netlist Command
  - NewAnnotation Command
  - NewAxis Command
  - NewBasicTextEditor Command
  - NewFileView Command
  - NewGraphWindow Command
  - NewGrid Command
  - NewLabel Command
  - NewLogicDefinitionEditor Command
  - NewNetlist Command
  - NewPartSelector Command
  - NewPlot Command
  - NewPrinterPage Command
  - NewSchem Command
  - NewScript Command
  - NewStyle Command
  - NewSymbol Command
  - NewVerilogA Command
  - NewVerilogHDL Command
  - NoPaint Command
  - NoUndo Command
  - OpenAsciiFile Command
  - OpenBasicTextEditor Command
  - OpenDirectory Command
  - OpenExternalFile Command
  - OpenGraph Command
  - OpenGroup Command
  - OpenLinkedRun Command
  - OpenLogicDefinitionEditor Command
  - OpenNetlist Command
  - OpenPrinter Command
  - OpenRawFile Command
  - OpenSchem Command
  - OpenScript Command
  - OpenSimplisStatusBox Command
  - OpenVerilogA Command
  - OpenVerilogHDL Command
  - OpenWebPage Command
  - OptimiserCreate Command
  - OptimiserRequestFinish Command
  - OptionsDialog Command
  - Pan Command
  - PasteGraphImageToSchematic Command
  - Pause Command
  - PlaceCursor Command
  - Plot Command
  - PreProcessNetlist Command
  - PrintGraph Command
  - PrintSchematic Command
  - Probe Command
  - Prop Command
  - Protect Command
  - Quit Command
  - RD Command
  - ReadLogicCompatibility Command
  - RebuildSymbols Command
  - Redirect Command
  - RedirectMessages Command
  - Redo Command
  - RedrawGraph Command
  - RegisterUserFunction Command
  - RenameLibs Command
  - RenameMenu Command
  - RepeatLastMenu Command
  - ReplayTraces Command
  - Reset Command
  - ResizeWindow Command
  - RestoreCommandShell Command
  - RestoreDefaultStyles Command
  - Resume Command
  - RotInst Command
  - Run Command
  - RunAsync Command
  - RunCurrentScript Command
  - RunSIMPLIS Command
  - Save Command
  - SaveAs Command
  - SaveGraph Command
  - SaveGroup Command
  - SaveRhs Command
  - SaveSnapShot Command
  - SaveSymbol Command
  - SaveSymlib Command
  - SaveTextEditor Command
  - SaveTextEditorAs Command
  - SchematicEnableFileWatcher Command
  - SchematicFileWatcherIgnoreChanges Command
  - SchematicFileWatcherWatchChanges Command
  - ScreenShotWindow Command
  - ScriptAbort Command
  - ScriptPause Command
  - ScriptResume Command
  - ScriptStep Command
  - Select Command
  - SelectCurve Command
  - SelectGraph Command
  - SelectLegends Command
  - SelectSchematic Command
  - SelectSimulator Command
  - SelectSymbolPin Command
  - SelectSystemWidget Command
  - SelectWireConnected Command
  - Set Command
  - SetAnnotationTextPosition Command
  - SetCurveName Command
  - SetDefaultEncoding Command
  - SetDisable Command
  - SetGraphAnnoProperty Command
  - SetGroup Command
  - SetHighlight Command
  - SetOrigin Command
  - SetPinPrefix Command
  - SetPinSuffix Command
  - SetReadOnly Command
  - SetRef Command
  - SetSnapGrid Command
  - SetStyleColour Command
  - SetSymbolFillStyle Command
  - SetSymbolOriginVisibility Command
  - SetUnits Command
  - Shell Command
  - ShellOld Command
  - Show Command
  - ShowCurve Command
  - ShowSimulatorWindow Command
  - SizeGraph Command
  - SwitchModelSection Command
  - TemplateEditProperty Command
  - TemplateSetValue Command
  - TextEditorCommentLines Command
  - TextEditorFileWatcherIgnoreChanges Command
  - TextEditorFileWatcherWatchChanges Command
  - TextEditorFind Command
  - TextEditorFindNext Command
  - TextEditorGoToLine Command
  - TextEditorUncommentLines Command
  - TextWin Command
  - Title Command
  - TitleSchem Command
  - Trace Command
  - Undo Command
  - UndoGraphZoom Command
  - UngroupSelected Command
  - UnHighlightCurves Command
  - UnLet Command
  - Unprotect Command
  - Unselect Command
  - UnSet Command
  - Unzip Command
  - UpdateAllSymbols Command
  - UpdateAnnotationText Command
  - UpdateDefaultStyle Command
  - UpdateGlobalStyle Command
  - UpdateGraphColours Command
  - UpdateProperties Command
  - UpdateRunningDialog Command
  - UpdateStyleInfo Command
  - UpdateSymbol Command
  - UpdateSystemStyleInfo Command
  - UpdateTitleBlock Command
  - UseGlobalStyles Command
  - ViewFile Command
  - WebOpen Command
  - Wire Command
  - WireMode Command
  - WM_CloseAllSystemWidgets Command
  - WM_CloseNonPrimaryWindows Command
  - WM_CloseSheet Command
  - WM_ProgressWindowClose Command
  - WM_ProgressWindowCloseAll Command
  - WM_ProgressWindowCreate Command
  - WM_ProgressWindowReport Command
  - WM_RevertToSaved Command
  - WM_Undock Command
  - WriteImportedModels Command
  - XMLAddAttribute Command
  - XMLAddElement Command
  - XMLClose Command
  - XMLGoUpLevel Command
  - XMLNew Command
  - XMLOpenElement Command
  - XMLOpenFile Command
  - XMLSaveFile Command
  - Zip Command
  - Zoom Command
- Applications
  - User Interface
  - Custom Curve Analysis
  - Automating Simulations
  - Optimiser
  - Schematic Symbol Script Definition
  - Data Import and Export
  - Graph Objects
  - Event Scripts
  - User Defined Script Based Functions
  - User Defined Binary Functions
  - Non-interactive and Customised Printing
  - Schematic Template Scripts
  - Creating and Modifying Toolbars
  - Custom Dialog Boxes
  - Pre-defined Buttons
Verilog A Reference
- Introduction
  - What Is Verilog-A?
  - Verilog-A Language Reference Manual
- Using Verilog-A Compiler
  - Using Verilog-A with SIMetrix Schematics
  - Defining Verilog-A Files in Netlist
  - Messages
  - .LOAD Full Syntax
  - Verilog-A Cache
  - Permananent .SXDEV Installation
- Writing Verilog-A Code
  - Overview
  - Verilog-A Text Editor
  - Hello World!
  - A Simple Device Model
  - A Resistor
  - A Soft Limiter
  - Hysteresis Block
  - A Capacitor
  - A Voltage Controlled Oscillator
  - Digital Elements - Overview
  - Digital Gate
  - Butterworth Filter
  - RC Ladder - Loops, Vectored Nodes and genvars
  - Indirect Assignments
  - Phase-locked Loop
- Verilog-A Reference
  - Verilog-A Reference
  - Verilog-A Functions
  - Analog Operator Restrictions
- Implementation - vs LRM
  - Overview
  - SIMetrix Verilog-A vs LRM 2.4
  - SIMetrix Extensions
  - Verilog-A Interaction with SIMetrix Features
- Debugging with Microsoft Visual Studio
  - Introduction
  - Installing Visual Studio
  - Checking Compiler
  - Manual Configuration
  - Preparation for Debug
  - Running a Debug Session
  - Recompiling after Debugging
  - Debugging Methods
  - Trademarks
SIMPLIS Reference
- Introduction
  - Overview
  - Organization of this User Manual
- Input File Organization
  - Overview
  - General Rules for the Input File
  - Organization of the Input File
- Device Statements
  - Overview
  - SIMPLIS Device Types
- Model Statements
  - Overview
  - Device Models Used in Simplis
- Subcircuit Definition
  - Overview
  - Subcircuit Definition
  - Scope of Definition
  - Scope of Definition for a Device and for a Node
  - External and Local Nodes
  - Subcircuit Calls/Instantiation
- Control Statements
  - Overview
  - Option Statements
  - Control Statements for Setting Initial Conditions
  - Control Statements for Printing Variables
  - Mapping Names to Node Numbers
  - Creating SIMetrix Plots
  - Control Statements Associated with Analyses
- Running SIMPLIS
  - Overview
  - Running SIMPLIS on a SIMetrix Schematic
  - Running SIMPLIS for an External Netlist
  - Running SIMPLIS from a Script
  - Running SIMPLIS from a DOS Prompt
  - SIMPLIS Execution
  - Aborting a SIMPLIS Run
  - Automatic Program Suspension by SIMPLIS
  - Netlist Preprocessor
  - Running Monte Carlo and Multi-step Analyses
- Simplis Data Files
  - Overview
  - The Listing Data File
  - Error Message Data File
  - The ``State of Exit'' Data File
  - Switching Instance Data File
  - Time-domain Data Output
  - The Topology Information File
  - Taking Advantage of Existing Files
  - Switching Instance Data File for the POP Analysis
  - Data for the Periodic Operating Point Analysis
  - Print/Plot File for Frequency-Domain Analysis
- Simplis-TX Examples
  - Overview
  - Example 1 -- Rectifier with RC load
  - Example 2 -- 3-Phase Rectifier with Resistive Load
  - Example 3 -- Operational Amplifier with Saturation
  - Example 4 -- Unregulated Converter
  - Example 5 -- Regulated Converter
  - Example 6 -- Saturable Inductor
  - Example 7 -- SCR with RL Load
- Simplis-POP
  - Overview
  - Statements Relating to POP Analysis
  - Synopsis of the Periodic Operating Point Analysis
  - Example of Applying the POP Analysis Tool
- Simplis-FX
  - Overview
  - Statements Relating AC Analysis
  - Synopsis of Small-Signal AC Analysis
- Advanced Digital Components
  - Overview
  - Advanced Digital Component Reference

Home
Verilog A Reference
Verilog-A Reference
Verilog-A Functions

Verilog-A Functions

Name	Return type	In types	Implemented?
$abstime	real	()	Yes
$angle	real	()	No
$arandom	integer	(integer,[string])	Yes
$bound_step	none	(real)	Yes
$debug	none	([real/integer/string...])	Yes
$discontinuity	none	([integer])	Yes
$display	none	([real/integer/string...])	Yes
$dist_chi_square	integer	(integer,integer)	Yes
$dist_erlang	integer	(integer,integer,integer)	Yes
$dist_exponential	integer	(integer,integer)	Yes
$dist_normal	integer	(integer,integer,integer)	Yes
$dist_poisson	integer	(integer,integer)	Yes
$dist_t	integer	(integer,integer)	Yes
$dist_uniform	integer	(integer,integer,integer)	Yes
$error	none	([string...])	Yes
$fatal	none	(integer, [string...])	Yes
$fclose	none	(integer)	Yes
$fdebug	none	(integer, [real/integer/string...])	Yes
$fdisplay	none	(integer, [real/integer/string...])	Yes
$ferror	integer	(integer, string)	Yes
$fflush	none	(integer)	Yes
$fgets	integer	(string, integer)	Yes
$finish	none	([integer])	Yes
$fmonitor	none	(integer, [real/integer/string...])	Yes
$fopen	integer	(string, [string])	Yes
$fscanf	integer	(integer, string [real/integer/string...])	Yes
$fseek	integer	(integer, integer, integer)	Yes
$fstrobe	none	(integer, [real/integer/string...])	Yes
$ftell	integer	(integer)	Yes
$fwrite	none	(integer, [real/integer/string...])	Yes
$info	none	([string...])	Yes
$hflip	real	()	No
$limit	real	(access_func,string,real...)	No
$mfactor	real	()	Yes
$monitor	none	([real/integer/string...])	Yes
$param_given	integer	identifier	Yes
$port_connected	integer	identifier	Yes
$random	integer	(integer)	Yes
$rdist_chi_square	real	(integer,real, [string])	Yes
$rdist_erlang	real	(integer,real,real, [string])	Yes
$rdist_exponential	real	(integer,real, [string])	Yes
$rdist_normal	real	(integer,real,real, [string])	Yes
$rdist_poisson	real	(integer,real, [string])	Yes
$rdist_t	real	(integer,real, [string])	Yes
$rdist_uniform	real	(integer,real,real,[string])	Yes
$realtime	real	([real])	No
$rewind	none	(integer)	Yes
$sformat	none	(string, string [real/integer/string...])	Yes
$sscanf	integer	(string, string [real/integer/string...])	Yes
$simparam	real	(string,[real])	Yes
$stop	none	([integer])	Yes
$strobe	none	([real/integer/string...])	Yes
$swrite	none	(string, string [real/integer/string...])	Yes
$table_model	real	Yes
$temperature	real	()	Yes
$vflip	real	()	No
$vt	real	([real]	Yes
$write	none	([real/integer/string...])	Yes
$xposition	real	()	No
$yposition	real	()	No
above	integer	(real,[real,[real]])	Yes
abs	copies args	(real/int)	Yes
absdelay	real	(real, real, [real])	Yes
ac_stim	complex	(string,[real,[real]])	Yes
acos	real	(real)	Yes
acosh	real	(real)	Yes
analysis	integer	(string,[...])	Yes
asin	real	(real)	Yes
asinh	real	(real)	Yes
atan	real	(real)	Yes
atan2	real	(real,real)	Yes
atanh	real	(real)	Yes
ceil	real	(real)	Yes
cos	real	(real)	Yes
cosh	real	(real)	Yes
cross	integer	(real,[integer,[real,[real]]])	Yes
ddt	real	(real,[real/string])	Yes
ddx	real	(real,access_func)	Yes
exp	real	(real)	Yes
flicker_noise	real	(real,real,[string])	Yes
floor	real	(real)	Yes
hypot	real	(real,real)	Yes
idt	real	(real,[real,[real,[real/string]]])	Yes
idtmod	real	(real,[real,[real,[real,[real/string]]]])	Yes
laplace_nd	real	(real,real-array,real-array,[real/string])	Yes
laplace_np	real	(real,real-array,real-array,[real/string])	Yes
laplace_zd	real	(real,real-array,real-array,[real/string])	Yes
laplace_zp	real	(real,real-array,real-array,[real/string])	Yes
last_crossing	real	(real,integer)	Yes
limexp	real	(real)	Yes
ln	real	(real)	Yes
log	real	(real)	Yes
max	copies args	(real/int,real/int)	Yes
min	copies args	(real/int,real/int)	Yes
noise_table	real	(real-array,[string])	No
pow	real	(real,real)	Yes
sin	real	(real)	Yes
sinh	real	(real)	Yes
slew	real	(real,[real,[real]])	Yes
sqrt	real	(real)	Yes
tan	real	(real)	Yes
tanh	real	(real)	Yes
timer	integer	(real,[real,[real]])	Yes
transition	real	(real,[real,[real,[real,[real]]]])	Yes
white_noise	real	(real,[string])	Yes
zi_nd	real	(real,real-array,real-array,real,[real,[real]])	Yes
zi_np	real	(real,real-array,real-array,real,[real,[real]])	Yes
zi_zd	real	(real,real-array,real-array,real,[real,[real]])	Yes
zi_zp	real	(real,real-array,real-array,real,[real,[real]])	Yes

In this topic:

$abstime

real_time = $abstime ;

In transient analysis, returns the absolute simulation time in seconds. In all other analyses returns zero.

$arandom

value = $arandom[([seed], [type_string])] ;

Where seed is an integer and type_string is a string with value "global" or "instance".

Returns a random number. This has three modes of operation according what if anything is supplied for seed.

Mode 1: no seed

$arandom will return a new random number on each call with the system choosing the seed when random is used for the first time.

Example:

value = $random ;

Mode 2: constant seed

seed may be either a literal constant or a constant expression dependent only on literal constants and parameters. In this mode $arandom will return a new random number on each call using the supplied seed for the starting value. In this mode $arandom will always return the same sequence of values for a given seed.

Example:

parameter seed=23 ; ... value = $random(seed) ;

Mode 3: initialised integer variable seed

In this mode the seed variable will be updated on each call and a new random number will be generated. The sequence of random numbers will be repeatable given the same initial value for seed.

Example:

integer seed ; ... @(initial_step) seed = 23 ; ... value = $random(seed) ;

In the above, the value of seed will be updated each time random is called.

type_string argument

The type_string argument may be used when $arandom is used in an expression which initialises a parameter. If set to "global", all calls to $arandom with a given seed will return the same random sequence. If set to "instance", the random sequence will vary according to the instance that calls it. All calls for a given instance will return the same sequence.

Note that the use of the type_string argument in a parameter initialisation expression is non-standard and may trigger an error if used with other Verilog-A implementations. LRM 2.4 states that type_string may only be specified in a paramset statement. SIMetrix does not currently implement paramset; these are used for hierarchical construction of Verilog-A modules.

SIMetrix also allows type_string to be used in an analog block expression, but a warning message will be displayed if this is used.

Finally, an "instance" type_string will only have an effect if specified for an instance parameter. Instance parameters are specified using a special attribute. E.g.:

(* type="instance" *)parameter integer ran_num = $arandom(1, "instance") ;

$bound_step

$bound_step( expression ) ;

Does not return a value.

In transient analysis, instructs simulator to limit the next timestep to the value of expression.

$clog2

$clog2( unsigned_integer_argument ) ;

Returns ceil( log2(argument+1)). It is the minimum number of bits required to represent the integer argument. Note that negative numbers are treated as 32 bit unsigned. E.g. -1 becomes 4294967295 and thus $clog2(-1) = 32.

$debug

$debug( list_of_arguments ) ;

Does not return a value.

$debug is a display function that displays information in the command shell. See $display for a description of its arguments. The $debug function writes to the command shell on every iteration. By contrast, other display functions such as $display only write information when an iteration has converged.

$debug writes an implicit new line character at the end of the text.

$discontinuity

$discontinuity [ ( constant_expression ) ] ;

Does not return a value.

Currently $discontinuity performs no action.

$display

$display( list_of_arguments ) ;

Does not return a value.

$display displays text in the command shell when the current iteration converges.

The arguments can be any sequence of strings, integers or reals. The function will display these values in the order in which they appear. The values will be output literally except for the interpretation of special characters that may appear in string values. The special characters are backslash ('\') and percent ('%'). '\' is used to output special characters according to the following table:

\n	Newline character
\t	Tab character
\\	Literal \ character
\"	" character
\ddd	Character specified by the ASCII code of the 1-3 octal digits

The '%' character must be followed by a character sequence that defines a format specification. In execution, the '%' and the format characters are substituted for the next value in the argument list, formatted according to the string. User's conversant with the 'C' programming language will have seen this method in the printf function. For example, %d specifies that an integer be displayed in decimal format. So, if count has a value of 453, the following:

$display("Count=%d", count) ;

would display:

Count=453

in the command shell.

The following table shows the format codes available:

%h or %H	Hexadecimal format
%d or %D	Decimal format
%o or %O	Octal format
%b or %B	Binary format
%c or %C	ASCII character. E.g a value of 84 would display an uppercase 'T'
%m or %M	Display hierarchical name of instance. This does not use one of the subsequent arguments
%s or %S	Literal string. Expects a matching string argument
%e or %E	Real number format. See Real Number Formats below
%f or %F	Real number format. See Real Number Formats below
%g or %G	Real number format. See Real Number Formats below
%r or %R	Real number format. See Real Number Formats below

Real Number Formats

Real numbers have their own more complex format codes. These are in the form:

% [flag] [width] [.precision] type

where:

flag	Characters '-', '+', '0', space or '#'. '-' means left align the result within given width (see width) '+' means always prefix a sign even if positive '0' means prefix with leading zeros '#' forces a decimal point to be always output even if not required
width	Specifies the minimum number of characters that will be displayed, padding with spaces or zeros if needed
precision	For e and f formats (see below) specifies the number of digits after the decimal point that will be printed. If g or r format is specified, specifies the maximum number of significant digits. Default if omitted is 6.
type	e, E, f, F, g, G or r, R e or E: Signed value displayed in exponential format. E.g. 1.23456E3 f or F: Signed value in decimal format. E.g. 1234.56. Result will be very long if value is very large or very small. g or G: Uses either f or e depending on which is most compact for give precision. r or R: displays in engineering units. Uses these scale factors: T, G, M, K, k, m, u, n, p, f, a.

Notes

The compiler will raise an error if there is a string/numeric mismatch between the format string and supplied arguments. That is if %s found in the format corresponds to an integer or real argument an error will be raised. Conversely if %d or %g etc found in the format string corresponds to a string variable an error will also be raised.

For example, the following will raise an error: $display("Count=%g", "hello world") ;

No error will result from a real/integer mismatch but a warning will be raised if the format string specifies an integer type but the supplied value is a real.

Note that the type (i.e. integer or real) of literal constants is determined by the way they are written. If a decimal point is included or if exponential or engineering formats are used, the number is real. Otherwise it is an integer. So 11 is an integer, while 11.0 is a real.

$dist_chi_square

integer_value = $rdist_chi_square( seed, degrees_of_freedom) ;

This function returns a random number with a chi square statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_chi_square is more appropriate.

$dist_erlang

integer_value = $rdist_erlang( seed, k, mean) ;

This function returns a random number with an Erlang statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_erlang is more appropriate.

$dist_exponential

integer_value = $rdist_exponential( seed, mean) ;

This function returns a random number with an exponential statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_exponential is more appropriate.

$dist_normal

integer_value = $rdist_normal( seed, mean, deviation) ;

This function returns a random number with an normal statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_normal is more appropriate.

$dist_poisson

integer_value = $rdist_poisson( seed, mean) ;

This function returns a random number with a poisson statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_poisson is more appropriate.

$dist_t

integer_value = $rdist_t( seed, degrees_of_freedom) ;

This function returns a random number with a T statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_t is more appropriate.

$dist_uniform

integer_value = $rdist_uniform( seed, start, end) ;

This function returns a random number with a uniform statistical distribution. seed must be an integer variable initialised with the initial seed value. Each call to the function will update the seed value.

All arguments and return values are integers. In most analog applications the real-valued version $rdist_uniform is more appropriate.

$error

$error( [list_of_messages]) ;

Does not return a value.

Signals an error condition and terminates the simulation. Unlike $fatal, $error has no effect if called during a rejected iteration. A message stating the time or step along with the reference of the instance that called the function will be written to the list file and displayed in the command shell.

An optional list of message arguments may also be supplied. These use the same format as the $display system task. The messages are displayed in the command shell and the list file.

If $error is called in a multi-step simulation performed using multiple cores, each core will act independently. So only the steps for that particular core will terminate.

A call to $error will set the simulation status to "Error". A subsequent call to the script function GetSimulatorStatus will return 'SimErrors'. (Refer to the Script Reference Manual for details.)

$fatal

$fatal( finish_code [,list_of_messages]) ;

Does not return a value.

Terminates the simulation immediately. Unlike $error, $fatal will be actioned even if called during an iteration that is rejected.

finish_code can be 0, 1 or 2 as defined in the following table:

n	Command shell message	List file message
0	none	none
1	Time and instance ref	Time only
2	Time and instance ref	Time and instance ref

An optional list of message arguments may also be supplied. These use the same format as the $display system task. The messages are displayed in the command shell and the list file.

If $fatal is called in a multi-step simulation performed using multiple cores, each core will act independently. So only the steps for that particular core will terminate.

A call to $fatal will set the simulation status to "Error". A call to the script function GetSimulatorStatus will return 'SimErrors'.

$fclose

$fclose( file_descriptor ) ;

Does not return a value.

Closes one or more file descriptors opened with $fopen.

$fdebug

$fdebug( file_descriptor, list_of_arguments ) ;

Does not return a value.

As $debug, but writes to a file or files defined by file_descriptor.

$fdisplay

$fdisplay( file_descriptor, list_of_arguments ) ;

Does not return a value.

As $display, but writes to a file or files defined by file_descriptor.

$ferror

integer_value = $ferror( file_descriptor, returned_message_string ) ;

The $ferror function may be called after any other function that operates on a file descriptor to return an error code relating to that function. In addition a descriptive string will be written to the returned_message_string argument.

The Verilog-A language reference manual does not define the codes that this function should return other than 0 meaning "no error". The string written to returned_message_string may be used to display a meaningful message to the user.

if the most recent file operation is a failed call to $fopen, the function will return information about the $fopen call if zero is passed as the file_descriptor.

$fflush

$fflush( file_descriptor) ;

Does not return a value.

Forces the immediate flushing of a file stream. File writes using $fwrite are buffered in memory before being written to disk. This system task forces the buffer to be written out to the file at the end of the current step.

$fgets

integer count = $fgets(string, file_descriptor) ;

Reads a line of text from the file specified by file_descriptor and writes it to the string variable string. The function returns the number of characters read from the file. If an error occurs the return value is zero. Call $ferror to determine the reason for the error.

$finish

$finish [ ( n ) ] | (n, mode)

Does not return a value.

Instructs simulator to finish the analysis. The argument n may take the value of 0, 1 or 2 as shown in the table below:

n	Command shell message	List file message
0	none	none
1	Time and instance ref	Time only
2	Time and instance ref	Time and instance ref

If n is omitted, it will default to 1.

$finish is only effective if called during an iteration that converges and is accepted. Any data generated by the converged iteration will be saved as normal.

The mode argument is non-standard and not compatible with other Verilog-A systems. This can have a value of 0 or 1 and determines the behaviour of the function in a multi-step analysis. With a value of 0, or if omitted, the whole simulation will complete and no further steps in the multi-step analysis will be performed. If set to 1, the current step will be terminated but the simulation will continue with the next step.

If $finish is called in a multi-step simulation performed using multiple cores, each core will act independently. So, even with a mode value of 0, only the steps for that particular core will terminate.

A call to $finish is not considered to be an error condition and no error will be flagged. A subsequent call to the script function GetSimulatorStatus will return 'Complete'. (Refer to the Script Reference Manual for details.) To terminate a simulation and flag an error condition, use either $error or $fatal.

The LRM states that $finish should also trigger the final_step event to be executed. SIMetrix does not implement this feature as it is unclear exactly how this should be done. The decision to finish can only be made once the current step has converged as only then are all the values settled to stable values. So it is only at that time that the final_step event code can be executed. To do this would require either one more iteration at the current time step or executing a new time step. Neither makes much sense so we decided not to implement this feature.

If compatibility with other Verilog-A systems is required, we recommend not combining final_step with the $finish system task in the same module.

$fmonitor

$fmonitor( file_descriptor, list_of_arguments ) ;

Does not return a value.

As $monitor, but writes to a file or files defined by file_descriptor.

$fopen

integer file_descriptor = $fopen( filename [, open_mode] ) ;

This function returns a file descriptor that can be used for any function that writes to or reads from a file.

If the open_mode argument is not supplied, the function operates in multi-channel descriptor mode. Multi-channel descriptors can be used as an argument to functions that write to a file including $fdebug, $fdisplay, $fmonitor, $fstrobe and $fwrite.

There are 31 possible channels each represented by a single bit in the 32 bit returned value. The top (most significant bit) is reserved. The bottom (least siginificant) is used for standard output - i.e. displays to the command shell. Each new call to $fopen will assign the next channel and set the relevant bit. By or'ing together the results from multiple calls to $fopen, it is possible to write to more than one file at a time.

SIMetrix has a special extension to this function providing access to the list file. Use the filename "<listfile>" and the descriptor returned will access it. The following code for example will create a file descriptor that will provide writes to both the list file and a user file:

fd = $fopen( "<listfile>" ) ; fd = fd | $fopen( "a_text_file.txt") ;

Further, by or'ing with 1 the file descriptor will also write to the command shell.

If the open_mode argument is provided and set to "r", the function will open a file in read mode and return an integer that can be passed to functions that can read data from a file including $fscanf.

if the open_mode argument is provided and set to "w", the function will open a file in write mode and return an integer that can be passed to functions that can write data. This method of creating a write file handle does not suffer from the limit of 31 handles but does not support simultaneous writing of multiple files.

if the open_mode argument is provided and set to "a", the behaviour is the same as "w" except that if the file already exists, new output will be appended to the end of the file.

If the same file is opened for write in two or more instances within the same simulation, an independent file handle will be returned that references a temporary file. When the simulation is complete, the temporary files will be merged with the master file.

The file modes "rb", "wb" and "ab" as described in the LRM are also supported but behave identically to "r", "w" and "a" respectively. On read, the ASCII 13 character ("carriage-return") is always ignored and on write, the CR character is never written out. Currently only text files may be processed using Verilog-A code.

If the specified file cannot be opened, the function returns 0. Note that legitimate file descriptors can be, and usually are, negative. To test whether the file descriptor is valid, be sure to test that it is not equal to zero. Don't test that it is greater than zero.

If the intention is to open a file and keep it open for the duration of an analysis run, the file should be opened in either an initial_step event or an analog intial block. It can then be closed in a final_step event. Note that it is not possible to close a file then reopen it in the same time step.

The file descriptor should be closed with $fclose.

$fscanf

$fscanf( file_descriptor, format_string, list_of_arguments ) ;

Performs the same function as as $sscanf but instead of reading characters from a string, reads characters from a file defined by the file_descriptor argument. A file_descriptor may be obtained using the $fopen function with the "mode" argument set to "r".

$fseek

integer result $fseek(file_descriptor, offset, op)

Move the file position of the file specified by file_descriptor to the position identified by offset and op. If op is 0, offset is relative to the start of the file. If op is 1, offset is relative to the current position and if op is 2, offset is relative to the end of the file.

The function returns zero if the operation is successful. Otherwise it returns -1. Call $ferror to determine the reason for the error.

Note that if a file is opened in append mode, $fseek is effectively disabled. Append mode does not allow overwriting data already in the file, so the write pointer is always positioned at the end of the file for every write.

$fstrobe

$fstrobe( file_descriptor, format_string, list_of_arguments ) ;

Does not return a value.

As $strobe, but writes to a file or files defined by file_descriptor. Note that the $strobe and $display functions are identical. For detailed documentation see $display.

$ftell

integer file_position $ftell(file_descriptor)

Returns the current file position of the file specified by file_descriptor. Returns -1 if an error occurs. Call $ferror to determine the reason for the error.

$fwrite

$fwrite( file_descriptor, list_of_arguments ) ;

Does not return a value.

As $write, but writes to a file or files defined by file_descriptor. Note that the $write function is identical to $display, except that it does add a new line character. For detailed documentation see $display.

$info

$info( [list_of_messages]) ;

Does not return a value.

Writes a message to the list file be considered as a low level warning. $info has no effect if called during a rejected iteration.

The message arguments use the same format as the $display system task.

A call to $info will not change the simulation status. A subsequent call to the script function GetSimulatorStatus will return 'Complete'. (Refer to the Script Reference Manual for details).

$mfactor

real_value = $mfactor ;

$mfactor does not take any arguments.

Returns the scaling factor applied to the instance. The scaling factor may be set using the $mfactor parameter or using a subcircuit multiplier M. If both are used, the final scale factor will be the product of these. Refer to the LRM for more details.

The LRM currently stipulates that compilers should raise an error if $mfactor is used inappropriately. This is not currently implemented and $mfactor may be used for any purpose.

$monitor

$monitor( list_of_arguments ) ;

Does not return a value.

$monitor behaves in a similar manner to $display except that it only outputs a result when there is a change. In other words, the behaviour is the same as $display except that successive repeated messages will not be output.

$monitor writes an implicit new line character at the end of the text.

$param_given

integer_value = $param_given( parameter_name ) ;

parameter_name must be a parameter defined using the parameter keyword. Returns a non-zero number if parameter_name has been specified in a .MODEL statement or on the instance line where relevant.

$port_connected

integer_value = $port_connected( port_name[ [index_expression] ] ) ;

Returns a non-zero value if the specified port_name is connected externally. If the port is vectored, then index_expression defining the element within the vector must also be specified. No error will be raised if the index supplied is out of range; the function will simply return false (zero).

Currently, this function will only deem a port to be unconnected if no node is specified for it in the instance netlist line. It will return true (non-zero) if a node name is supplied on the netlist line but is not connected to any other component in the netlist. For example, consider a model for a four-terminal BJTwith nodes 'C', 'B', 'E' and 'S' where 'S' is the substrate connection:

Q1 C B E S bjtmodelname

In the above the substrate connection is the node S. In this case $port_connected(S) would return true regardless of whether or not S was connected to anything else. Now consider the three terminal case:

Q1 C B E bjtmodelname In this case the substrate connection has been omitted from the netlist line and $port_connected will return false (zero).

$random

integer_value = $random [ (seed) ] ;

Returns a random number. This has three modes of operation according what if anything is supplied for seed.

Mode 1: no seed

$random will return a new random number on each call with the system choosing the seed when random is used for the first time.

Example:

value = $random ;

Mode 2: constant seed

seed may be either a literal constant or a constant expression dependent only on literal constants and parameters. In this mode $random will return a fixed random value which will not update.

Note that this mode of operation is obsolete and may be removed from future releases. To obtain a fixed random value, use $arandom assigned to parameter or localparam. Alternatively assign to a variable in an @initial_step event or analog initial block.

Example:

parameter seed=23 ; ... value = $random(seed) ;

Mode 3: initialised integer variable seed

In this mode the seed variable will be updated on each call and a new random number will be generated. The sequence of random numbers will thus be repeatable given the same initial value for seed.

Example:

real seed ; ... @(initial_step) seed = 23 ; ... value = $random(seed) ;

In the above, the value of seed will be updated each time random is called.