Interface Ode

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String descr​(java.lang.String state)
      Returns the description for a state.
      Ode descr​(java.lang.String state, java.lang.String descr)
      Sets the description for the state.
      java.lang.String field()
      Returns the Ode field name as a string.
      Ode field​(java.lang.String fieldName)
      Sets the Ode field name.
      java.lang.String ode​(java.lang.String state)
      Returns the ode for a state.
      Ode ode​(java.lang.String state, java.lang.String equation)
      Sets the equation for a state.
      java.lang.String[] state()
      Returns the state vector.
      Ode state​(int pos, java.lang.String state)
      Sets a state of the global equation.
      Ode state​(java.lang.String[] statelist)
      Sets the states of the global equation.
      java.lang.String type()
      Returns the type of global equation, which can be normal,control, discrete, or quadrature.
      The control type is used to mark an ode as intended only for use by the optimization and sensitivity solvers.
      Ode type​(java.lang.String type)
      Sets the type of global equation, which can be normal,control, discrete, or quadrature.
      The control type is used to mark an ode as intended only for use by the optimization and sensitivity solvers.
      java.lang.String valueType()
      Returns the value type.
      Ode valueType​(java.lang.String valueType)
      Sets value type as real or complex when splitting of complex variables in real and imaginary parts has been turned on.
      java.lang.String[] weak()
      Returns all weak equations.
      Ode weak​(int pos, java.lang.String wexpr)
      Sets a weak equation at a position.
      Ode weak​(java.lang.String[] wlist)
      Sets the weak equations.
    • Method Detail

      • descr

        java.lang.String descr​(java.lang.String state)
        Returns the description for a state.
        Parameters:
        state - State.
        Returns:
        Description.
      • descr

        Ode descr​(java.lang.String state,
                  java.lang.String descr)
        Sets the description for the state.
        Parameters:
        state - State name.
        descr - Description.
        Returns:
        Global equation.
      • field

        java.lang.String field()
        Returns the Ode field name as a string.
        Returns:
        Ode field name.
      • field

        Ode field​(java.lang.String fieldName)
        Sets the Ode field name.
        Parameters:
        fieldName - Ode field name.
        Returns:
        Ode.
      • ode

        java.lang.String ode​(java.lang.String state)
        Returns the ode for a state.
        Parameters:
        state - State.
        Returns:
        Global equation.
      • ode

        Ode ode​(java.lang.String state,
                java.lang.String equation)
        Sets the equation for a state.
        Parameters:
        state - State name.
        equation - Equation.
        Returns:
        Global equation.
      • state

        java.lang.String[] state()
        Returns the state vector.
        Returns:
        List of state variables.
      • state

        Ode state​(java.lang.String[] statelist)
        Sets the states of the global equation.
        Parameters:
        statelist - Vector of states.
        Returns:
        Global equation.
      • state

        Ode state​(int pos,
                  java.lang.String state)
        Sets a state of the global equation.
        Parameters:
        pos - Index of state.
        state - State.
        Returns:
        Global equation.
      • type

        java.lang.String type()
        Returns the type of global equation, which can be normal,control, discrete, or quadrature.
        The control type is used to mark an ode as intended only for use by the optimization and sensitivity solvers. A control variable ode should never actually be solved for by the basic solvers, while an optimization solver will modify them in its outer loop. Setting an ODE to be of control type will also remove its time derivative variables.
        The discrete type is only used for events, and represents variables that can change by the re-initialization of a triggered event.
        The quadrature type is used by events to define indicator states that indicates when an event will be triggered.
        Returns:
        Type of global equation.
      • type

        Ode type​(java.lang.String type)
        Sets the type of global equation, which can be normal,control, discrete, or quadrature.
        The control type is used to mark an ode as intended only for use by the optimization and sensitivity solvers. A control variable ode should never actually be solved for by the basic solvers, while an optimization solver will modify them in its outer loop. Setting an ODE to be of control type will also remove its time derivative variables.
        The discrete type is only used for events, and represents variables that can change by the re-initialization of a triggered event.
        The quadrature type is used by events to define indicator states that indicates when an event will be triggered.
        Parameters:
        type - Type of global equation.
        Returns:
        Global equation.
      • valueType

        java.lang.String valueType()
        Returns the value type.
        Returns:
        Value type: real or complex.
      • valueType

        Ode valueType​(java.lang.String valueType)
        Sets value type as real or complex when splitting of complex variables in real and imaginary parts has been turned on.
        Parameters:
        valueType - Value type: real or complex.
        Returns:
        Global equation.
      • weak

        java.lang.String[] weak()
        Returns all weak equations.
        Returns:
        List of weak expressions.
      • weak

        Ode weak​(java.lang.String[] wlist)
        Sets the weak equations.
        Parameters:
        wlist - List of weak expressions.
        Returns:
        Global equation.
      • weak

        Ode weak​(int pos,
                 java.lang.String wexpr)
        Sets a weak equation at a position.
        Parameters:
        pos - Position.
        wexpr - Weak expression.
        Returns:
        Global equation.