27 - 9   Plot Options


PLOTOPTIONS_AXIS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_AXIS [optional parameters]’

Description:   

Set options for plotting axes on XY plots.

Optional Parameters:

Parameter

Syntax

Notes

MAJORINTERVALMARKERS

= <option>

Major interval markers. SOLID, TICKS, DOTTED, or PRECISE

MINORINTERVALMARKERS

= <option>

Minor interval markers. SOLID, TICKS, DOTTED, or PRECISE

COLOR

= <COLOROPTION>

Any of the standard colors listed in Section 27 - 12.


PLOTOPTIONS_CELL_LABELS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’

COMMAND = ‘PLOTOPTIONS_CELL_LABELS [optional parameters]’

Description:   

Set options for labeling cells on grid plots

Optional Parameters:

Parameter

Syntax

Notes

COLOR

= <COLOROPTION>

Label color. Any of the standard colors listed in Section 27 - 12.

SIZE

= <double>

Size of cell labels, expressed as a percentage of frame size.

BOX

= <boolean>

Include box around label.

FONT

= <FONTOPTION>

Label font. Any of the allowable fonts specified in Section 27 - 12.


PLOTOPTIONS_GRID

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_GRID [optional parameters]’

Description:   

Set options for plotting grids.

Optional Parameters:

Parameter

Syntax

Permitted Values

Notes

MESHCOLOR

= <COLOROPTION>

Any of the colors listed in Section 27 - 12, plus MULTI.

Mesh color.

GRIDTHICKNESS

= <double>

 

Thickness of grid mesh.

CONTOURTYPE

= <option>

LINES, PRIMARY, AVERAGE, or CONTINUOUS

Contour type.

CONTOURLINEWIDTH

= <double>

0.1 to 2.0

 

CONTOURLINEWIDTH

= <COLOROPTION>

Standard Tecplot RS colors plus MULTI (which maps to the contour variable).

 

SHOWCONTOURLABELS

= <boolean>

TRUE or FALSE

 

CONTOURLABELCOLOR

= <COLOROPTION>

standard Tecplot RS colors

 

FONT

= <FONTOPTION>

standard fonts

 

CONTOURLABELSIZE

= <double>

0.1 to 5.0

 

CONTOURLABELSPACING

= <integer>

5 to 50

 

SHOWXYZ

= <boolean>

 

Show the axes on 3D plots

LIGHTEFFECT

= <option>

PANELED or SMOOTH

Lighting effect.

TRANSLUCENCY

= <integer>

1 to 100%

See-through grid translucency.

SHOWGRIDMESH

= <boolean>

 

Show the mesh on see-through grids

GHOSTSTYLE

= <option>

GHOSTGRAY, GHOSTCOLOR, or NONE

Fill style for see-through grid


PLOTOPTIONS_GRIDAXES

Syntax:

 

$!ADDONCOMMAND

ADDONID = ‘TECPLOT RS’

COMMAND = ‘PLOTOPTIONS_GRIDAXES [optional parameters]’

Description:   

Set options for plotting axes on grid plots.

Optional Parameters:

Parameter

Syntax

Notes

COLOR

= <COLOROPTION>

Label color. Any of the standard colors listed in Section 27 - 12.

FONT

= <FONTOPTION>

Label font.

LINECOLOR

= <COLOROPTION>

Axis line color. Any of the standard colors listed in Section 27 - 12.

SHOWXYZ

= <boolean>

Turns on or off the axes display in 3D plots.

SIZE

= <double>

Label size, ranging from 0.1 to 5.0.


PLOTOPTIONS_INACTIVEGRID

Syntax:

 

$!ADDONCOMMAND

ADDONID = ‘TECPLOT RS’

COMMAND = ‘PLOTOPTIONS_INACTIVEGRID [optional parameters]’

Description:   

Set options to define the inactive grid cells’ style. No defaults apply.

Optional Parameters:

Parameter

Syntax

Notes

FILLSTYLE

= <string>

Accepts values of SHADE, MESHONLY, MATCH, or VARIABLE to control the fill style of displayed inactive cells.

MESHCOLOR

= <COLOROPTION>

Controls the mesh color of inactive cells.

COLOR

= <COLOROPTION>

