Internals¶

Where possible Lcapy performs lazy evaluation and caches the results. The cached results (except for Laplace and Fourier transformations) are cleared whenever a netlist is modified.

Circuits¶

Circuits are represented using netlists of Mnacpt classes. These are wrappers around Oneport classes. Analysis is performed with modified nodal analysis (MNA). State-space representations can be generated but this is not used for calculating node voltages or branch currents.

Sub-circuits¶

When a circuit contains independent sources of different types, e.g., AC and DC, it decomposes the circuit into a sub-circuits for each type. These are evaluated independently and the results superimposed using the Voltage class for voltages and the Current class for currents.

Networks¶

Networks are comprised of Oneport and Twoport components and are stored as an abstract syntax tree (AST).

The main attributes are Voc (open-circuit s-domain voltage), Isc (short-circuit s-domain voltage), Z (s-domain impedance), Y (s-domain admittance). In addition, I is the current through the one-port terminals (zero by definition) and V is equivalent to the open-circuit voltage Voc.

Formerly all Oneport components were either a Thevenin or Norton component. As these components were combined (in series or parallel) a new Thevenin or Norton component was created. This was efficient and worked well. It was also more robust when converting zero impedances to admittances and vice-versa. For example, 1 / (1 / 0) should give 0. However, it is tricky to handle superposition of multiple independent sources, say AC and DC. So instead, the same circuit analysis is performed as for Circuit objects by converting the network to a netlist.

Values and expressions¶

Lcapy uses a number of classes to represent a value or expression. These classes all inherit from the Expr base class; this is a facade for a SymPy expression. Unfortunately, SymPy does not provide a generic SymPy expression class so Expr stores the SymPy expression as its expr attribute.

Expr is the base class for Lcapy expressions. There are a number of classes that inherit from this class:

ConstantExpression represents a constant, such as the resistance of a resistor. The constant must be real and positive.

TimeDomainExpression represents a time domain expression. This should be real.

LaplaceDomainExpression represents an s-domain expression. This can be complex.

AngularFourierDomainExpression represents an angular frequency domain expression. This can be complex.

FourierDomainExpression represents a frequency domain expression. This can be complex.

FourierDomainNoiseExpresssion represents a noise expression (amplitude spectral density). This is real.

AngularFourierDomainNoiseExpresssion represents a noise expression (amplitude spectral density). This is real.

Quantity expression classes¶

There are many classes that inherit from the Expr classes that include implicit units, such as voltage or current. For example, the following classes all inherit from LaplaceDomainExpression:

LaplaceDomainVoltage is a s-domain voltage.

LaplaceDomainCurrent is a s-domain current.

LaplaceDomainTransferFunction is a s-domain transfer function.

LaplaceDomainImpedance is a s-domain impedance.

These classes are dynamically generated as required (see expressionclasses.py).

Superposition classes¶

Superposition represents a superposition of different domains. This is the default representation for calculated results from circuit analysis. There are two classes that inherit from Superposition:

SuperpositionVoltage represents a superposition of voltages.

SuperpositionCurrent represents a superposition of currents.

Container classes¶

Matrix represents a generic matrix.

TimeDomainMatrix represents a matrix of time domain expressions (each element is TimeDomainExpression).

LaplaceDomainMatrix represents a matrix of s-domain expressions (each element is LaplaceDomainExpression).

Vector represents a generic column vector.

ExprDict represents a dictionary of Expr instances.

ExprList represents a list of Expr instances.

ExprTuple represents a tuple of Expr instances.

Expression manipulation¶

>>> cos(x).rewrite(exp) ->  exp(j*x) / 2 + exp(-j*x)/2
>>> (exp(j*x) / 2 + exp(-j*x)/2).rewrite(cos) -> cos(x)
>>> (exp(j*x) / 2 + exp(-j*x)/2).rewrite(sin) -> cos(x)


Symbols¶

Consider the two expressions:

>>> x1 = sym.symbols('x')
>>> x2 = sym.symbols('x', real=True)


SymPy regards x1 and x2 as being different since the symbol x is defined with different conditions. Thus x1 - x2 does not simplify to zero. To overcome this problem, Lcapy maintains a symbol cache and tries to replace symbols with their first definition. The downside is that this may prevent simplification if the symbol is first defined without any conditions.

Lcapy maintains a set of symbols for each circuit plus a set of additional symbols defined when creating other objects, such as V or C. Symbol names are converted into a canonical format, V1 -> V_1, when they are printed.

