alexius-huang / thevenin Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 1.81 MB

An elegant circuitry simulation website

TypeScript 92.42% JavaScript 2.15% CSS 5.44%

typescript circuit-simulation graph-algorithm circuit nextjs jest

thevenin's Introduction

Thévenin

An elegant circuitry simulation website.

Overall Status: Under Development

Details

Using TypeScript and working on several parts:

Main Circuit Library:
- Circuit: Main wrapper for the circuit simulation
- Circuit.Unit: Circuit grid system represented by circuit-unit to place different components or wire
- Circuit.Electronic: Electronic component class
- Circuit.Electronic.Unit: Electronic component unit mapping with respect to the grid circuit unit
- Circuit.Graph: The graph data structure to represent the circuit (converted from grid of Circuit.Unit)
- Circuit.GaussianElimination: Implementation of Gaussian Elimination method for determine the result of multi-variable equations by representing and solving the matrix
- Circuit.Equation: Construct node-voltage equation
- Circuit.SimultaneousEquations: Collection of node-voltage equations and solve by Gaussian Elimination
- Circuit.Simulation: The circuit simulation algorithm part using Nodal Voltage Analysis which consists of several phases including:
  - Supernode Propagation - Propagates through the circuit graph generated from Circuit.Graph and convert voltage source related Circuit.Graph.Node into a single super node with different biased voltage
  - Node-Voltage Matrix Derivation - Deriving the node voltage matrix to solve for each components' (represented by Circuit.Graph.Edge) current values (based on KCL from Kirchhoff's Circuit Law)
  - [TBD] Ending Phase - After deriving the current of the loads such resistors, scanning through the circuit and derive rest of the node-voltage and other underived component's current according to KVL and KCL
Using Jest test framework to write Unit/Integration tests
[Will Implement After Completing the Circuit Library] Frontend UI: Using Next.JS framework, Redux (with TypeScript)
- Details will be planned on the future...

Maintainer

Maxwell Alexius

thevenin's People

Contributors

Stargazers

Watchers

thevenin's Issues

[UI] Wiring Feature

Able to attach wires on the circuit grid points.

Implement Electronics Interface

Electronics interface may include:

the count of terminals
occupied space such as (1 x 2), (3 x 2) or (1 x 1)
terminals' location in electronic component
orientation (default is face left?)

Handling Undetermined Analyze Results

When running the circuit simulation, if the circuit is not determined for some reason, it should instead terminate the execution and show the message that the circuit for some reason cannot be simulated.

[Exception] Virtually Short-Circuited When Doing Gaussian Elimination

For instance, a Wheatstone Bridge with all resistors with value 1k Ohms resulted in the middle resistor has no current flow through it. It won't solve the Gaussian Elimination case and the result won't converge.

There has to be a mechanism to rearrange the circuit and short the node and reanalyze the whole circuit again.

[Simulation] Shouldn't Run Simulation When No Reference Voltage Point

When no Ground component is presented, it should not run any circuit simulations.

[Bug] Won't Terminate When Analyzing Single Node Condition

The simulation won't terminate during circuit simulation.

[UI] Circuit Scalability

Able to control the scale of the circuit grid points.

[To Be Fixed] Electronic Rotation Behaviour

After rotating the electronic component, it should also check if it can be attached on the circuit again.

[UI] Able to Show and Adjust Electronic Component Properties

As the topic suggests, there must be an interface to show the electronic component's value and adjust it.

[UI] Able to Remove Wire and Electronic Components

As the topic suggests, we are able to detach the electronic component or cut down the wire

[UI] Electronic Component Tool Selection

After selecting a particular electronic component on the side-tool, it should:

Show which kind of electronic is selected
Highlight the selected electronic component
Able to directly select another electronic component without deselecting the original one

Implement Complex Number Lib

Implement Complex number lib. Should write tests and satisfy the following spec:

Should include member variables:

<Complex>.re: number: Real part
<Complex>.im: number: Imaginary part
<Complex>.degree: number: Degree of the complex number in complex-plane
<Complex>.radian: number: Radian of the complex number in complex-plane
<Complex>.length: number: Length of the complex number
<Complex>.coordinate: string: Coordinate representation of the complex number
<Complex>.polar: string: Polar representation of the complex number

Should include member methods:

<Complex>.inverse(): Complex: Returns new Complex object with the inversed complex number
<Complex>.conjugate(): Complex: Returns new Complex object with conjugated version
<Complex>.transpose(): Complex
<Complex>.add(c: Complex): Complex
<Complex>.subtract(c: Complex): Complex
<Complex>.multiply(c: Complex): Complex
<Complex>.divide(c: Complex): Complex
<Complex>.scale(rate: number): Complex
<Complex>.rotate(radian: number): Complex
<Complex>.rotateDeg(degree: number): Complex

Should include static methods:

<Complex>#fromPolar(length: number, radian: number): Complex
<Complex>#fromPolarDeg(length: number, degree: number): Complex
<Complex>#fromCoord(re: number, im: number): Complex

[UI] Zoom Feature

Able to zoom in/out the circuit simulation interface