::SpiceGenTcl::Xyce::BasicDevices¶

OBJECT constructor name np nm -c value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value? ?-age value? ?-d value?
OBJECT constructor name np nm -beh -c value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value? ?-age value? ?-d value?
OBJECT constructor name np nm -beh -q value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value? ?-age value? ?-d value?
OBJECT constructor name np nm -model value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value? ?-age value? ?-d value? ?-l value? ?-w value?

Parameters

-age value:: Aging coefficient, optional.
-beh:: Selects behavioural type of capacitor, optional.
-c value:: Capacitance value or equation.
-d value:: Aging coefficient, optional.
-ic value:: Initial voltage on capacitor, optional.
-l value:: Length of semiconductor capacitor, optional.
-m value:: Multiplier value, optional.
-model value:: Model of the capacitor, optional.
-q value:: Charge equation.
-tc1 value:: Linear thermal coefficient, optional.
-tc2 value:: Quadratic thermal coefficient, optional.
-temp value:: Device temperature, optional.
-w value:: Width of semiconductor capacitor, optional.
name:: Name of the device without first-letter designator C.
nm:: Name of node connected to negative pin.
np:: Name of node connected to positive pin.

Description

Capacitor type could be specified with additional switches: -beh if we want to model circuit’s variable dependent capacitor, or -model modelName if we want to simulate capacitor with model card. Simple capacitor:

C<device name> <(+) node> <(-) node> <value> [device parameters]

Example of class initialization as a simple capacitor:

Capacitor new 1 netp netm 1e-6 -tc1 1 -temp {-eq temp}

Behavioral capacitor with C expression:

C<device name> <(+) node> <(-) node> C={expression} [device parameters]

Example of class initialization:

Capacitor new 1 netp netm -c "V(a)+V(b)+pow(V(c),2)" -beh -tc1 1

Behavioral capacitor with Q expression:

C<device name> <(+) node> <(-) node> Q={expression} [device parameters]

Example of class initialization:

Capacitor new 1 netp netm -q "V(a)+V(b)+pow(V(c),2)" -beh -tc1 1

Capacitor with model card:

C<device name> <(+) node> <(-) node> <model name> [value] [device parameters]

Example of class initialization:

Capacitor new 1 netp netm -model capm -l 1e-6 -w 10e-6

`CModel`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Model.
genSPICEString: Inherited from ::SpiceGenTcl::Model.

Properties

-name:: Readable, writable. Inherited.
-type:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Model

`constructor`¶

Creates object of class CModel that describes semiconductor capacitor model.

OBJECT constructor name ?-option value ...?

Parameters

args:: Keyword instance parameters, for details please refer to Xyce reference manual, 2.3.4 section.
name:: Name of the model.

Description

Example of class initialization:

CModel new capmod -tc1 1 -tc2 2

`CSwitch`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Common::BasicDevices::CSwitch

Subclasses

W

`CSwitchModel`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Model.
genSPICEString: Inherited from ::SpiceGenTcl::Model.

Properties

-name:: Readable, writable. Inherited.
-type:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Model

`constructor`¶

Creates object of class CSwitchModel that describes current switch model.

OBJECT constructor name ?-option value ...?

Parameters

args:: Keyword instance parameters, for details please refer to Xyce reference manual, 2.3.22 section.
name:: Name of the model.

Description

Example of class initialization:

CSwitchModel new cswmod -ion 1 -ioff 0.5 -ron 1 -roff 1e6

`GenS`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

GenSwitch

`GenSwitch`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Device

Subclasses

GenS

`constructor`¶

Creates object of class GenSwitch that describes generic switch device.

OBJECT constructor name np nm -model value -control value ?-on|off?

Parameters

-control value:: Control equation.
-model value:: Model name.
-on/-off:: Initial state of switch.
name:: Name of the device without first-letter designator S.
nm:: Name of node connected to negative pin.
np:: Name of node connected to positive pin.

Description

S<name> <(+) switch node> <(-) switch node> <model name> [ON] [OFF] <control = =ession>

Example of class initialization:

GenSwitch new 1 net1 0 -model sw1 -control {I(VMON)}

`Inductor`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Device

Subclasses

L

`constructor`¶

Creates object of class Inductor that describes inductor.

OBJECT constructor name np nm -l value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value?
OBJECT constructor name np nm -model value -l value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value? ?-ic value?

Parameters

