Added KDE3 version of ktechlab

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/ktechlab@1095338 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 131 insertions, 0 deletions

diff --git a/src/electronics/simulation/elementset.h b/src/electronics/simulation/elementset.h
new file mode 100644
index 0000000..c7ef7ca
--- /dev/null
+++ b/src/electronics/simulation/elementset.h
@@ -0,0 +1,131 @@
+/***************************************************************************
+ *   Copyright (C) 2003-2004 by David Saxton                               *
+ *   david@bluehaze.org                                                    *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ ***************************************************************************/
+
+#ifndef ELEMENTSET_H
+#define ELEMENTSET_H
+
+#include <vector>
+
+#include <qvaluelist.h>
+
+class CBranch;
+class Circuit;
+class CNode;
+class Element;
+class ElementSet;
+class LogicIn;
+class Matrix;
+class NonLinear;
+class Vector;
+
+typedef QValueList<Element*> ElementList;
+typedef QValueList<NonLinear*> NonLinearList;
+
+/**
+Steps in simulation of a set of elements:
+(1) Create this class with given number of nodes "n" and voltage sources "m"
+(2) Add the various elements with addElement.
+(3) Call performDC()
+(4) Get the nodal voltages and voltage currents with x()
+(5) Repeat steps 3 and 4 if necessary for further transient analysis.
+
+This class shouldn't be confused with the Circuit class, but considered a helper class to Circuit.
+Circuit will handle the simulation of a set of components over time. This just finds the DC-operating
+point of the circuit for a given set of elements.
+
+@short Handles a set of circuit elements
+@author David Saxton
+*/
+class ElementSet
+{
+public:
+	/**
+	 * Create a new circuit, with "n" nodes and "m" voltage sources.
+	 * After creating the circuit, you must call setGround to specify
+	 * the ground nodes, before adding any elements.
+	 */
+	ElementSet( Circuit * circuit, const int n, const int m );
+	/**
+	 * Destructor. Note that only the matrix and supporting data is deleted.
+	 * i.e. Any elements added to the circuit will not be deleted.
+	 */
+	~ElementSet();
+	Circuit * circuit() const { return m_pCircuit; }
+	void addElement( Element *e );
+	void setCacheInvalidated();
+	/**
+	 * Returns the matrix in use. This is created once on the creation of the ElementSet
+	 * class, and deleted in the destructor, so the pointer returned will never change.
+	 */
+	Matrix *matrix() const { return p_A; }
+	/**
+	 * Returns the vector for b (i.e. the independent currents & voltages)
+	 */
+	Vector *b() const { return p_b; }
+	/**
+	 * Returns the vector for x (i.e. the currents & voltages at the branches and nodes)
+	 */
+	Vector *x() const { return p_x; }
+	/**
+	 * @return if we have any nonlinear elements (e.g. diodes, tranaistors).
+	 */
+	bool containsNonLinear() const { return b_containsNonLinear; }
+	/**
+	 * Solves for nonlinear elements, or just does linear if it doesn't contain
+	 * any nonlinear.
+	 */
+	void doNonLinear( int maxIterations, double maxErrorV = 1e-9, double maxErrorI = 1e-12 );
+	/**
+	 * Solves for linear and logic elements.
+	 * @returns true if anything changed
+	 */
+	bool doLinear( bool performLU );
+	CBranch **cbranches() const { return m_cbranches; }
+	CNode **cnodes() const { return m_cnodes; }
+	CNode *ground() const { return m_ground; }
+	/**
+	 * Returns the number of nodes in the circuit (excluding ground 'nodes')
+	 */
+	int cnodeCount() const { return m_cn; }
+	/**
+	 * Returns the number of voltage sources in the circuit
+	 */
+	int cbranchCount() const { return m_cb; }
+	
+	void createMatrixMap();
+	/**
+	 * Displays the matrix equations Ax=b and J(dx)=-r
+	 */
+	void displayEquations();
+	/**
+	 * Update the nodal voltages and branch currents from the x vector
+	 */
+	void updateInfo();
+	
+private:
+	Matrix *p_A;
+	Vector *p_x;
+	Vector *p_x_prev;
+	Vector *p_b;
+	uint m_cn;
+	uint m_cb;
+	ElementList m_elementList;
+	NonLinearList m_cnonLinearList;
+	CBranch **m_cbranches; // Pointer to an array of cbranches
+	CNode **m_cnodes; // Pointer to an array of cnodes
+	CNode *m_ground;
+	uint m_clogic;
+	LogicIn **p_logicIn;
+	bool b_containsNonLinear;
+	Circuit * m_pCircuit;
+};
+
+#endif
+