simplipfy.SimplifyInUserOrder package

Submodules

simplipfy.SimplifyInUserOrder.simplifierStates module

class simplipfy.SimplifyInUserOrder.simplifierStates.SimplifierStates(*values)

Bases: Enum

KirchhoffStates is an enumeration that defines the possible states of a Kirchhoff equation. Those are used for error handling/ error messages in the frontend.

delta = 'delta'

static fromCptRelation(state: ComponentRelation) → SimplifierStates

inParallel = 'inParallel'

inSeries = 'inSeries'

notInRelation = 'notInRelation'

notParallel = 'notParallel'

notSeries = 'notSeries'

star = 'star'

to_string()

undefined = 'undefined'

simplipfy.SimplifyInUserOrder.solvInUserOrder module

class simplipfy.SimplifyInUserOrder.solvInUserOrder.SolveInUserOrder(filename: str, filePath='', langSymbols: dict = {})

Bases: object

property Solution: Solution

createInitialStep() → Step0ExportDict: create the initial step / step0 of the circuit :returns: Step0ExportDict with the circuit information of step0

createStep0() → Step0ExportDict: create the initial step / step0 of the circuit :returns: Step0ExportDict with the circuit information of step0

getSolution() → <property object at 0x000001AA808CB380>: Get a copy of the solution object that is used in this class

getStep(step: str) → ExportDictBase

isSimplified() → bool: Returns True if no more series or parallel simplifications are possible

netlist(step: str) → str

simplifyNCpts(cpts: list, rel: ComponentRelation | Literal['auto'] = 'auto') → ExportDict

Param:: cpts list with n component names to simplify e.g., [“R1”, “R2”, “R3” …]
Param:: rel relation in which the n components are supposed to be simplified, allowed strings defined in ComponentRelation or auto for automatic where a simplification is done if it is possible.
Returns:: ExportDict with the circuit information for the step

Module contents

Module used to solve a circuit using analitic method where the circuit is simplified to a total resistance using series and parallel relationships of the components. The simplification steps are based on user input in form of selected component names. The module is implemented with lcapy. The project uses a slightly modified version named lcapyInskale to support stepwise solving of the circuit and extract solutions.