Function doNumer

SLiCAP/SLiCAPshell.py:528–571

Returns the numerator of a transfer or of a detector voltage 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 **Return value attri

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

    return result

def doNumer(cir, source='circuit', detector='circuit', lgref='circuit', 
            transfer='gain', convtype=None, pardefs=None, numeric=False, 
            stepdict=None):
    """
    Returns the numerator of a transfer or of a detector voltage 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
    
    **Return value attributes**
    
    - doNumer(<circuit>).M: MNA matrix (sympy.Matrix)
    - doNumer(<circuit>.Iv: Vector with independent variables (sympy.Matrix)
    - doNumer(<circuit>).Dv: Vector with dependent variables (sympy.Matrix)
    - doNumer(<circuit>).numer: Numerator of the voltage transfer from V1 to
      V_out (sympy.Expr)
      
    If parameter stepping is applied, all above attributes are lists of values
    or expressions for each step.
      
    **Parameters**
    
    See section `General instruction format`_.
    
    **Example**
    
    .. code-block:: python
        
        import SLiCAP as sl
        sl.initProject("My First RC Network")
        # Generate the circuit object from the netlist
        cir = sl.makeCircuit("myFirstRCnetwork.cir")
        # Obtain the numerator od the voltage transfer from V1 to V_out:
        V_gain = sl.doNumer(cir).laplace
    
    """
    result = _executeInstruction(cir, transfer=transfer, source=source, 
                                 detector=detector, lgref=lgref, 
                                 convtype=convtype, datatype='numer', 
                                 pardefs=pardefs, numeric=numeric, 
                                 stepdict=stepdict)
    return result

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