parms                package:simecol                R Documentation

_A_c_c_e_s_s_o_r _F_u_n_c_t_i_o_n_s _f_o_r '_s_i_m_O_b_j' _O_b_j_e_c_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     Get or set simulation model parameters, main or sub-equations,
     initial values, time steps or solvers and extract simulation
     results.

_U_s_a_g_e:

        parms(obj, ...)
        parms(obj) <- value

        main(obj, ...)
        main(obj) <- value

        equations(obj, ...)
        equations(obj) <- value

        init(obj, ...)
        init(obj) <- value

        inputs(obj, ...)
        inputs(obj) <- value

        times(obj, ...)
        times(obj) <- value

        solver(obj, ...)
        solver(obj) <- value
        
        initfunc(obj, ...)
        initfunc(obj) <- value

        out(obj, ...)
        out(obj, ...)

_A_r_g_u_m_e_n_t_s:

     obj: A valid 'simObj' instance.

   value: Named list, vector, function or other data structure
          (depending on the slot and model class) with the same
          structure as the value returned by  'parms'. Either all or a
          subset of values (e.g. single elements of vectors or lists)
          can be changed at once.

     ...: Reserved for method consistency.

_D_e_t_a_i_l_s:

     These are the accessing functions for 'parms', 'times' etc. Please
     take care of the semantics of your model when changing slots. All,
     element names, data structure and values have to correspond to you
     model object definition. For example in 'init' the applied names
     must exactly correspond to the names and number (!) of state
     variables. The restrictions of 'parms' or 'equations' are less
     strict (additional values for ``future use'' are allowed). The
     function 'times' allows either to assign or to modify a special
     vector with three elements named 'from', 'to' and 'by' or to
     overwrite 'times' with an un-named sequence (e.g. 'seq(1, 100,
     0.1)'.

_V_a_l_u_e:

     A list, named vector, matrix or function (for 'main' slot) or list
     of functions ('equation' slot) or other appropriate data structure
     depending on the class of the model object.

_S_e_e _A_l_s_o:

     'simecol-package'.

_E_x_a_m_p_l_e_s:

         data(lv)
         parms(lv)
         parms(lv)       <- c(k1=0.2, k2=0.5, k1=0.3)
         parms(lv)["k2"] <- 0.5

         data(conway)
         parms(conway)
         parms(conway)$srv <- c(2, 2)
         parms(conway)

         # add a new named parameter value
         parms(lv)["dummy"] <- 1
         # remove dummy parameter
         parms(lv) <- parms(lv)[names(parms(lv)) != "dummy"]

