How ranphe/circuitsim works
Project Type and Purpose
• CircuitSim is a standalone desktop Java application with a Swing-based GUI for interactively visualizing and analyzing electrical circuits via the Modified Nodal Analysis (MNA) method.
• It reads a plain-text circuit description, builds an in-memory representation of components and nodes, computes node voltages, lays out the circuit graphically, and lets users export the result as a PNG.
High-Level Components
a. User Interface Layer
• Main (entry point that initializes the GUI)
• PanelCircuito (Swing JPanel that renders and handles user interactions)
• Menu/Options (Load dialog, Export action)
b. Input Parsing
• CircuitoParser (reads *.txt file, tokenizes lines, constructs Componente and Nodo objects)
c. Domain Model
• Componente (abstract base for R, C, F sources)
• Nodo (circuit node with identifiers and computed voltages)
• ValorElectrico (encapsulates numeric values, units)
d. Analysis Engine
• MNA (assembles conductance/current matrices, solves linear system for node voltages)
e. Layout Engine
• LayoutCircuito (BFS-based algorithm that assigns (x,y) positions to nodos for clear visualization)
f. Utilities
• Exporter (writes current JPanel as PNG) – implicit in PanelCircuito
• Prueba (test harness / debug entry)
g. Data Flow / Dependencies
• Main → UI
• UI “Load” → CircuitoParser → Domain Model
• Domain Model → MNA → voltages populated in Nodo
• Domain Model + voltages → LayoutCircuito → positional data
• Layout + Domain Model → PanelCircuito.render() → screen & optional PNG
Architectural Patterns and Design Principles
• Layered architecture: UI ←→ Parser ←→ Domain ←→ MNA ←→ Layout
• Separation of concerns: parsing, data modeling, numerical analysis, layout, and rendering are in separate classes/packages.
• In-memory model: all data lives in Java objects; no external database.
• Event-driven GUI on Swing’s EDT (Event Dispatch Thread).