Assumptions are useful for SymPy to simplify expressions. For example, knowing that a symbol is real or real and positive.

Assumptions¶

Assumptions are required to simplify expressions and to help with inverse Laplace transforms.

There are two types of assumptions:

1. Assumptions used by SymPy, such as real, positive, etc.

2. Assumptions used by Lcapy, such as dc, real, causal, etc.

SymPy assumptions¶

To confuse matters, SymPy has two assumptions mechanisms, old and new. The old method attaches attributes to symbols, for example,

>>> from sympy import Symbol, Q, exp, I, pi
>>> x = Symbol('x', integer=True)
>>> z = exp(2 * pi * I * x)


The simplify function (or method) uses these attributes.

The new method stores facts, these need not just be about symbols, for example,

>>> from sympy import Symbol, Q, exp, I, pi
>>> from sympy.assumptions.assume import global_assumptions

>>> x = Symbol('x')
>>> z = exp(2 * pi * I * x)
>>> z = z.refine()


The new method has the advantage that we can collect facts about a symbol, say from different nets in a netlist. Since they refer to the same symbol, there is no problem updating these facts. The big problem is how to deal with context, say if we are analysing two circuits at the same time. The simplest approach is to create a context for each circuit and to switch the global_assumptions.

A resistor should have a positive resistance, but what about {a - b}. We could add an assumption that a - b > 0 but we cannot assume that both a and b are positive. Unfortunately, this is the status quo but is uncommon.

Lcapy assumptions¶

Lcapy expressions have associated assumptions, ac, dc, and causal. These influence how the result of an inverse Laplace transform is determined for $$t < 0$$.

These assumptions are currently not propagated during expression manipulation. If so, do we check the assumptions during tests for equality?

Rather than propagating assumptions, Lcapy assigns them to expressions after circuit analysis.

1. Define in grammar.py.

2. Add class in mnacpts.py for simulation.

3. Add class in schemcpts.py for drawing.

Schematic layout¶

The current layout algorithm assumes that all one-port components such as resistors and diodes are stretchy. The x and y positions of component nodes are determined independently using directed acyclic graphs.

The steps of the algorithm are:

1. Construct a graph where the edges are the components. Electrical nodes with a common x or y position are combined to reduce the graph size.

2. Find longest path through graph. This determines the maximum dimension. Nodes along this longest path are assigned positions based on the maximum distance from the start. Note, there may be multiple parallel paths of the same length; it does not matter which is chosen.

3. For each component with an unknown position, find the longest path in both forward and backward directions to a node with a known position. This path is traversed counting the number of stretchy components and summing their sizes. Using the distance between the positions of the known nodes the stretch per stretchy component can be calculated and thus the position of the node. If the component has a dangling node the stretch is zero.

Schematic sizing¶

The default node spacing is 2 units where the default unit for PGF/Tikz macros is 1 cm. By default Circuitikz uses a default bipole length of 1.4 cm; this produces resistors with a zig-zag of length 1.16 units. Lcapy sets the default bipole length to 1.5 cm; this results in a zig-zag of length of 1.2 cm. The bipole length can be changed used the cpt_size argument.

Schematics are displayed in notebooks using bit-mapped PNG files (since SVG does not properly work). There are two steps:

1. A PDF file is created using pdflatex from the Circuitikz macros.

2. The PDF file is converted to a bit-mapped PNG file.

pdflatex (Tex live) uses pdfpkresolution=600 to produce a PDF document with 600 dots per inch (dpi). The output file dimensions are in points (72 points to the inch).

The PDF is converted to a PNG using Image Magick convert with a default density of 150 dpi (-density 150). This uses ghostscript with -r 150x150 to do the image conversion.

For example, a resistor by default will be 2 cm long (node to node). This is equivalent to 0.787 inch. With dpi=150, the resultant PNG is 118 pixels wide.

Customisation¶

Most configuration options are defined in config.py.

Debugging¶

The Python debugger (pdb) can be invoked when a unit test fails using:

\$ pytest --pdb


Expressions¶

The underlying SymPy expression can be found with the .expr attribute. The Lcapy assumptions are listed with the .assumptions attribute. The SymPy assumptions are listed with .expr.assumptions0. The symbols used in an expression can be found using the .symbols attribute.

All the known symbols can be found using:

>>> cct.context.symbols


The .pdb() method of an Expr instance invokes the Python debugger (pdb).