plotWater               package:SoPhy               R Documentation

_P_l_o_t_t_i_n_g _t_h_e _r_e_s_u_l_t _o_f _S_W_M_S_2_D

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

     the function plots the H, Q, theta, vx, vz, or conc, stored in a
     list as in the output of SWMS2D

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

     plotWater(h, instance,
               what=c("H", "Q", "theta", "vx", "vz", "Conc", "logH"),
               col.txt="black",
               col.simu=if (is.null(h$col.simu)) rainbow(100) else
                        if (what.nr == 7) rev(h$col.simu) else h$col.simu,
               col.exception = c("yellow", "darkred"), lim=1,
               titl=TRUE, line=0.2, quadratic=TRUE, cex=1, cex.leg=0.8,
               legend = TRUE, ylim, zlim)

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

       h: a list as returned by 'swms2d' or a list as returned by 
          'xswms2d'; usually 'create.waterflow' has been called
          beforehand. 

instance: the number of the time point for which the data should be
          plotted. If missing or 'NULL' the last one is taken. 

    what: character. 'what' gives the parameter to be plotted:

          '_H' water potential H,

          '_Q' discharge/recharge rates Q for internal sink/sources, 

          '_t_h_e_t_a' water contents theta,

          '_v_x' x-components of the Darcian flux vector vx,

          '_v_z' z-components of the Darcian flux vector vz,

          '_C_o_n_c' solute concentration

          '_l_o_g_H' log of -H,

          The parameter 'what' allows also the numbers 1,...,7
          corresponding to "H",...,"logH". 

 col.txt: colour of the title

col.simu: colour spectrum of the simulated field of H, Q, theta, vx,
          vz, or conc; areas of stones or air are white.

col.exception: vector of 2 components; colour plotted values that are
          below or above the given range, see 'zlim'; for 'what="logH"'
          and positive water potential, 'col.exception[1]' is plotted. 

     lim: value in [0,1] that is used only if 'zlim' is missing or
          'NULL'; the range 'zlim' of the plotted values depends on
          'what'. Let q(p) be the p-quantile of the values. Then 

             *  'H' : 'zlim'=[q(1-'lim'); 0]

             *  'theta' : 'zlim'='range'({0, theta_{s,i}},
                max('h$hQThFlC')), where the i runs over all horizons
                and polygons. That is, the range is independent of the
                value of 'lim'. See 'xswms2d' for theta_s.

             *  'Conc' : 'zlim'=[0, q('lim')]

             *  'logH' : 'zlim'=[q(1-'lim'), 1]

             *  otherwise : 'zlim'=[q(1-'lim'), q('lim')]

          quantile for the upper bound of the values of the random
          field; this variable should be less than 1 if the random
          field contains some extreme values, since the colour scale is
          linear

    titl: logical or character. If 'TRUE' a title is plotted using the
          colour 'col.txt'

    line: parameter of function 'title'

quadratic: logical.  If 'TRUE' the figure matrix is enlarged and filled
          with NA symmetrically in x-direction or on the bottom in
          y-direction such the matrix (and the figure) become quadratic

     cex: A numerical value giving the amount by which the title text,
          the points indicating the root segments, the axes and labels
          of the axes should be scaled relative to the default

 cex.leg: A numerical value giving the amount by which the legend text
          should be scaled relative to the default

  legend: logical. If 'TRUE' a legend is added.

    ylim: missing or vector of two components. If missing the range of
          the simulation is used.

    zlim: missing or vector of two components. Values below 'zlim[1]'
          are plotted in 'col.exception[1]', values above 'zlim[2]' are
          plotted in 'col.exception[2]'. If missing or 'NULL' the
          vector 'zlim' is calculated by means of 'lim'. 

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

     For all variables the plot is over the whole range except for the
     following cases. If theta is plotted, the minimum is 0 and the
     maximum the maximal field capacity, If H is plotted, the maximum
     is at most 0.

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

     matrix of the plotted values if no error has occured and an error
     message otherwise.

_A_u_t_h_o_r(_s):

     Martin Schlather, schlath@hsu-hh.de <URL:
     http://www.unibw-hamburg.de/WWEB/math/schlath/schlather.html>

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

     'plotRF', 'xswms2d'

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

        ## see  create.waterflow
       