-ic value:: Initial current through inductor, optional.
-l value:: Inductance value.
-m value:: Multiplier value, optional.
-model value:: Model of the inductor, optional.
-tc1 value:: Linear thermal coefficient, optional.
-tc2 value:: Quadratic thermal coefficient, optional.
-temp value:: Device temperature, optional.
name:: Name of the device without first-letter designator L.
nm:: Name of node connected to negative pin.
np:: Name of node connected to positive pin.

Description

Inductor type could be specified with additional switch -model modelName if we want to simulate inductor with model card. Simple inductor:

L<name> <(+) node> <(-) node> <value> [device parameters]

Example of class initialization as a simple inductor:

Inductor new 1 netp netm -l 1e-6 -tc1 1 -temp {-eq temp}

Inductor with model card:

L<name> <(+) node> <(-) node> [model] <value> [device parameters]

Example of class initialization:

Inductor new 1 netp netm -l 1e-6 -model indm

`L`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

Inductor

`LModel`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Model.
genSPICEString: Inherited from ::SpiceGenTcl::Model.

Properties

-name:: Readable, writable. Inherited.
-type:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Model

`constructor`¶

Creates object of class LModel that describes inductor model.

OBJECT constructor name ?-option value ...?

Parameters

args:: Keyword instance parameters, for details please refer to Xyce reference manual, 2.3.5 section.
name:: Name of the model.

Description

Example of class initialization:

LModel new indmod -tc1 1 -tc2 2

`R`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

Resistor

`Resistor`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Device

Subclasses

R

`constructor`¶

Creates object of class Resistor that describes resistor.

OBJECT constructor name np nm -r value ?-tc1 value? ?-tc2 value? ?-tce value? ?-m value? ?-temp value?
OBJECT constructor name np nm -r value -beh ?-tc1 value? ?-tc2 value? ?-tce value? ?-m value? ?-temp value?
OBJECT constructor name np nm -r value -model ?-tc1 value? ?-tc2 value? ?-tce value? ?-m value? ?-temp value? ?-l value? ?-w value?

Parameters

-beh:: Selects behavioural type of resistor, optional.
-l value:: Length of semiconductor resistor, optional.
-m value:: Multiplier value, optional.
-model value:: Model of the resistor, optional.
-r value:: Resistance value or equation.
-tc1 value:: Linear thermal coefficient, optional.
-tc2 value:: Quadratic thermal coefficient, optional.
-tce value:: Exponential thermal coefficient, optional.
-temp value:: Device temperature, optional.
-w value:: Width of semiconductor resistor, optional.
name:: Name of the device without first-letter designator R.
nm:: Name of node connected to negative pin.
np:: Name of node connected to positive pin.

Description

Resistor type could be specified with additional switches: -beh if we want to model circuit’s variable dependent resistor, or -model modelName if we want to simulate resistor with model card. Simple resistor:

R<name> <(+) node> <(-) node> <value> [device parameters]

Example of class initialization as a simple resistor:

Resistor new 1 netp netm -r 1e3 -tc1 1 -temp {-eq temp_amb}

Behavioral resistor:

R<name> <(+) node> <(-) node> R ={expression} [device parameters]

Example of class initialization:

Resistor new 1 netp netm -r "V(a)+V(b)+pow(V(c),2)" -beh -tc1 1

Resistor with model card:

R<name> <(+) node> <(-) node> <model name> [value] [device parameters]

Example of class initialization:

Resistor new 1 netp netm -model resm -l 1e-6 -w 10e-6

`RModel`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Model.
genSPICEString: Inherited from ::SpiceGenTcl::Model.

Properties

-name:: Readable, writable. Inherited.
-type:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Model

`constructor`¶

Creates object of class RModel that describes semiconductor resistor model.

OBJECT constructor name ?-option value ...?

Parameters

args:: Keyword instance parameters, for details please refer to Xyce reference manual, 2.3.7 section.
name:: Name of the model.

Description

Example of class initialization:

RModel new resmod -tc1 1 -tc2 2

`SubcircuitInstance`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Device

Subclasses

X

`constructor`¶

Creates object of class SubcircuitInstance that describes subcircuit instance.

SubcircuitInstance create OBJNAME ?args?
SubcircuitInstance new ?args?

Parameters

name:: Name of the device without first-letter designator X.
params:: List of parameters {{?-eq? paramName paramValue} {?-eq? paramName paramValue}}
pins:: List of pins {{pinName nodeName} {pinName nodeName} ...}
subName:: Name of subcircuit definition.

Description

X<name> [nodes] <subcircuit name> [PARAMS: [<name> = <value>] ...]

Example of class initialization:

SubcircuitInstance new 1 {{plus net1} {minus net2}} rcnet {{r 1} {-eq c cpar}}

