Skip to content

Latest commit

 

History

History
executable file
·
60 lines (41 loc) · 1.88 KB

errors.rst

File metadata and controls

executable file
·
60 lines (41 loc) · 1.88 KB

Error Handling

.. function:: coredump_on_error

    Syntax:
        ``h.coredump_on_error(1 or 0)``

    Description:
        On unix machines, sets a flag which requests (1) a coredump in case
        of memory or bus errors --- Or floating exceptions if
        :func:`nrn_fenableexcept` has been turned on.


.. function:: nrn_feenableexcept

    Syntax:
        ``previous_floating_point_mask = h.nrn_feenableexcept(boolean)``

    Description:
        Sets or turns off a flag which, if on, causes a SIGFPE when a floating error occurs which consist of
        divide by zero, overflow, or invalid result. Known to work on linux. Turning on the flag is very helpful
        in finding the code location at which a variable is assigned a value of NaN or Inf. For a serial model, this
        is most easily done when running under gdb. For a parallel model, one can combine with coredump_on_error
        and, to force a coredump on abort(), use the bash command 'ulimit -c unlimited'.

        Return is the previous value of the floating-point mask. (or -1
        on failure to set the floating-point flags; or -2 if feenableexcept
        does not exist).

        Without an arg, SIGFPE is turned on.
    Note:
        The normal trap for exp(x) for x > 700 in mod files becomes
        a floating exception when x is out of range.


.. function:: show_errmess_always

    Syntax:
        ``h.show_errmess_always(boolean)``

    Description:
        Sets or turns off a flag which, if on, always prints the error message even
        if normally turned off by an :func:`execute1` statement or other call to the
        interpreter.



.. function:: execerror

    Syntax:
        ``h.execerror("message1", "message2")``

    Description:
        Raise an error and print the messages along with an interpreter stack
        trace. If there are no arguments, then nothing is printed.