Controls the fill (shade) color of inactive cells. Applies only when FILLSTYLE is set to SHADE.

GRIDTHICKNESS

=<double>

Controls the thickness of each line of the mesh as a percentage of the frame size. Acceptable values range from 0.1 to 2.0.


PLOTOPTIONS_LABELS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_LABELS [optional parameters]’

Description:

   Set label options.

Optional Parameters:

Parameter

Syntax

Notes

FONT

= <FONTOPTION>

Any of the allowable fonts specified in Section 27 - 12.

SIZE

= <double>

Size as a percentage of frame. If the value does not match one of the preset values on the Plot Options dialog it converts to the nearest preset value.

COLOR

= <COLOROPTION>

Any of the standard colors listed in Section 27 - 12.


PLOTOPTIONS_MISC

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_MISC [optional parameters]’

Description:

   Set time variable and animation options.

Optional Parameters:

Parameter

Syntax

Notes

TIMEUNITS

= TIME, DATE

Set the time variable to either TIME or DATE.

ANIMATIONDELAY

= <integer>

Specify the animation delay (pause between time steps).

USEFORMATTEDDATE

= <boolean>

Specify whether to use decimal year as date format.

USEFORMATTEDTIME

= <boolean>

Specify whether to use decimal day as time format.

DATEFORMAT

= <string>

Specify a Tecplot RS date format string. For example, “mmm-dd-yyyy”. By default, “mm/dd/yy”.

TIMEFORMAT

= <string>

Specify a Tecplot RS time format string. For example, “[d] hh:mm:ss”. By default, “[d] hh:mm”.


PLOTOPTIONS_SCALING

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_SCALING [optional parameters]’

Description:

   Set options for scaling.

Optional Parameters:

Parameter

Syntax

Notes

VARIABLE

= <string>

Name of the variable to apply the following settings to. You can use the long or short name, but it must match exactly (excluding upper- or lowercase).

INTERVAL

= <integer>

Assigns the interval between major markers on X or Y axis. Must follow the VARIABLE parameter, although does not have to follow immediately. Range includes values zero (0) and greater.

MINORCOUNT

= <integer>

Assigns the number of minor markers displayed between major markers. As the INTERVAL parameter, MINORCOUNT will be associated with the preceding VARIABLE parameter. Acceptable values range from zero (0) to one hundred (100).

REVERSEYAXIS

= <boolean>

Reverse Y axis direction of the variable specified in VARIABLE.

RANGE

= <option>

Scaling range. FRAME, DATASET, or MANUAL

MIN

= <double>

Valid only if RANGE=MANUAL.

MAX

= <double>

Valid only if RANGE=MANUAL.

SCALE

= <double>

If the value does not match one of the preset values on the Plot Options dialog it converts to the nearest preset value. Use 0 for Log scale.

OVERRIDE

= <boolean>

TRUE to declare a new string for the units display.

UNITS

= <string>

Character string to be used for displaying units.

CUTOFFLOW

= <boolean>

TRUE to cutoff contours below a set value.

CUTOFFHIGH

= <boolean>

TRUE to cutoff contours above a set value.

LOW

= <double>

Valid only if CUTOFFLOW=TRUE. Sets the cutoff value.

HIGH

= <double>

Valid only if CUTOFFHI=TRUE. Sets the cutoff value.

LEGENDORIENTATION

= <option>

Specify whether the contour legend should be VERTICAL or HORIZONTAL.

INVERT

= <option>

Option to determine whether color scale is inverted: CONDITIONAL, NEVER, or ALWAYS.

COLORMAP

= <option>

Color map to be used to draw contours. LARGERAINBOW, SMALLRAINBOW, TWOCOLOR, or GRAYSCALE


PLOTOPTIONS_WELL_LABELS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’

COMMAND = ‘PLOTOPTIONS_WELL_LABELS [optional parameters]’

Description:

   Set options for labeling wells on grid plots.

Optional Parameters:

Parameter

Syntax

Notes

INCLUDE

= <boolean>

Include well names.

COLOR

= <COLOROPTION>

Label color. Any of the standard colors listed in Section 27 - 12.

SIZE

= <double>

Size of well labels

UNITS

= <option>

Units for label size. GRID or FRAME