#nagelfar implicitvarcmd {argparse Creates object of class ‘SubcircuitInstance’} name pins subName params

`SubcircuitInstanceAuto`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Device

Subclasses

XAuto

`constructor`¶

Creates object of class SubcircuitInstanceAuto that describes subcircuit instance with already created subcircuit definition object.

OBJECT constructor subcktObj name nodes ?-paramName ?-eq? paramValue ...?

Parameters

subcktObj:: Object of subcircuit that defines it’s pins, subName and parameters.
name:: Not documented.
nodes:: List of nodes connected to pins in the same order as pins in subcircuit definition {nodeName1 nodeName2 ...}
args:: Parameters as argument in form: -paramName {?-eq? paramValue} -paramName {?-eq? paramValue}

Description

X<name> [nodes] <subcircuit name> [PARAMS: [<name> = <value>] ...]

Example of class initialization:

SubcircuitInstanceAuto new $subcktObj 1 {net1 net2} -r 1 -c {-eq cpar}

`VSw`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

VSwitch

`VSwitch`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Common::BasicDevices::VSwitch

Subclasses

VSw

`VSwitchModel`¶

Method summary

constructor: Constructor for the class.
configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Model.
genSPICEString: Inherited from ::SpiceGenTcl::Model.

Properties

-name:: Readable, writable. Inherited.
-type:: Readable, writable. Inherited.

Superclasses

::SpiceGenTcl::Model

`constructor`¶

Creates object of class VSwitchModel that describes voltage switch model.

OBJECT constructor name ?-option value ...?

Parameters

args:: Keyword instance parameters, for details please refer to Xyce reference manual, 2.3.22 section.
name:: Name of the model.

Description

Example of class initialization:

VSwitchModel new swmod -von 1 -voff 0.5 -ron 1 -roff 1e6

`W`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

CSwitch

`X`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

SubcircuitInstance

`XAuto`¶

Method summary

configure: Configure properties. See ::oo::configuresupport::configurable.
actOnParam: Inherited from ::SpiceGenTcl::Device.
actOnPin: Inherited from ::SpiceGenTcl::Device.
checkFloatingPins: Inherited from ::SpiceGenTcl::Device.
genSPICEString: Inherited from ::SpiceGenTcl::Device.

Properties

-name:: Readable, writable. Inherited.

Superclasses

SubcircuitInstanceAuto

Copyright (c) George Yashin

::SpiceGenTcl::Xyce::BasicDevices¶

Classes¶

`C`¶

`Capacitor`¶

`constructor`¶

`CModel`¶

`constructor`¶

`CSwitch`¶

`CSwitchModel`¶

`constructor`¶

`GenS`¶

`GenSwitch`¶

`constructor`¶

`Inductor`¶

`constructor`¶

`L`¶

`LModel`¶

`constructor`¶

`R`¶

`Resistor`¶

`constructor`¶

`RModel`¶

`constructor`¶

`SubcircuitInstance`¶

`constructor`¶

`SubcircuitInstanceAuto`¶

`constructor`¶

`VSw`¶

`VSwitch`¶

`VSwitchModel`¶

`constructor`¶

`W`¶

`X`¶

`XAuto`¶

Table of Contents

Previous topic

Next topic

This Page

::SpiceGenTcl::Xyce::BasicDevices¶

Classes¶

C¶

Capacitor¶

constructor¶

CModel¶

constructor¶

CSwitch¶

CSwitchModel¶

constructor¶

GenS¶

GenSwitch¶

constructor¶

Inductor¶

constructor¶

L¶

LModel¶

constructor¶

R¶

Resistor¶

constructor¶

RModel¶

constructor¶

SubcircuitInstance¶

constructor¶

SubcircuitInstanceAuto¶

constructor¶

VSw¶

VSwitch¶

VSwitchModel¶

constructor¶

W¶

X¶

XAuto¶

`C`¶

`Capacitor`¶

`constructor`¶

`CModel`¶

`constructor`¶

`CSwitch`¶

`CSwitchModel`¶

`constructor`¶

`GenS`¶

`GenSwitch`¶

`constructor`¶

`Inductor`¶

`constructor`¶

`L`¶

`LModel`¶

`constructor`¶

`R`¶

`Resistor`¶

`constructor`¶

`RModel`¶

`constructor`¶

`SubcircuitInstance`¶

`constructor`¶

`SubcircuitInstanceAuto`¶

`constructor`¶

`VSw`¶

`VSwitch`¶

`VSwitchModel`¶

`constructor`¶

`W`¶

`X`¶

`XAuto`¶