Tcl SpiceGenTcl package (v0.60)

::SpiceGenTcl::Ngspice::SourcesTop, Main, Index

ClassesTop, Main, Index

am [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Device

Subclasses

Vam, Iam

constructor [::SpiceGenTcl::Ngspice::Sources::am]am, Top, Main, Index

am create OBJNAME name type npNode nmNode ?args?
am new name type npNode nmNode ?args?
Parameters
nameNot documented.
typeNot documented.
npNodeNot documented.
nmNodeNot documented.
method constructor {name type npNode nmNode args} {

    set arguments [argparse -inline {
        {-v0= -required}
        {-va= -required}
        {-mf= -required}
        {-fc= -required}
        {-td= -required}
        -phases=
    }]
    set paramsOrder [list v0 va mf fc td phases]
    foreach param $paramsOrder {
        if {[dexist $arguments $param]} {
            dict append argsOrdered $param [dget $arguments $param]
        }
    }
    lappend params "model am -posnocheck"
    dict for {paramName value} $argsOrdered {
        if {([llength $value]>1) && ([@ $value 1]=="-eq")} {
            lappend params "$paramName [@ $value 0] -poseq"
        } else {
            lappend params "$paramName $value -pos"
        }
    }
    next $type$name [list "np $npNode" "nm $nmNode"] $params
}

B [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

BehaviouralSource

BehaviouralSource [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Device

Mixins

::SpiceGenTcl::KeyArgsBuilder

Subclasses

B

constructor [::SpiceGenTcl::Ngspice::Sources::BehaviouralSource]BehaviouralSource, Top, Main, Index

Creates object of class BehaviouralSource that describes behavioural source.

OBJECT constructor name npNode nmNode -i value ?-tc1 value? ?-tc2 value? ?-noisy 0|1? ?-temp value|-dtemp value?
OBJECT constructor name npNode nmNode -v value ?-tc1 value? ?-tc2 value? ?-noisy 0|1? ?-temp value|-dtemp value?
Parameters
nameName of the device without first-letter designator R.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-iCurrent expression.
-vVoltage expression.
Description
BXXXXXXX n+ n- <i=expr> <v=expr> <tc1=value> <tc2=value> <dtemp=value> <temp=value>

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::BehaviouralSource new 1 netp netm -v "V(a)+V(b)+pow(V(c),2)" -tc1 1
method constructor {name npNode nmNode args} {

    # Creates object of class `BehaviouralSource` that describes behavioural source.
    #  name - name of the device without first-letter designator R
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -i - current expression
    #  -v - voltage expression
    # ```
    # BXXXXXXX n+ n- <i=expr> <v=expr> <tc1=value> <tc2=value> <dtemp=value> <temp=value>
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::BehaviouralSource new 1 netp netm -v "V(a)+V(b)+pow(V(c),2)" -tc1 1
    # ```
    # Synopsis: name npNode nmNode -i value ?-tc1 value? ?-tc2 value? ?-noisy 0|1? ?-temp value|-dtemp value?
    # Synopsis: name npNode nmNode -v value ?-tc1 value? ?-tc2 value? ?-noisy 0|1? ?-temp value|-dtemp value?
    set arguments [argparse -inline {
        {-i= -forbid {v}}
        {-v= -forbid {i}}
        -tc1=
        -tc2=
        {-noisy= -enum {0 1}}
        {-temp= -forbid {dtemp}}
        {-dtemp= -forbid {temp}}
    }]
    if {[dexist $arguments i]} {
        lappend params "i [dget $arguments i] -eq"
    } elseif {[dexist $arguments v]} {
        lappend params "v [dget $arguments v] -eq"
    } else {
        return -code error "Equation must be specified as argument to -i or -v"
    }
    dict for {paramName value} $arguments {
        if {$paramName ni {i v}} {
            lappend params "$paramName $value"
        }
    }
    next b$name [list "np $npNode" "nm $nmNode"] $params
}

Cccs [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Cccs

Subclasses

F

Ccvs [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Ccvs

Subclasses

H

E [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

Vcvs

F [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

Cccs

G [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

Vccs

H [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

Ccvs

Iac [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Iac

Iam [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

am

constructor [::SpiceGenTcl::Ngspice::Sources::Iam]Iam, Top, Main, Index

Creates object of class Iam that describes single-frequency FM current source.

OBJECT constructor name npNode nmNode -v0 value -va value -mf value -fc value ?-td value ?-phases value??
Parameters
nameName of the device without first-letter designator I.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-fcCarrier frequency.
-mfModulating frequency.
-phasesPhase, optional, require -td.
-tdSignal delay, optional.
-v0Initial value.
-vaPulsed value.
Description
IYYYYYYY n+ n- AM(VA VO MF FC TD PHASES)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Iam new 1 net1 net2 -v0 0 -va 2 -mf 1e3 -fc {freq -eq} -td 1e-6 -phases {phase -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Iam` that describes single-frequency FM current source.
    #  name - name of the device without first-letter designator I
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -v0 - initial value
    #  -va - pulsed value
    #  -mf - modulating frequency
    #  -fc - carrier frequency
    #  -td - signal delay, optional
    #  -phases - phase, optional, require -td
    # ```
    # IYYYYYYY n+ n- AM(VA VO MF FC TD PHASES)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Iam new 1 net1 net2 -v0 0 -va 2 -mf 1e3 -fc {freq -eq} -td 1e-6 -phases {phase -eq}
    # ```
    # Synopsis: name npNode nmNode -v0 value -va value -mf value -fc value ?-td value ?-phases value??
    next $name i $npNode $nmNode {*}$args
}

Idc [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Idc

Iexp [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Iexp

Ipulse [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

pulse

constructor [::SpiceGenTcl::Ngspice::Sources::Ipulse]Ipulse, Top, Main, Index

Creates object of class Ipulse that describes pulse current source.

OBJECT constructor name npNode nmNode -low value -high value -td value -tr value -tf value -pw value -per value ?-np value?
Parameters
nameName of the device without first-letter designator I.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-highHigh value.
-lowLow value.
-npNumber of pulses, optional.
-perPeriod time.
-pwWidth of pulse.
-tdTime delay.
-tfFall time.
-trRise time.
Description
IYYYYYYY n+ n- PULSE(V1 V2 TD TR TF PW PER NP)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Ipulse new 1 net1 net2 -low 0 -high 1 -td {td -eq} -tr 1e-9 -tf 1e-9 -pw 10e-6 -per 20e-6 -np {np -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Ipulse` that describes pulse current source.
    #  name - name of the device without first-letter designator I
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -low - low value
    #  -high - high value
    #  -td - time delay
    #  -tr - rise time
    #  -tf - fall time
    #  -pw - width of pulse
    #  -per - period time
    #  -np - number of pulses, optional
    # ```
    # IYYYYYYY n+ n- PULSE(V1 V2 TD TR TF PW PER NP)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Ipulse new 1 net1 net2 -low 0 -high 1 -td {td -eq} -tr 1e-9 -tf 1e-9 -pw 10e-6 -per 20e-6 -np {np -eq}
    # ```
    # Synopsis: name npNode nmNode -low value -high value -td value -tr value -tf value -pw value -per value
    #   ?-np value?
    next $name i $npNode $nmNode {*}$args
}

Ipwl [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Ipwl

Isffm [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

sffm

constructor [::SpiceGenTcl::Ngspice::Sources::Isffm]Isffm, Top, Main, Index

Creates object of class Isffm that describes single-frequency FM current source.

OBJECT constructor name npNode nmNode -v0 value -va value -fc value -mdi value -fs value ?-phasec value ?-phases value??
Parameters
nameName of the device without first-letter designator I.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-fcCarrier frequency.
-fsSignal frequency.
-mdiModulation index.
-phasecCarrier phase, optional.
-phasesSignal phase, optional, require -phasec.
-v0Initial value.
-vaPulsed value.
Description
IYYYYYYY n+ n- SFFM(VO VA FC MDI FS PHASEC PHASES)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Isin new 1 net1 net2 -v0 0 -va 1 -fc {freq -eq} -mdi 0 -fs 1e3 -phasec {phase -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Isffm` that describes single-frequency FM current source.
    #  name - name of the device without first-letter designator I
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -v0 - initial value
    #  -va - pulsed value
    #  -fc - carrier frequency
    #  -mdi - modulation index
    #  -fs - signal frequency
    #  -phasec - carrier phase, optional
    #  -phases - signal phase, optional, require -phasec
    # ```
    # IYYYYYYY n+ n- SFFM(VO VA FC MDI FS PHASEC PHASES)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Isin new 1 net1 net2 -v0 0 -va 1 -fc {freq -eq} -mdi 0 -fs 1e3 -phasec {phase -eq}
    # ```
    # Synopsis: name npNode nmNode -v0 value -va value -fc value -mdi value -fs value ?-phasec value
    #   ?-phases value??
    next $name i $npNode $nmNode {*}$args
}

Isin [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Isin

pulse [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Device

Subclasses

Vpulse, Ipulse

constructor [::SpiceGenTcl::Ngspice::Sources::pulse]pulse, Top, Main, Index

pulse create OBJNAME name type npNode nmNode ?args?
pulse new name type npNode nmNode ?args?
Parameters
nameNot documented.
typeNot documented.
npNodeNot documented.
nmNodeNot documented.
method constructor {name type npNode nmNode args} {

    set arguments [argparse -inline {
        {-low= -required}
        {-high= -required}
        {-td= -required}
        {-tr= -required}
        {-tf= -required}
        {-pw= -required}
        {-per= -required}
        -np=
    }]
    set paramsOrder [list low high td tr tf pw per np]
    foreach param $paramsOrder {
        if {[dexist $arguments $param]} {
            dict append argsOrdered $param [dget $arguments $param]
        }
    }
    lappend params "model pulse -posnocheck"
    dict for {paramName value} $argsOrdered {
        if {([llength $value]>1) && ([@ $value 1]=="-eq")} {
            lappend params "$paramName [@ $value 0] -poseq"
        } else {
            lappend params "$paramName $value -pos"
        }
    }
    next $type$name [list "np $npNode" "nm $nmNode"] $params
}

sffm [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Device

Mixins

::SpiceGenTcl::KeyArgsBuilder

Subclasses

Vsffm, Isffm

constructor [::SpiceGenTcl::Ngspice::Sources::sffm]sffm, Top, Main, Index

sffm create OBJNAME name type npNode nmNode ?args?
sffm new name type npNode nmNode ?args?
Parameters
nameNot documented.
typeNot documented.
npNodeNot documented.
nmNodeNot documented.
method constructor {name type npNode nmNode args} {

    set arguments [argparse -inline {
        {-v0= -required}
        {-va= -required}
        {-fc= -required}
        {-mdi= -required}
        {-fs= -required}
        -phasec=
        {-phases= -require {phasec}}
    }]
    set paramsOrder [list v0 va fc mdi fs phasec phases]
    foreach param $paramsOrder {
        if {[dexist $arguments $param]} {
            dict append argsOrdered $param [dget $arguments $param]
        }
    }
    lappend params "model sffm -posnocheck"
    dict for {paramName value} $argsOrdered {
        if {([llength $value]>1) && ([@ $value 1]=="-eq")} {
            lappend params "$paramName [@ $value 0] -poseq"
        } else {
            lappend params "$paramName $value -pos"
        }
    }
    next $type$name [list "np $npNode" "nm $nmNode"] $params
}

Vac [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vac

Vam [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

am

constructor [::SpiceGenTcl::Ngspice::Sources::Vam]Vam, Top, Main, Index

Creates object of class Vam that describes single-frequency FM voltage source.

OBJECT constructor name npNode nmNode -v0 value -va value -mf value -fc value ?-td value ?-phases value??
Parameters
nameName of the device without first-letter designator V.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-fcCarrier frequency.
-mfModulating frequency.
-phasesPhase, optional, require -td.
-tdSignal delay, optional.
-v0Initial value.
-vaPulsed value.
Description
VYYYYYYY n+ n- AM(VA VO MF FC TD PHASES)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Vam new 1 net1 net2 -v0 0 -va 2 -mf 1e3 -fc {freq -eq} -td 1e-6 -phases {phase -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Vam` that describes single-frequency FM voltage source.
    #  name - name of the device without first-letter designator V
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -v0 - initial value
    #  -va - pulsed value
    #  -mf - modulating frequency
    #  -fc - carrier frequency
    #  -td - signal delay, optional
    #  -phases - phase, optional, require -td
    # ```
    # VYYYYYYY n+ n- AM(VA VO MF FC TD PHASES)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Vam new 1 net1 net2 -v0 0 -va 2 -mf 1e3 -fc {freq -eq} -td 1e-6 -phases {phase -eq}
    # ```
    # Synopsis: name npNode nmNode -v0 value -va value -mf value -fc value ?-td value ?-phases value??
    next $name v $npNode $nmNode {*}$args
}

Vccs [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vccs

Subclasses

G

Vcvs [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vcvs

Subclasses

E

Vdc [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vdc

Vexp [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vexp

Vport [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Device

constructor [::SpiceGenTcl::Ngspice::Sources::Vport]Vport, Top, Main, Index

Creates object of class Vport that describes simple constant voltage source.

OBJECT constructor name npNode nmNode -dc value -ac value -portnum value ?-z0 value?
Parameters
nameName of the device without first-letter designator V.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-acAC voltage value.
-dcDC voltage value.
-portnumNumber of port.
-z0Internal source impedance.
Description
VYYYYYYY n+ n- DC 0 AC 1 portnum n1 <z0 n2>

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Vport new 1 netp netm -dc 1 -ac 1 -portnum 1 -z0 100
method constructor {name npNode nmNode args} {

    # Creates object of class `Vport` that describes simple constant voltage source.
    #  name - name of the device without first-letter designator V
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -dc - DC voltage value
    #  -ac - AC voltage value
    #  -portnum - number of port
    #  -z0 - internal source impedance
    # ```
    # VYYYYYYY n+ n- DC 0 AC 1 portnum n1 <z0 n2>
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Vport new 1 netp netm -dc 1 -ac 1 -portnum 1 -z0 100
    # ```
    # Synopsis: name npNode nmNode -dc value -ac value -portnum value ?-z0 value?
    set arguments [argparse -inline {
        {-dc= -required}
        {-ac= -required}
        {-portnum= -required}
        {-z0=}
    }]
    dict for {paramName value} $arguments {
        lappend params "$paramName -sw"
        if {([llength $value]>1) && ([@ $value 1]=="-eq")} {
            lappend params "${paramName}val [@ $value 0] -poseq"
        } else {
            lappend params "${paramName}val $value -pos"
        }
    }
    next v$name [list "np $npNode" "nm $nmNode"] $params
}

Vpulse [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

pulse

constructor [::SpiceGenTcl::Ngspice::Sources::Vpulse]Vpulse, Top, Main, Index

Creates object of class Vpulse that describes pulse voltage source.

OBJECT constructor name npNode nmNode -low value -high value -td value -tr value -tf value -pw value -per value ?-np value?
Parameters
nameName of the device without first-letter designator V.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-highHigh value.
-lowLow value.
-npNumber of pulses, optional.
-perPeriod time.
-pwWidth of pulse.
-tdTime delay.
-tfFall time.
-trRise time.
Description
VYYYYYYY n+ n- PULSE(V1 V2 TD TR TF PW PER NP)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Vpulse new 1 net1 net2 -low 0 -high 1 -td {td -eq} -tr 1e-9 -tf 1e-9 -pw 10e-6 -per 20e-6 -np {np -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Vpulse` that describes pulse voltage source.
    #  name - name of the device without first-letter designator V
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -low - low value
    #  -high - high value
    #  -td - time delay
    #  -tr - rise time
    #  -tf - fall time
    #  -pw - width of pulse
    #  -per - period time
    #  -np - number of pulses, optional
    # ```
    # VYYYYYYY n+ n- PULSE(V1 V2 TD TR TF PW PER NP)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Vpulse new 1 net1 net2 -low 0 -high 1 -td {td -eq} -tr 1e-9 -tf 1e-9 -pw 10e-6 -per 20e-6 -np {np -eq}
    # ```
    # Synopsis: name npNode nmNode -low value -high value -td value -tr value -tf value -pw value -per value
    #   ?-np value?
    next $name v $npNode $nmNode {*}$args
}

Vpwl [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vpwl

Vsffm [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
constructorConstructor for the class.
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

sffm

Mixins

::SpiceGenTcl::KeyArgsBuilder

constructor [::SpiceGenTcl::Ngspice::Sources::Vsffm]Vsffm, Top, Main, Index

Creates object of class Vsffm that describes single-frequency FM voltage source.

OBJECT constructor name npNode nmNode -v0 value -va value -fc value -mdi value -fs value ?-phasec value ?-phases value??
Parameters
nameName of the device without first-letter designator V.
npNodeName of node connected to positive pin.
nmNodeName of node connected to negative pin.
-fcCarrier frequency.
-fsSignal frequency.
-mdiModulation index.
-phasecCarrier phase, optional.
-phasesSignal phase, optional, require -phasec.
-v0Initial value.
-vaPulsed value.
Description
VYYYYYYY n+ n- SFFM(VO VA FC MDI FS PHASEC PHASES)

Example of class initialization:

::SpiceGenTcl::Ngspice::Sources::Vsin new 1 net1 net2 -v0 0 -va 1 -fc {freq -eq} -mdi 0 -fs 1e3 -phasec {phase -eq}
method constructor {name npNode nmNode args} {

    # Creates object of class `Vsffm` that describes single-frequency FM voltage source.
    #  name - name of the device without first-letter designator V
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  -v0 - initial value
    #  -va - pulsed value
    #  -fc - carrier frequency
    #  -mdi - modulation index
    #  -fs - signal frequency
    #  -phasec - carrier phase, optional
    #  -phases - signal phase, optional, require -phasec
    # ```
    # VYYYYYYY n+ n- SFFM(VO VA FC MDI FS PHASEC PHASES)
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::Sources::Vsin new 1 net1 net2 -v0 0 -va 1 -fc {freq -eq} -mdi 0 -fs 1e3 -phasec {phase -eq}
    # ```
    # Synopsis: name npNode nmNode -v0 value -va value -fc value -mdi value -fs value ?-phasec value
    #   ?-phases value??
    next $name v $npNode $nmNode {*}$args
}

Vsin [::SpiceGenTcl::Ngspice::Sources]Top, Main, Index

Method summary
addParamSee ::SpiceGenTcl::Device.addParam
argsPreprocessSee ::SpiceGenTcl::KeyArgsBuilder.argsPreprocess
buildArgStrSee ::SpiceGenTcl::KeyArgsBuilder.buildArgStr
checkFloatingPinsSee ::SpiceGenTcl::Device.checkFloatingPins
configureConfigure properties.
deleteParamSee ::SpiceGenTcl::Device.deleteParam
duplListCheckSee ::SpiceGenTcl::DuplChecker.duplListCheck
genSPICEStringSee ::SpiceGenTcl::Device.genSPICEString
getParamsSee ::SpiceGenTcl::Device.getParams
getPinsSee ::SpiceGenTcl::Device.getPins
setParamValueSee ::SpiceGenTcl::Device.setParamValue
setPinNodeNameSee ::SpiceGenTcl::Device.setPinNodeName
Properties

Readable: -name

Writable: -name

Superclasses

::SpiceGenTcl::Common::Sources::Vsin