status_codes_m.f90 Source File

module status_codes_m
    !! Contains a collection of PARALLAX error and warning (=status) codes

    implicit none
    public

    enum, bind(C)
        !! Enumerator defining the error and warning codes

        ! NOTE: Success is always zero
        enumerator :: PARALLAX_SUCCESS = 0
        ! NOTE: Warnings need to be positive, specified in an ascending order.
        enumerator :: PARALLAX_WRN_GENERAL = 1
        enumerator :: PARALLAX_WRN_NOT_IMPLEMENTED = 2
        enumerator :: PARALLAX_WRN_MESH = 3
        enumerator :: PARALLAX_WRN_TRACE = 4
        enumerator :: PARALLAX_WRN_IMMERSED = 5
        ! NOTE: Errors need to be negative, specified in an ascending order.
        enumerator :: PARALLAX_ERR_CSRMAT = -1
        enumerator :: PARALLAX_ERR_NETCDF = -2
        enumerator :: PARALLAX_ERR_EQUILIBRIUM = -3
        enumerator :: PARALLAX_ERR_MESH = -4
        enumerator :: PARALLAX_ERR_SOLVER3D = -5
        enumerator :: PARALLAX_ERR_PARAMETERS = -6
        enumerator :: PARALLAX_ERR_HELMHOLTZ = -7
        enumerator :: PARALLAX_ERR_SOLVER2D = -8
        enumerator :: PARALLAX_ERR_BOUNDARIES = -9
        enumerator :: PARALLAX_ERR_CCALL = -10
        enumerator :: PARALLAX_ERR_TRACE = -11
        enumerator :: PARALLAX_ERR_POINCARE = -12
        enumerator :: PARALLAX_ERR_INTERPOL = -13
        enumerator :: PARALLAX_ERR_IMMERSED = -14
        enumerator :: PARALLAX_ERR_PARBND = -15
    end enum

end module