Method defPar

SLiCAP/SLiCAPprotos.py:211–247

Updates or adds a parameter definition and updates the list **SLiCAPprotos.circuit.params** with names (*sympy.Symbol*) of undefined parameters. :param parName: Name of the parameter. :type parName: str, sympy.Symbol :param parValue: Value of the pa

(self, parName, parValue, units = None)

        return

    def defPar(self, parName, parValue, units = None):
        """
        Updates or adds a parameter definition and updates the list
        **SLiCAPprotos.circuit.params** with names (*sympy.Symbol*) of
        undefined parameters.

        :param parName: Name of the parameter.
        :type parName: str, sympy.Symbol

        :param parValue: Value of the parameter.
        :type parValue: str, sympy.Symbol, sympy.Expr, int, float

        :param units: Value of the parameter, defaults to None
        :type units: str, sympy.Symbol
        
        :return: None
        :rtype: NoneType
        """
        errors = 0
        try:
            eval(parName)
            errors += 1
            print("Error: Parameter name cannot be a number.")
        except BaseException:
            pass
        if errors == 0:
            parName = Symbol(str(parName))
            self.parDefs[parName] = _checkExpression(parValue)
            if parName in self.params:
                self.params.remove(parName)
            if type(units) == str:
                # ToDo: checkUnits() calculate wir SI units.
                self.parUnits[parName] = units
            else:
                self.parUnits[parName] = ''
            self.updateParams()
        return

    def defPars(self, parDict):
        """