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

Function doDC

SLiCAP/SLiCAPshell.py:478–526  ·  view source on GitHub ↗

Returns the zero-frequency value (DC value) of a transfer or a detector voltge or current. :return: SLiCAP results object of which the following attributes with be set as a result of this instruction: :rtype: SLiCAP.SLiCAPinstruction.instruction object

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

Source from the content-addressed store, hash-verified

476 return result
477
478def doDC(cir, source='circuit', detector='circuit', lgref='circuit',
479 transfer='gain', convtype=None, pardefs=None, numeric=False,
480 stepdict=None):
481 """
482 Returns the zero-frequency value (DC value) of a transfer or a detector
483 voltge or current.
484
485 :return: SLiCAP results object of which the following attributes with be
486 set as a result of this instruction:
487
488 :rtype: SLiCAP.SLiCAPinstruction.instruction object
489
490 **Return value attributes**
491
492 - doDC(<circuit>).M: MNA matrix (sympy.Matrix)
493 - doDC(<circuit>.Iv: Vector with independent variables (sympy.Matrix)
494 - doDC(<circuit>).Dv: Vector with dependent variables (sympy.Matrix)
495 - doDC(<circuit>).numer: Numerator of the DC voltage transfer from V1 to
496 V_out (sympy.Expr)
497 - doDC<circuit>).denom: Denominator of the DC voltage transfer from V1 to
498 V_out (sympy.Expr)
499 - doDC(<circuit>).laplace: DC voltage transfer from V1 to V_out
500 (sympy.Expr)
501
502 If parameter stepping is applied, all above attributes are lists of values
503 or expressions for each step.
504
505 **Parameters**
506
507 See section `General instruction format`_.
508
509 **Example**
510
511 .. code-block:: python
512
513 import SLiCAP as sl
514 sl.initProject("My First RC Network")
515 # Generate the circuit object from the netlist
516 cir = sl.makeCircuit("myFirstRCnetwork.cir")
517 # Obtain the DC voltage transfer from V1 to V_out:
518 V_DCgain = sl.doDC(cir).laplace
519
520 """
521 result = _executeInstruction(cir, transfer=transfer, source=source,
522 detector=detector, lgref=lgref,
523 convtype=convtype, datatype='dc',
524 pardefs=pardefs, numeric=numeric,
525 stepdict=stepdict)
526 return result
527
528def doNumer(cir, source='circuit', detector='circuit', lgref='circuit',
529 transfer='gain', convtype=None, pardefs=None, numeric=False,

Callers

nothing calls this directly

Calls 1

_executeInstructionFunction · 0.85

Tested by

no test coverage detected