FONT

= <FONTOPTION>

Label font. Any of the allowable fonts specified in Section 27 - 12.


PLOTOPTIONS_WELL_OPTIONS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_WELL_OPTIONS [optional parameters]’

Description:

   Set options for general well display on grid plots.

Optional Parameters:

Parameter

Syntax

Notes

WELLHEADOFFSET

= <integer>

Offset value.

WELLHEADPOS

= <option>

Position option (1 – 4)

WELLMULTIFRAME

= <option>

Option for displaying wells in multi frames: ONEFRAME or ALLFRAMES

WELLDISPLAY2D

= <option>

Display option for wells in 2D views. ALL, CURRENTPLANE, or NODESONLY


PLOTOPTIONS_WELLSYMBOLS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_WELLSYMBOLS [optional parameters]’

Description:   

Set options for plotting wells and bubbles.

Optional Parameters:

Parameter

Syntax

Notes

TYPE

= <option>

Well type. PRODUCER, INJECTOR, WATERINJECTOR, GASINJECTOR, SHUTIN, OPENNODE, or CLOSEDNODE

SYMBOLS

= <option>

Well symbol. DEFAULT, SQUARE, CIRCLE, DIAMOND, DELTA, GRADIENT, LEFTTRI, RIGHTTRI, SPHERE, CUBE, or OCTAHEDRON

COLOR

= <COLOROPTION>

Well color. Any of the standard colors listed in Section 27 - 12.

SIZE

= <double>

Size (in percent).


PLOTOPTIONS_XY

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘PLOTOPTIONS_XY [optional parameters]’

Description:   

Set options for XY plots.

Optional Parameters:

Parameter

Syntax

Notes

STYLESET

= <styleset>

Which of 99 style sets that all following parameters will be applied to. Options are ACTIVE or COMP1 through COMP99

VARIABLE

= <string>

Name of the variable to apply the following settings to. You can use the long or short name, but it must match exactly.

SHOWLINES

= <boolean>

Show lines.

LINECOLOR

= <COLOROPTION>

Line color. Any of the standard colors listed in Section 27 - 12, plus DEFAULT.

LINEPATTERN

= <option>

Line pattern. DEFAULT, SOLID, SHORTDASH, DASHDOT, DOTTED, LONGDASH, or DASHDOTDOT

LINEPATTERNLENGTH

= <double>

Line pattern as a percent. If the value does not match one of the preset values on the Plot Options dialog, it converts to the nearest preset value.

LINETHICKNESS

= <double>

Line thickness as a percent. If the value does not match one of the preset values on the Plot Options dialog, it converts to the nearest preset value.

SHOWSYMBOLS

= <boolean>

TRUE to show all symbols.

SYMBOLFILL

= <boolean>

TRUE to fill all symbols.

SYMBOLCOLOR

= <COLOROPTION>

Symbol color. Any of the standard colors listed in Section 27 - 12, plus DEFAULT and MATCH.

SYMBOLSHAPE

= <option>

Symbol shape. DEFAULT, SQUARE, CIRCLE, DIAMOND, DELTA, GRADIENT, LEFTTRI, RIGHTTRI, CHARACTER

SYMBOLSPACING

= <option>

Symbol spacing. ALL, I2, I4, I6, I8, I10, D1, D2, D3, D4, D5

SYMBOLCHAR

= <string>

Symbol character if SYMBOLSHAPE=CHARACTER.

SYMBOLSIZE

= <double>

Symbol size. If the value does not match one of the preset values on the Plot Options dialog, it converts to the nearest preset value.


RSVFILE

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘RSVFILE TYPE=<rsvtype>

Description:   

Chooses the RS Variables file to be used for variable renaming and aliasing and for colors and line and symbol styles used in plots.

Required Parameters:

Parameter

Syntax

Notes

TYPE

= <rsvtype>

Chooses the file that will be used. Supported types are USER (rsvariables.txt), ECLIPSE, CHEARS, VIP, SENSOR, and CMG. The simulator-specific files are named e.g. rsvariables_chears.txt.


UPDATEOPTIONS

Syntax:

 

$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘UPDATEOPTIONS’

Description:   

Update the plot after changes in Plot Options or Bubble Options dialog.