::SpiceGenTcl::Xyce::SimulatorsTop, Main, Index

ClassesTop, Main, Index

Batch [::SpiceGenTcl::Xyce::Simulators]Top, Main, Index

Method summary

constructor	Constructor for the class.
clearLog	Clear saved log by unsetting Log variable.
`configure`	Configure properties.
`getLog`	See ::SpiceGenTcl::Simulator.getLog
readData	Reads raw data file, create RawFile object and return it's reference name.
readLog	Reads log file of last simulation and save it's content to Log variable.
`run`	See ::SpiceGenTcl::Simulator.run
runAndRead	Runs netlist circuit file.

Properties

Readable: -Command, -Data, -LastRunFileName, -Log, -Name, -Path, -RunLocation

Writable: -Command, -Data, -LastRunFileName, -Log, -Name, -Path, -RunLocation

Superclasses

::SpiceGenTcl::Simulator

constructor [::SpiceGenTcl::Xyce::Simulators::Batch]Batch, Top, Main, Index

Creates batch ngspice simulator that can be attached to top-level Circuit.

Batch create OBJNAME name path ?runLocation?
Batch new name path ?runLocation?

Parameters

`name`	Name of simulator object.
`path`	Path of ngspice executable file.
`runLocation`	Location at which input netlist is stored and all output files will be saved, default is system temporary folder at Linux system. Optional, default `/tmp`.

Show source

method constructor {name path {runLocation /tmp}} {

    # Creates batch ngspice simulator that can be attached to top-level Circuit.
    #  name - name of simulator object
    #  path - path of ngspice executable file
    #  runLocation - location at which input netlist is stored and all output files will be saved,
    #   default is system temporary folder at Linux system
    my configure -Name $name
    my configure -Path $path
    my configure -Command Xyce
    my configure -RunLocation $runLocation
}

clearLog [::SpiceGenTcl::Xyce::Simulators::Batch]Batch, Top, Main, Index

Clear saved log by unsetting Log variable.

OBJECT clearLog

Show source

method clearLog {} {

    # Clear saved log by unsetting Log variable.
    if {[info exists Log]} {
        unset Log
        return
    } else {
        error "Log does not exists for simulator '[my configure -Name]'"
    }
}

readData [::SpiceGenTcl::Xyce::Simulators::Batch]Batch, Top, Main, Index

Reads raw data file, create RawFile object and return it's reference name.

OBJECT readData

Show source

method readData {} {

    # Reads raw data file, create RawFile object and return it's reference name.
    my variable Data
    set Data [::SpiceGenTcl::RawFile new "[my configure -RunLocation]/[my configure -LastRunFileName].raw"]
    return
}

readLog [::SpiceGenTcl::Xyce::Simulators::Batch]Batch, Top, Main, Index

Reads log file of last simulation and save it's content to Log variable.

OBJECT readLog

Show source

method readLog {} {

    # Reads log file of last simulation and save it's content to Log variable.
    set logFile [open "[my configure -RunLocation]/[my configure -LastRunFileName].log" r+]
    set Log [read $logFile]
    close $logFile
    return
}

runAndRead [::SpiceGenTcl::Xyce::Simulators::Batch]Batch, Top, Main, Index

Runs netlist circuit file.

OBJECT runAndRead circuitStr

Parameters

circuitStr Top-level netlist string.

Show source

method runAndRead {circuitStr} {

    # Runs netlist circuit file.
    #  circuitStr - top-level netlist string
    set firstLine [lindex [split $circuitStr \n] 0]
    set runLocation [my configure -RunLocation]
    set cirFile [open "${runLocation}/${firstLine}.cir" w+]
    puts $cirFile $circuitStr
    close $cirFile
    set rawFileName "${runLocation}/${firstLine}.raw"
    set logFileName "${runLocation}/${firstLine}.log"
    set cirFileName "${runLocation}/${firstLine}.cir"
    exec "[my configure -Command]" -r $rawFileName -l $logFileName $cirFileName
    my configure -LastRunFileName ${firstLine}
    my readLog
    my readData
}