XY Series Files (*.xys)

The XY Series Editor is used in several places in SMS, including the definition of time dependent boundary conditions and rating curves. XY series files can be used to input a set of curves into the XY Series Editor. XY series files are also used to export curves generated within the Editor for future use.

The format of the XY series file is shown below. Curves are defined in an XY Series File using one of three types of cards: XY1, XY2, or XY3. With the XY1 card, both the x and y values are listed for each point on the curve. There is no limit to the spacing or interval used between subsequent x values. The XY2 card is identical to the XY1 card except that the number of points and the x values are assumed to be static and cannot be altered by the user. With the XY3 card, the x values are defined by a beginning x value, an initial increment in x, and a per cent change in x per increment. Only the y values are explicitly listed.

XY Series files are imported and exported through the XY Series Editor.

File Format

XY1 id n dx dy rep begc name              /* XY Series vers. #1 */
x1 y1                /* XY values */
x2 y2
.
xn yn
XY2 id n dx dy rep begc name              /* XY Series vers. #2 */
x1 y1                /* XY values */
x2 y2
.
xn yn
XY3 id n x1 incx pcx dx dy rep begc name  /* XY Series vers. #2 */
y1                   /* Y values */
y2
.
.
yn

Cards

 

Card Type

XY1

Description

Defines a curve with a list of XY values. Any number of points and any x spacing between points may be used.

Required

NO

Format

XY1 id n dx dy rep begc name
x1 y1
x2 y2
.
.
xn yn

Sample

XY1 1 5 0 0 0 0 head
       0.0    0.0
       1.0    2.0
       2.5    7.0
       3.0    8.0
       4.5    9.5

Field

Variable

Value

Description

1

id

+

The ID of the XY series.

2

n

+

The number of point in the series.

3

dx

0,1

A flag defining whether the x values listed are to be interpreted as incremental (dx=1) or absolute (dx=0).

4

dy

0,1

A flag defining whether the y values listed are to be interpreted as incremental (dy=1) or absolute (dy=0).

5

rep

0,1

A flag defining whether the xy series is to be interpreted as cyclic (repeating).

6

begc

±

The x value in the series where the cyclic portion of the curve begins. Value is ignored if rep=0.

7

name

str

The name of the series.

8-9

x,y

±

The xy values of the points defining the curve. Repeat n times.

 

Card Type

XY2

Description

Defines a curve with a list of XY values. This card is identical to the XY1 card except that the number of points and the x values are assumed to be static and cannot be altered by the user.

 

Card Type

XY3

Description

Defines a curve with a list of Y values. The x values are defined by a beginning value, an increment, and a bias.

Required

NO

Format

XY3 id n x1 incx biasx dx dy rep begc name
y1
y2
.
.
yn

Sample

XY3 1 10 0 1 0 0 0 0 0 head
0.0
2.0
7.0
8.0
9.5
9.1

Field

Variable

Value

Description

1

id

+

The ID of the XY series.

2

n

+

The number of point in the series.

3

x1

±

The first x value.

4

incx

±

The increment in x used to compute the next x value.

5

pcx

+

The per cent change in x used to compute subsequent x values. Expressed as a decimal, i.e., 0.05 = 5%.

6

dx

0,1

A flag defining whether the x values listed are to be interpreted as incremental (dx=1) or absolute (dx=0).

7

dy

0,1

A flag defining whether the y values listed are to be interpreted as incremental (dy=1) or absolute (dy=0).

8

rep

0,1

A flag defining whether the xy series is to be interpreted as cyclic (repeating).

9

begc

±

The x value in the series where the cyclic portion of the curve begins. Value is ignored if rep=0.

10

name

str

The name of the series.

11

y

±

The y values of the points defining the curve. Repeat n times.