MCPcopy Create free account
hub / github.com/SLiCAP/SLiCAP_python / doMatrix

Function doMatrix

SLiCAP/SLiCAPshell.py:378–427  ·  view source on GitHub ↗

Returns the MNA matrix, the vector with dependent variables and the vector with independent variables. :return: SLiCAP results object of which the following attributes with be set as a result of this instruction: :rtype: SLiCAP.SLiCAPinstruction.instruction o

(cir, source='circuit', detector='circuit', lgref='circuit', 
            transfer=None, convtype=None, pardefs=None, numeric=False, 
            stepdict=None)

Source from the content-addressed store, hash-verified

376 return cir
377
378def doMatrix(cir, source='circuit', detector='circuit', lgref='circuit',
379 transfer=None, convtype=None, pardefs=None, numeric=False,
380 stepdict=None):
381 """
382 Returns the MNA matrix, the vector with dependent variables and the vector
383 with independent variables.
384
385 :return: SLiCAP results object of which the following attributes with be
386 set as a result of this instruction:
387
388 :rtype: SLiCAP.SLiCAPinstruction.instruction object
389
390 **Return value attributes**
391
392 - doMatrix(<circuit>).M: MNA matrix (sympy.Matrix)
393 - doMatrix(<circuit>.Iv: Vector with independent variables (sympy.Matrix)
394 - doMatrix(<circuit>).Dv: Vector with dependent variables (sympy.Matrix)
395
396 **Parameters**
397
398 See section `General instruction format`_.
399
400 **Example**
401
402 .. code-block:: python
403
404 import SLiCAP as sl
405 sl.initProject("My First RC Network")
406 # Generate the circuit object from the netlist
407 cir = sl.makeCircuit("myFirstRCnetwork.cir")
408 # Obtain the matrix equation of the circuit
409 matrixResult = sl.doMatrix(cir)
410 # Create an HTML page for displaying the results
411 sl.htmlPage("Matrix equation")
412 sl.matrices2html(matrixResult)
413 # assign the MNA matris to the variable M
414 M = matrixResult.M
415 # assign the vector with independent variables to Iv
416 Iv = matrixResult.Iv
417 # assign the vector with dependent variables to Dv
418 Dv = matrixResult.Dv
419 # Print the result of the matrix multiplication to the active HTML page
420 sl.eqn2html(Iv, M*Dv))
421 """
422 result = _executeInstruction(cir, transfer=transfer, source=source,
423 detector=detector, lgref=lgref,
424 convtype=convtype, datatype='matrix',
425 pardefs=pardefs, numeric=numeric,
426 stepdict=stepdict)
427 return result
428
429def doLaplace(cir, source='circuit', detector='circuit', lgref='circuit',
430 transfer='gain', convtype=None, pardefs=None, numeric=False,

Callers

nothing calls this directly

Calls 1

_executeInstructionFunction · 0.85

Tested by

no test coverage detected