Diff of /doc/devel/mainpage.h [b2fbb0] .. [105ed6]  Maximize  Restore

Switch to side-by-side view

--- a/doc/devel/mainpage.h
+++ b/doc/devel/mainpage.h
@@ -19,10 +19,19 @@
 \li Circuit: a set of components and connectors
 \li Simulator: class that simulates the behaviour of a circuit
+\li CNode: component node, used in simulation, might stand for many Pins;
+    CNode:Pin -> 1:many
+\li Circuit Model: the storage place for the description of the structure and status of a circuut
+\li *Item: graphical classes, inherited from QGraphicsItem
 \section src_org Organization of the source code
 KTechLab internally is based on KDevPlatform.
-See http://www.kdevelop.org/mediawiki/index.php/KDevelop_4#Platform_Information
+See http://www.kdevelop.org/mediawiki/index.php/KDevelop_4#Platform_Information .
 The source code has similar layout as the above mentioned platform.
 It uses plugins.
@@ -54,6 +63,173 @@
+\subsection electr_simulation Workings of circuit simulation
+When an electronic circuit is simulated, the following processes take place:
+\li user interaction with the circuit: the model is changed in order to reflect the new situation;
+    event flow: user -> gui -> circuit scene -> model -> simulator update, based on the model
+\li visual representation redraw: the components are drawn periodically;
+    event flow: gui refresh timer ticks -> drawing performed, based only the state of the model;
+    approximate timer frequency: less than 50 - 60 Hz
+\li simulation time advance: time passes, so some signals (current, voltage) might change;
+    event flow: simulation timer ticks -> simulator calculates new voltage and current values ->
+        simulator stores the calculated values in the model
+The CircuitModel, subclass of IDocumentModel, currently consists of a set of components and connectors,
+both having the type of QVariantMap.
+Models of components have the base type IElement. This interfaces has references to
+IPins, and IPins are connected with IWires.
+CNode and CBranch are used in the internal workings of the simulator, so those
+are not supposed to be exported from the simulator plugin.
+\li Component:IElement -- 1:many
+\li IElement:IPin -- 1:many
+\li IPin:CNode -- many:1
+During one time step, in the simulation of a circuit the following steps
+have to be taken:
+\li if the circuit model is changed, the simulator data structures
+    (IPins, IWires and IElements) have to be rebuilt.
+    Next, the number of nodes is reduced, due to connections.
+    Here the CNodes and CBranches are used.
+    Some nodes are marked pure digital, others are analogic.
+    Finally, the circuit equations are created from the IElements.
+\li the simulation time is incremented
+\li the circuit equations are created from the IElements
+\li next, the digital logic is stepped once, and the resulting voltages
+    are saved
+\li the digital values are stored in the matrix and the matrix equations
+    are solved for the currents and voltages
+\li if the circuit contains nonlinear or reactive elements, the process of
+    stepping analog components and solving of the matrix has to be repeated.
+\li having the currents and the voltages from CNodes and CBranches known,
+    by using Kirchoff's equations, the voltages and currents in
+    IPins and IWires have to be calculated
+\li the final voltages and currents are stored in the circuit model
+The simulation usese the Modified Nodal Analysis. See as reference:
+\li http://en.wikipedia.org/wiki/Modified_nodal_analysis
+\li http://qucs.sourceforge.net/tech/technical.html
+Theoretical part, shamelessly copied from the the second link
+Suppose a circuit has
+\li N nodes
+\li M independent voltage sources
+The structure of the circuit equation matrix:
+[ A ] * [ x ] = [ z ]
+[ G B ] * [ v ] = [ i ]
+[ C D ]   [ j ]   [ e ]
+The matixes are:
+\li A - (N+M)*(N+M) matrix, consists only of known quantities
+\li x -  (N+M)*1 vector, holds the unknown quantities
+            (node voltages and
+            the currents through the independent voltage sources)
+\li z - is an (N+M)*1 vector that holds only known quantities
+The A matrix consists of:
+\li G - N*N matrix, determined by the interconnections between the circuit elements
+\li B - N*M matrix, determined by the connection of the voltage sources
+\li C - M*N matrix, determined by the connection of the voltage sources
+        (B and C are closely related, particularly when only independent sources are considered)
+\li D - M*M matrix, is zero if only independent sources are considered
+The x matrix, storing the unkown values, consists of:
+\li v - 1*N, matrix of unknown voltages in the nodes
+\li j - 1*M, matrix of unknown currents through the voltage sources
+The z matrix consists of:
+\li i - 1*N matrix with each element of the matrix corresponding to a particular node.
+        The value of each element of i is determined by the sum of current sources
+        pointing into the corresponding node.
+        If there are no current sources connected to the node, the value is zero.
+\li e - 1*M matrix with each element of the matrix equal in value
+        to the corresponding independent voltage source.
+In the implementation,
+the e part of the matrix z is called v.
+The equation A*x = b is stored in matrixes, contained in an IElementSet.
+The IElementSet allocates A,x and b matrixes of the needed size, and
+assigns rows and columns for all IElements.
+This way the base type IElement provides methods to translate
+the number of the IPins
+belonging to the element into positions in the matrixes.
+\subsubsection sim_obj_hierarchy Object allocation hierarchy in the simulator
+Inside the simulator, many objects are created and
+many objects hold pointers to other objects.
+However, it must be clearly defined, which object creates
+a new object of a given type and role,
+and the same creator object should destruct the created object.
+This subsection presents such relations between the classes.
+\li m_allElementList: all elements in the simulation
+\li m_allWireList: all wires in the simulation
+\li m_pinGroups: all PinGroup objects
+\li m_pins: the pins of the specific element
+\section component_map Key / Value pairs used in component models
+In the document model there are components and connectors.
+Both are are stored as QVariantMap.
+This section describes the stucture of these QVariantMaps.
+Generally, the QVariantMap returned by
+IDocumentModel::components() and
+is a map ID -> QVariantMap, where
+ID is idenfidier of the component, and the value is
+a QVariantMap describing the component and connector.
+The following subsections document the QVariantMaps used in different types
+of documents.
+\subsection circuit_qvariantmaps Circuit document
+\subsubsection circuit_generic_maps Generic components
+\li angle: 0, 90, 180, 270: the angle of rotation of a component
+\li fileName: the name of the graphics, representing the component
+\li flip: 0 or 1
+\li id: the ID of the component
+\li type: the type of the component
+\li x: X coordinate of the component
+\li y: Z coordinate of the component
+\li z: Z coordinate of the component, this represents the drawing order
+\subsubsection circuit_connector_maps Connectors
+\li end-node-cid
+\li end-node-is-child: 0 or 1
+\li end-node-parent
+\li id
+\li manual-route: 0 or 1
+\li route: string or point coordinates
+\li start-node-cid: 0 or 1
+\li start-node-parent
+\subsection flowcode_qvariantmaps Flowcode documents
 \section new_elements Adding support for new Elements (component models)

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.

No, thanks