plotFlow                package:SoPhy                R Documentation

_p_l_o_t_t_i_n_g _o_f _t_h_e _s_i_m_u_l_a_t_e_d _i_n_f_i_l_t_r_a_t_i_o_n _p_a_t_t_e_r_n

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

     plotFlow2d plots two dimensional profiles of simulated stochastic
     flow patterns; plotFlow3d plots a 3d, perspective figure of
     simulated stochastic flow patterns.

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

     plotFlow2d(coord, pointradius=1, slice=2 * pointradius,
                full.size=TRUE, Profiles=1, dev=1, ps="",
                height=4, unit="cm", cex=2, correction=1.2, col=1,
                rl = function(x) readline(paste(x, ": press return")))

     plotFlow3d(paths, horizons=c("no", "absorbing", "breakthrough"),
                drop.distr, n.balls=1, pointradius=1,
                dev=1, ps="3d.dye.pattern", ps.background=FALSE,
                profileheight=4, unit="cm", unit.scale=1, inf, sun,
                rl = function(x) readline(paste(x, ": press return")),
                low.resolution=TRUE,
                col=grey(pmin(1, pmax(0, seq(0.95, 0, -0.001)))))

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

   coord: output of 'plotFlow3d': n x 3 matrix; 3d coordinates for the
          centre of the balls that approximate the tube around each
          path

pointradius: radius of the dyed tube around each path; the tube is
          approximated by a sequence of balls

   slice: thickness of the slice for which the paths are visible

full.size: logical. If 'FALSE' then the projected radii of the sliced
          balls are plotted. If 'TRUE' then instead of the projected
          radius the 'pointradius' is used. 

Profiles: number of the in the y-direction equally spaced profiles of
          the 3d flow pattern

     dev: plotting device, see 'Dev' 

      ps: name of the postscript file, see 'Dev' 

  height: height of the plotted figure, see 'Dev' 

    unit: string; if empty then labels are not given. Otherwise 'unit'
          denotes the units of the plot

     cex: used for 'cex.axis' and 'cex.lab', see 'par' 

correction: positive real number. Do not change its value. This
          constant takes into account that the plotting procedure used
          in the function does not plot a circle of exactly the given
          radius. 

     col: colour of the points; 'plotFlow3d' needs a vector of colours
          starting with the colour of the nearest points

   paths: list as returned by 'flowpattern'

horizons: Temptative parameter. If '"absorbing"' the path will be
          'infinitely' long in a layer at depth 50 about, so that
          fluxes will stop in this layer If '"breakthrough"' the path
          will be very long in a layer at depth 50 about, so that only
          a few paths are percolated.

          The values '"absorbing"' and '"breakthrough"' are used to
          create the figures in the Discussion of Schlather and Huwe
          (2004a). 

drop.distr: function or missing. The stained path length reached by a
          single drop is calculated as follows.  First a Gaussian
          random field is simulated with the parameters given below.
          Then the Gaussian random field is marginally transformed to
          uniform distribution by the Gaussian distribution function.
          Then the inverse of the required distribution function is
          applied.  'drop.distr' gives this inverse.  It should allow
          for vectors as input variables. The 'drop.distr' used to
          create 'paths' is overwritten if 'drop.distr' is not missing,
          but the realisation of the paths is always kept. 

 n.balls: the tube for each path segment is approximated by 'n.balls'
          balls

ps.background: logical. If 'dev=TRUE' then a postscript file is
          created, which is, in general, huge. Therefore, any
          postscript file created on a unix system is transformed into
          a tiff-file by `convert' and back again to a postscript file.
          These transformation are time consuming. If
          'ps.background=TRUE' then these transformations are started
          in the background. 

profileheight: essentially the height of the figure; the value is used
          to calculated the width of the plot. The final height of the
          plot is higher then 'profileheight' because additional space
          needed for the perspective plot

unit.scale: scaling factor for the numerical values of all
          three-dimensional coordinates

     inf: Vector of three components. The first two give the position
          of the infinitely far point; the third component gives the
          extension factor for the second dimension that is orthogonal
          to the screen; 'inf' is of order '1/100'

     sun: the three dimensional coordinates of the fictive sun

      rl: function. Called, after a figure, but the last, is plot on
          the screen.

low.resolution: logical. If 'TRUE' and 'dev=FALSE', i.e. postscript
          file will be produced, then on unix systems the postscript
          file will be rewritten to have much smaller size, but also
          lower resolution. 

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

     'plotFlow2d' returns 'NULL'. 'plotFlow3d' returns invisibly a
     matrix for the centers of the approximating balls

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

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

_R_e_f_e_r_e_n_c_e_s:

        *  Schlather, M. and Huwe, B. (2005a) A stochastic model for
           3-dimensional flow patterns in dye tracer experiments. _J.
           Hydrol. _ *In press*, .

        *  Schlather, M. and Huwe, B. (2005b) A risk index for
           characterising flow pattern in soils using dye tracer
           distributions _Submitted to J. Contam. Hydrol._ 

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

     'flowpattern'

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

      ## see flowpattern

