pingspice.lib.passive.WirePair(Wire)
class documentation
Part of pingspice.lib.passive
(View In Hierarchy)
A wire pair with a particular awg gauge and length in
meters (unless inches is set True
), optionally with an
additional gap (in mm) between the wires:
a0 <--- R - L ---> a1 b0 <--- R - L ---> b1
This is mostly for modeling high-current behavior at relatively low frequencies.
If you want to use a ground reference on both ends, just set
gndRef True
and the single pair of nodes 'a0', 'a1'
will have the R and L for both wires.
Inductors often cause convergence errors in SPICE. To ignore the
inductance (and capacitance) of the wire pair, set R_only
True
.
Method | nodes | Undocumented |
Method | sep | Undocumented |
Method | L | Returns inductance (Henries) per meter of two adjacent wires given their wire gauges. |
Method | C | Returns capacitance (Farads) per meter between two adjacent wires given their common length in meters (unless inches is set) and wire gauges. |
Method | txLine | Lossy transmission line. |
Method | RLC_unbal | Undocumented |
Method | RLC_bal | Undocumented |
Method | setup | Subcircuit definition. |
Method | _awgs | Undocumented |
Inherited from NodeStuff (via Wire, Subcircuit):
Instance Variable | shunts | A dict of current sensing V elements with the pairs of nodes they connect. |
Class Variable | debug | A Bag that gets set
True for all instances to log info about each setup
call. |
Class Method | autoName | Undocumented |
Method | setupResults | Undocumented |
Method | fill | Undocumented |
Method | nodeCheck | Call with the circuit building tool f and a sequence of
nodes provided to this Include or
Subcircuit . |
Method | rawNetlist | Get lines of a raw netlist from a search hierarchy of possible sources. |
Method | shunt | Call to insert a current-measuring shunt and add an entry to my Elements
baton's dict of shunts. |
Method | raw | See Elements.raw . |
Method | iNode | See Elements.iNode . |
Method | ground | See Elements.ground . |
Method | sca | See Elements.sca . |
Method | sca6 | See Elements.sca6 . |
Class Method | _libDir | Undocumented |
Method | _strippedLines | Undocumented |
Method | _call_setup | Calls my setup
method (almost always your override of that method, actually) and processes
any return value. |
Inherited from NodeStuff (via Wire, Subcircuit):
Instance Variable | shunts | A dict of current sensing V elements with the pairs of nodes they connect. |
Class Variable | debug | A Bag that gets set
True for all instances to log info about each setup
call. |
Class Method | autoName | Undocumented |
Method | setupResults | Undocumented |
Method | fill | Undocumented |
Method | nodeCheck | Call with the circuit building tool f and a sequence of
nodes provided to this Include or
Subcircuit . |
Method | rawNetlist | Get lines of a raw netlist from a search hierarchy of possible sources. |
Method | shunt | Call to insert a current-measuring shunt and add an entry to my Elements
baton's dict of shunts. |
Method | raw | See Elements.raw . |
Method | iNode | See Elements.iNode . |
Method | ground | See Elements.ground . |
Method | sca | See Elements.sca . |
Method | sca6 | See Elements.sca6 . |
Class Method | _libDir | Undocumented |
Method | _strippedLines | Undocumented |
Method | _call_setup | Calls my setup
method (almost always your override of that method, actually) and processes
any return value. |
Inherited from NodeStuff (via Wire, Subcircuit):
Instance Variable | shunts | A dict of current sensing V elements with the pairs of nodes they connect. |
Class Variable | debug | A Bag that gets set
True for all instances to log info about each setup
call. |
Class Method | autoName | Undocumented |
Method | setupResults | Undocumented |
Method | fill | Undocumented |
Method | nodeCheck | Call with the circuit building tool f and a sequence of
nodes provided to this Include or
Subcircuit . |
Method | rawNetlist | Get lines of a raw netlist from a search hierarchy of possible sources. |
Method | shunt | Call to insert a current-measuring shunt and add an entry to my Elements
baton's dict of shunts. |
Method | raw | See Elements.raw . |
Method | iNode | See Elements.iNode . |
Method | ground | See Elements.ground . |
Method | sca | See Elements.sca . |
Method | sca6 | See Elements.sca6 . |
Class Method | _libDir | Undocumented |
Method | _strippedLines | Undocumented |
Method | _call_setup | Calls my setup
method (almost always your override of that method, actually) and processes
any return value. |
def L(self):
Returns inductance (Henries) per meter of two adjacent wires given their wire gauges.
You can include an additional air gap (in mm) between the wires, on average. For example, use gap=4 for loosely bundled heavy wires.
def C(self):
Returns capacitance (Farads) per meter between two adjacent wires given their common length in meters (unless inches is set) and wire gauges.
You can include an additional air gap (in mm) between the wires, on average. For example, use gap=4 for loosely bundled heavy wires.
An average radius of the two wires is used, which may not be accurate if they are very different.
Subcircuit definition.
Why use f? Because it's short and a conveniently typed letter on the keyboard.
Override this if your subclass does not reference a param.ParameterFinder
subclass via the Finder class attribute. As with Include.setup
,
your override method can return a dict of attribute names and values to set
in my instance.