pingspice.examples.boost.Circuit(Include) class documentation

The overall simulated circuit, including connecting wires and a duty cycle control voltage source.

For the sake of simplicity and avoiding a non-convergence nightmare, the ground for this circuit is the perfect simulation ground (node 0). Some realism is sacrificed for this, of course, because the copper foil used as a ground plane in the actual circuit has non-zero impedance and that lumps of that impedance are present between leads of components ostensibly connected to "ground."

Note: There are two additional nodes in the circuit that will be examined and post-simulation analysis: 'amps_in' and 'amps_out'. These nodes are not included in my constructor arguments because those are passed on as-is to the Boost subcircuit. It doesn't matter what additional nodes are defined in my setup method and whether they are examined or not, because all nodes in an Include are considered "public."

There are two purposes of defining nodes in a constructor, or as a class attribute nodes, of an Include. The first is to pass them on to the setup method as arguments following the circuit-building tool f. That makes it convenient to define local variables in the method. See analysis.capacitance.FastChargeCap and analysis.capacitance.Initializer for examples.

The second purpose is to allow pingspice to check that all the predefined nodes are actually connected. An exception is raised if any node defined in the constructor or nodes class attribute are not connected in some way by the setup method. This is valuable because failure to do so can result in some Ngspice convergence problems that are very difficult to troubleshoot.