1EZSTRM(3NCARG)                   NCAR GRAPHICS                  EZSTRM(3NCARG)
2
3
4

NAME

6       EZSTRM - A front-end to STRMLN with a simpler interface.  Like STRMLN,
7       it plots a streamline representation of field flow data in a single
8       call.
9

STATUS

11       EZSTRM is obsolete, and is supported only to provide compatibility with
12       old NCAR Graphics codes. However, the compatibility mode parameter,
13       CPM, offers a number of options to help ease the the transition to the
14       new version of the utility. When writing new code you are encouraged
15       not to use this entry point, since it provides less capability than the
16       standard Streamlines interface, and may eventually be phased out.
17

SYNOPSIS

19       CALL EZSTRM (U,V,WORK,IMAX,JMAX)
20

C-BINDING SYNOPSIS

22       #include <ncarg/ncargC.h>
23
24       void c_ezstrm (float *u, float *v, float *work,
25                      int imax, int jmax)
26

DESCRIPTION

28       U           (REAL 2-dimensional array, dimensioned IMAX x n: n >= JMAX,
29                   input) By default, assumed to contain the first dimensional
30                   Cartesian components of the vector field.  However, if PLR
31                   is non-zero, it is treated as containing the vector
32                   magnitudes.
33
34       V           (REAL 2-dimensional array, dimensioned IMAX x n: n >= JMAX,
35                   input) By default, assumed to contain the second
36                   dimensional Cartesian components of the vector field.
37                   However, if PLR is non-zero, it is treated as containing
38                   the vector angles.
39
40       WORK        (REAL array, dimensioned n: n>= 2*IMAX*JMAX working space):
41                   User provided work array used to store the normalized
42                   vector component values, and also to keep track of the grid
43                   boxes eligible for starting a streamline or placement of a
44                   directional arrow.
45
46       IMAX        (INTEGER, input) Actual size of the first dimension of
47                   arrays U and V
48
49       JMAX        (INTEGER, input) Assumed size of the second dimension of
50                   arrays U and V.
51

C-BINDING DESCRIPTION

53       The C-binding argument descriptions are the same as the FORTRAN
54       argument descriptions with the following exceptions:
55
56
57       imax        The actual size of the second dimension of arrays u and v.
58
59       jmax        The assumed size of first dimension of arrays u and v.
60

USAGE

62       U and V are 2-dimensional vector component arrays, whose actual first
63       dimensions must be equal to the value of IMAX, and whose second
64       dimensions must equal or exceed the value of JMAX. The WORK array must,
65       at minimum, be of length 2*IMAX*JMAX.
66
67       Assuming the default value of the compatibility mode parameter, CPM,
68       Streamlines always performs a SET call and draws a perimeter around the
69       plot when accessed through the EZSTRM interface. Before the return from
70       EZSTRM, another call to SET restores the previous coordinate system
71       mapping.
72
73       By modifying the value of CPM, you may take more control over the
74       utility than originally possible using this entry point. For instance,
75       you can override the default value of the SET parameter, or use the
76       Version 3.2 coordinate system mapping routines instead of the old FX
77       and FY functions. Nevertheless, when creating new code, use the
78       STINIT/STREAM interface, since its capabilities are greater and more
79       likely to improve with time.
80

ACCESS

82       To use EZSTRM, load the NCAR Graphics libraries ncarg, ncarg_gks, and
83       ncarg_c, preferably in that order.
84

SEE ALSO

86       Online: fx, stgetc, stgeti, stgetr, stinit, stream, streamlines,
87       streamlines_params, strset, stsetc, stseti, stsetr, stuixy, stumsl,
88       stumta, stumxy, ncarg_cbind.
89

91       Copyright (C) 1987-2007
92       University Corporation for Atmospheric Research
93
94       This documentation is free software; you can redistribute it and/or
95       modify it under the terms of the GNU General Public License as
96       published by the Free Software Foundation; either version 2 of the
97       License, or (at your option) any later version.
98
99       This software is distributed in the hope that it will be useful, but
100       WITHOUT ANY WARRANTY; without even the implied warranty of
101       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
102       General Public License for more details.
103
104       You should have received a copy of the GNU General Public License along
105       with this software; if not, write to the Free Software Foundation,
106       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
107
108
109
110UNIX                              April 1993                    EZSTRM(3NCARG)
Impressum