Macro Commands Summary

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Animate'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'AnimateSetup [parameters]'

Sets up the parameters for playing and recording in grid plot animations. The same parameters are used for recording and playing, although some parameters are ignored when not recording.

FName

= <string>

none

Name of the animation file. Ignored when not recording.

FType

= <option>

Avi

Type of animate file to create. Valid options are Avi, MPEG4, Png, Bmp, Ps, Tiff, Eps, Wmf, Jpeg.

If a single image format is specified (Png, etc.), then each frame of the animation will be output as a single image in the parent directory of the specified file name (FName). The file name of each frame will include the base file name FName parameter and a sequence number.

Speed

= <double>

1.0

Animation speed. Applies only to output formats that recognize frame speed.

Antialias

= <boolean>

False

Perform antialiasing to improve quality True or False

SuperSampleFactor

= <integer>

3

Antialiasing super factor.

Width

= <integer>

300

Sets the width of the output frame. Ignored when not recording.

StartPercent

= <integer>

0

Starting position of the animation as a percentage of total frames. Zero indicates the first frame.

EndPercent

= <integer>

100

Ending position of the animation as a percentage of total frames. One hundred indicates the last frame.

Record

= <boolean>

Set to True to record this animation.

Direction

= <integer>

1

Animation direction: 1 for forward, and -1 for backwards

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'CrossPlot'

Show

= <boolean>

None

Show Cross Plot frame - True or False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Histogram'

Show

= <boolean>

None

Show Histogram Plot frame - True or False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYAnimate'

$!AddonCommand
AddonID = 'Tecplot RS'
Command = 'XYAnimateSetup [parameters]'

Sets up the parameters for playing and recording in XY plot animations. The same parameters are used for recording and playing, although some parameters are ignored when not recording.

Type

= <option>

none

Type of XY plot to be animated XYvariables, XYentities, or Custom

FName

= <string>

none

FType

= <option>

Avi

Speed

= <double>

1.0

AntiAlias

= <boolean>

False

SuperSampleFactor

= <integer>

3

Width

= <integer>

300

ObjectSet

= <set>

None

StartSelect

= <integer>

1

StopSelect

= <integer>

2

Record

= <boolean>

False

$!AddonCommand
AddonID = 'Tecplot RS'
Command = 'XYGlobalSettings [parameters]'

Sets global options for XY plots

Frameselectionmode

= <option>

Sequential

Sets the frame selection mode. Must be one of the following:

Sequential - Variables are assigned based on the ordering in the sidebar (default)

Manual - A variable can be assigned to each individual multi-frame.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'CMGSetup [parameters]'

Units

= <string>

Unit_Si, Unit_Field, Unit_Lab, Unit_Modsi, Unit_Chears, Unit_Gemsi, Unit_GemField, Unit_StarsLab

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'CopyXYLineStyles [parameters]'

Copies XY Line styles to one or more style sets.

Variables

= <string>,<string>,…​

One or more short variable names to copy the settings to

CompStyleSets

= [<set>]

None

Specify one or more Comp style sets. Comp style sets are numbered 1-99.

CopyToActiveStyleSet

= <boolean>

False

Set to True to copy to the active style set in addition to the Comp style sets specified in the CompStyleSets parameter.

ShowLines

= <boolean>

Show lines.

LineColor

= <ColorOption>

Line color. Any of the standard colors listed in ColorOption, 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 ColorOption, plus Default and Match.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'ExtractCellData [parameters]'

FName

= <string>

File name to save

CellSelection

= <string>

Visible

Visible, Blanked, All, Well or Completion

Times

= <string>,<string>, …​

The entry should consist of a list of strings, each containing a single integer value specifying the time step. They should not be date or time strings.

Variable

= <string>,<string>, …​

Comma-separated list of variable names

Well

= <string>,<string>,…​

Comma-separated list of well names

Type

= <string>

CSV

Chooses the output format: CSV or Sector

Name

= <string>

Chooses grid from which the macro will pull data for sector output. Use any grid name from active data set

FType

= <string>

Chears

Chooses the file type of sector data output file. Choose Chears, Eclipse, or VIP

IMin

= <integer>

1

Chooses minimum I-cell range for sector output. I range can vary between 1 (one) and the Imax of the specified grid (will be clipped if range is exceeded)

IMax

= <integer>

1

Chooses maximum I-cell range for sector output

JMin

= <integer>

1

Chooses minimum J-cell range for sector output. J range can vary between 1 (one) and the Jmax of the specified grid (will be clipped if range is exceeded)

JMax

= <integer>

1

Chooses maximum J-cell range for sector output

KMin

= <integer>

1

Chooses minimum K-cell range for sector output. K range can vary between 1 (one) and Kmax of the specified grid (will be clipped if range is exceeded)

KMax

= <integer>

1

Chooses maximum K-cell range for sector output

ShowKAvg

= <boolean>

F

If true, behaves as though KAvg radio button is selected in CSV Extractions by Cell. Type must be CSV. Only one of KAvg and KSum should be set to true. If neither KSum nor KAvg is true, cell data is exported. Note that both KSum and KAvg imply export only sum or average of visible data for full range of I and J.

ShowKSum

= <boolean>

F

If true, behaves as though KSum radio button is selected in CSV Extractions by Cell. See notes above under Showkavg.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GalleryDelete Name=<string>'

This command deletes a plot from the Gallery.

Name

= <string>

Name of Gallery plot to be deleted.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GalleryDisplay Name=<string>'

This command displays a plot from the Gallery.

Name

= <string>

Name of Gallery plot to be displayed.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GallerySave Name=<string>'

This command saves a plot to the Gallery.

Name

= <string>

Name by which current plot will be known in the Gallery.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadCustomPlot FName=<string>'

FName

= <string>

File name of file to load.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadFlowTable FName=<string>'

FName

= <string>

File name of flow table to load.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridData [parameters]'

Name

= <string>

Name of file containing the grid geometry.

SolutionFile

= <string>

Name of file containing solution file. Can be repeated when multiple files are required. For VDB files, use the SolutionFile parameter to specify the case name.

Appendrule

= <boolean>

Indicates whether data are appended to existing grid (True) or a new grid is being loaded (False).

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridDelta Name="<gridFile>" Name="<solution1>" Name="<solution2>" Name="<outputFile>" DeltaType=Vc-Vr DeltaMagnitude=F'

Name

= <string>

Name of files used for delta solution. Four names must be included, beginning with the grid file, followed by the two solution files, and ending with the output file name that will hold the delta values.

DeltaType

= <string>

Defines option for computing delta values. Allowed options are:

VC-VR (Default)
VR-VC
(VC-VR)/VC
(VR-VC)/VR

DeltaMagnitude

= <boolean>

Defines whether to use delta magnitudes True or False.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridTransform [parameters]'

This command is used to set the grid transformation values, including coordinate conversion, rotation, and translation.

ConvertX

= <double>

Value by which to scale the X coordinate (default = 1)

ConvertY

= <double>

Value by which to scale the Y coordinate (default = 1)

ConvertZ

= <double>

Value by which to scale the Z coordinate (default = 1)

DeltaX

= <double>

Value by which to shift the X coordinate (default = 0).

DeltaY

= <double>

Value by which to shift the Y coordinate (default = 0).

CenterX

= <double>

X coordinate of the center to which to rotate the grid.

CenterY

= <double>

Y coordinate of the center to which to rotate the grid.

RotateSin

= <double>

Sine value of the angle of rotation.

RotateCos

= <double>

Cosine value of the angle of rotation.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridSmoothing [parameters]'

This command is used to set the grid smoothing parameters.

SolveGridRule

= <option>

Controls whether to re-process the Rsgrid file, if it exists. - Never, Conditional (if options are different) or Always

CornerPoint

= <option>

Create corner point options - Original, Shift, or Average

XYTolerance

= <double>

Tolerance for XY dimensions. Note: You must also set ZTolerance when setting XYTolerance.

ZTolerance

= <double>

Tolerance for Z dimensions. Note: You must also set XYTolerance when setting ZTolerance.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridNNCs [parameters]'

This command is used to set the grid smoothing parameters.

OptimizeNNCs

= <option>

Controls whether to load NNC data, if it exists. - Never, Conditional (if not dual-porosity) or Always

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadGridInactiveCell InactiveCellCondition= "<string>"'

This command is used to specify the variable used to identify inactive cells for VIP grid data files.

InactiveCellCondition

= <string>

A string containing the inactive cell condition. The string should consist of a variable name, one of the allowed operator, and a floating point value. The allowed comparison operators are: >, <, and =. The string should be surrounded in double quotation marks.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadPaperLayout FName=<string>'

Loads a saved paper layout template.

FName

= <string>

Name of file to load.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadPlotStyle FName=<string>'

Loads plot styles.

FName

= <string>

Name of file to load.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadRFTLayers'

Loads RFT layers from CSV file. See section RFT Plot Text and Layer Details for the expected CSV format.

FName

= <string>

Name of the CSV file to load.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'LoadXYData'

FName

= <string>

Name of file.

FType

= <option>

Type of file. EclfRft, FrontSim, ChearCSV, ChearsHist, IntersectHist, VIP, XYMultiList, Project, VDB, CMG, VIPObserved or GenericAscii

Case

= <string>

For VDB files only. Name of the case to load.

Active

= <boolean>

Sets this file as the active file: Default: False

AutoAppendRFT

= <boolean>

Automatically append Rft data to the Unsmry file if an Rft data is found. Ignored if the data file type (FType) is not Unsmry. Default: True

CaseName

= <string>

Sets the VDB case name. Ignored if the file type is not VDB.

DisplayName

= <string>

Sets the display name for the XY data.

LoadDerivedVars

= <boolean>

Whether to calculate rates and ratios when loading CMG data files missing these variables.

QuickLoad

= <boolean>

For VDB data, reads only fields, wells, and regions and skips loading completions and network connections.

StreamlineFile

= <string>

Name of file. Indicate streamline file to add.

Type

= <string>

Sets the VDB case type. Ignored if the file type is not VDB.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PeriodicProductionRates [parameters]'

Performs periodic production rate calculations on the active XY dataset and saves the results to the specified CSV file.

FName

= <string>

File name to save.

Entityfilter

= <option>

Name of the entity type. Must be one of Wells, Field, Areas, Regions, Usergroups.

Entities

= <string, string, …​>

Comma-separated list of entity names.

Variable

= <string, string, …​>

Comma-separated list of variable names.

Period

= <option>

Time period. Must be one of Weekly, Biweekly, Monthly, Quarterly, Annually.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PromptForFolder VarName=<MacroVar>'

Displays a dialog where the user can browse for a folder. The selected folder is placed in <MacroVar>. If the user cancels the dialog and no folder is selected, then no changes are made to <MacroVar>.

VarName

= <string>

Receives the selected folder

Caption

= <string>

Dialog caption for the folder selection dialog.

DefaultFolder

= <string>

The dialog’s working directory will be set to this directory. Must be the name of a folder, not a file. An ending file separator character is optional.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SavePaperLayout FName=<string>'

Save a paper layout template.

FName

= <string>

Name of file to save.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SavePlotStyle FName=<string>'

Save plot styles.

FName

= <string>

Name of file to save.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SaveProjectFile FName = "<string>"

This command is used to save the current files in a project file whose file name is defined by FName.

FName

= <string>

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SetActiveGrid FName=<string>'

When multiple grid files have been loaded, this command determines which one is active.

FName

= <string>

Name of the active grid file (Include full path.)

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SetActiveXYDataset FName=<string>'

When multiple XY data sets have been loaded, this command determines which one is active.

FName

= <string>

Name of the active XY data set. (Include full path.)

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SetAsDefault CustomOptions=<boolean>'

CustomOptions

= <boolean>

Available values = True or False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SetAsDefault PaperLayout=<boolean>'

PaperLayout

= <boolean>

Available values = True or False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions=<boolean>'

PlotOptions

= <boolean>

Available values = True or False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StampOptions [paramenters]'

Set options for showing stamps in 3D grid plots.

VarNameA

<string>

Property used for production wells

VarNameB

<string>

Property used for injection wells

SymbolFill

<bool>

Use solid fill option

Size

<integer>

1, 2, or 3 for small/medium/large

Show

<bool>

Show stamps option

QuickXY

<option>

Set to Enlarged to show enlarged stamp plots, or XYVariables to use the view defined in the XY Variables plot. (default: XYVariables)

AxisScale

<option>

Set to Dataset to use the Y-Axis range for all entities of the same type. Set to Frame to use the range of the variable plotted in a single stamp.

Default: Dataset

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SwapGridFile FName=<string> ID=<integer>'

FName

= <string>

Pathname of the grid data file to be swapped in.

ID

= <integer>

Number, starting at 0, of the file in the list that will be swapped out and substituted with the new file.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SwapXYFile FName=<string> ID=<integer>'

FName

= <string>

Pathname of the XY data file to be swapped in.

ID

= <integer>

Number, starting at 0, of the file in the list that will be swapped out and substituted with the new file.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UnloadFlowTable ID = <integer>'

ID

= <integer>

Flow table number to unload.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UnloadGridFile FName=<string>'

Unloads the specified Grid file.

FName

= <string>

Name of file (fully pathed) to unload.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UnloadXYDataset FName=<string>'

Unloads specified XY data set.

FName

= <string>

Name of file (fully pathed) to unload.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotFlowTable'

ID

= <integer>

Flow table number to plot. Before using the Plot macro command, you must at least set the flow table number with this command.

MultiParam

= <string, string, string, …​>

The first <string> parameter indicates the name of the code name independent variable to plot, such as WGR. The other <string> parameters are the values of the variable to plot.

SingleParam

= <string, string, string, …​>

One or more pairs of strings. The first <string> parameter indicates the name of the code independent variable to set, such as WGR. The next <string> parameter indicates the setting for that variable.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Blanking [parameters]'

Include

= <boolean>

Turn cell value blanking on or off. True=on.

Constraint

= <integer>

The constraint number (1-6)

Actives

= <boolean>

Controls whether the current constraint is active or not.

VarA

= <integer>

Variable number used to establish blanking criterion.

ConstrainTop2Mode

= <option>

Mode for constraint comparison: UseVar or UseConstant.

VarB

= <integer>

The variable number used in the comparison. Only available if ConstrainTop2Mode = UseVar.

ValueCutOff

= <double>

The value used for comparison. Only available if ConstrainTop2Mode = UseConstant.

Relop

= <option>

Relative operator for comparison: LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, EqualTo, or NotEqualTo

$!AddonCommand
   AddonID = "Tecplot RS"
   Command = "BubbleOptions [parameters]

Set options for bubbles in grid plots.

ShowBubbles

= <boolean>

Master switch for turning bubbles on/off.

BubbleNumber

= <integer>

The pie slice for which the following options are being set (1-8).

BubbleVar

= <option>

Variable name to be assigned to the pie slice designated by BubbleNumber.

Color

= <ColorOption>

Color to be used for the pie slice designated by BubbleNumber. The standard color names, plus Default.

Include

= <boolean>

Whether to show the pie slice indicated by BubbleNumber.

BubbleSize

= <boolean>

Whether to use the BubbleVar assigned to the current BubbleNumber to control the size of the bubble

Multiplier

= <double>

Multiplier for the bubble value shown in the BubbleNumber slice.

FixedSize

= <boolean>

Whether the bubbles are a fixed size (true) or dynamic (false)

Units

= <option>

Whether bubble size is expressed in Paperunits or Gridunits.

SymbolSize

= <integer>

Maximum size of the bubbles (1 to 20), in the specified Units.

Range

= <boolean>

Toggle for showing range bubbles when bubble sizing is dynamic (FixedSize is false).

Scale

= <option>

Bubble size is determined by Diameter or Area.

FontColor

= <ColorOption>

The color of the bubble labels.

FontUnits

= <option>

Units used for sizing the bubble labels. Frame, Grid, or Point.

Font

= <FontOption>

The font used for bubble labels.

Labels

= <boolean>

Toggle for including the bubble value label.

Variable

= <boolean>

Toggle for including the bubble variable name label.

Size

= <integer>

Size for the bubble labels.

Decimals

= <integer>

Selects the number of decimals to display on bubble value labels. Actually selects the option in the dialog, so 0 = "best" and 1-5 translate to 0-4 decimal places.

Delta

= <boolean>

Toggle for turning on/off delta bubble values.

Normalize

= <boolean>

Toggle for normalizing delta values.

Max

= <double>

Maximum value to be used when sizing delta bubbles.

DeltaRerference

= <integer>

Index to the loaded data file that is used to compute delta bubble values.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GridDisplayName FName = "<string>" Name = "<string>"'

Specifies the label to identify the file in legends and paper layouts.

FName

= <string>

Name of file.

Name

= <string>

Name to display when file FName is in use.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GridCompareSetup [parameters]'

If the comparison toggle is turned on for a plot, use this command to choose the comparison data sets and options for displaying them.

CompareDataset

= <string, string, …​>

Specify one or more file names. Order of files determines how they will appear in legend. Files must be loaded first.

DataSetOrdering

= <string, string, …​>

Sets the grid ordering in which datasets will be displayed in the Grid Compare Order dialog. Note that this ordering includes all grids irrespective of whether they are included in the comparison plot. If the current active grid is specified it will be ignored. Any grids not specified will be given a default ordering. All grid names must be currently valid grids.

Delta

= <option>

Set to Original to apply blanking based on original grid values.

Set to Delta to apply blanking based on delta grid values.

Ignored if Show=false, default=Original

Show

=< boolean>

True to show comparison plots (default = False)

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GridEquations EquationList=<string, string, …​>'

Defines one or more equations to be used to create new grid variables.

EquationList

= <string, string, …​>

List of equations defining new variables to be solved from existing values. Note that any existing equations will be removed and replaced with the equations specified in this list.

Equation

= <string>

Appends a single equation to the list of Grid equations to define.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GridOptions [parameters]'

Sets up the options for creating grid plots.

Variable

= <string>

InactiveVar

= <string>

TimeStep

= <integer>

Delta

= <boolean>

DeltaBlanking

= <option>

Planes

= <option>

GlobalIndex

=<integer>

DualView

= <option>

DualWells

= <option>

LGR

= <string>,<string>

LoadInactive

= <boolean>

OWGVariables

= <string>, <string>, <string>

ShowMesh

= <boolean>

ShowContours

= <boolean>

ShowConnect

= <boolean>

ShowShade

= <boolean>

UseLighting

= <boolean>

UseTranslucency

= <boolean>

ShowWells

= <boolean>

ShowCellLabels

= <boolean>

ShowNNCs

= <boolean>

ShowStreams

= <boolean>

ShowQuick3D

= <boolean>

ShowOWG

= <boolean>

ShowKSum

= <boolean>

ShowKAvg

= <boolean>

KAvgType

= <option>

ShowGhost

= <boolean>

XAxisReverse

= <boolean>

YAxisReverse

= <boolean>

CLabelVariable

= <integer>

CLabelSkip

= <integer>

CLabelDecimals

= <integer>

TimeStepSkip

= <integer>

DeltaReference

= <integer>

DeltaMagnitude

= <boolean>

DeltaType

= <string>

InsideView Lighting

= <boolean>

InsideView Translucency

= <boolean>

ShowStandard

= <boolean>

ShowKSumDelta

= <boolean>

ShowKAvgDelta

=<boolean>

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'GridTransform [parameters]'

GridOrientation

= <option>

Grid orientation. Left or Right

ZAxisMultiplier

= <double>

Multiplier for the Z-axis. Accepts values from 0.0 to 100.0 inclusive, where 0 indicates automatic factor computation.

GridThickening

= <double>

Defines factor by which Tecplot RS thickens grid, stretching the Z-axis values without distorting surface. Accepts values from 1.0 to 100.0 inclusive.

DualView

= <option>

Defines whether to view Matrix or Fracture grid view, or Both.

LoadInactive

= <boolean>

Defines whether to load inactive cells. True to load cells, False to unload.

DeltaX

= <double>

Value by which to shift the X coordinate (default = 0).

DeltaY

= <double>

Value by which to shift the Y coordinate (default = 0).

DeltaZ

= <double>

Value by which to shift the Z coordinate (default = 0).

Angle

= <double>

Angle by which to rotate the grid, in degrees (default = 0).

ConvertX

= <double>

Value by which to scale the X coordinate (default = 1).

ConvertY

= <double>

Value by which to scale the Y coordinate (default = 1).

ConvertZ

= <double>

Value by which to scale the Z coordinate (default = 1).

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'InsideNNCs [parameters]'

Show

= <boolean>

Turns the 3D NNC inside view on or off.

Persist

= <boolean>

Turns on or off the persistence of the NNC inside view (allowing other inside views to be seen simultaneously)

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Integration [required parameters] [optional parameters]'

Performs integration and outputs the results to a CSV file.

Name

= <string>

Fully-qualified pathname of output CSV file.

SelectBy

= <option>

Cell selection option: Visible, Opennode, Closednode

VarA

= <string>

Variable name for volume multiplier. Omit if not using volume multipliers.

VarB

= <string>

Variable name for binning. Omit if not binning values. Use "Time" or "Time Step" to bin by time.

Value1

= <integer>

Controls the number of bins. Omit or set to 0 when using bin interval or when binning by time.

Value2

= <integer>

Controls the bin interval. Omit or set to 0 when using number of bins or when binning by time.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'KDeltaOptions [parameters]'

Set options for KSum/KAvg Delta serived view derived display

TimeIndex

= <integer>

Specify the reference timestep Default is 0.

DeltaType

= <string>

Defines option for computing delta values. Allow options are:
VC-VR (Current - Reference) Default
VR-VC (Reference - Current)
(VC-VR)/VC (Normalized Current - Reference)
(VR-VC)/VR (Normalized Reference - Current)

DeltaMagnitude

= <boolean>

Defines whether to use delta magnitudes - True Or False. Default: False

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'NNCOptions [parameters]'

NNCValueNum

= <integer>

The variable index for flooding NNC faces.

ShowNNCs

= <boolean>

Show NNC option True or False.

ShowGridMesh

= <boolean>

Show mesh on main grid True or False.

ShowNNCMesh

= <boolean>

Show mesh on NNC grid True or False.

ShowGridFill

= <boolean>

Fill mesh on main grid True or False.

ShowNNCFill

= <boolean>

Fill mesh on NNC grid True or False.

Translucency

= <integer>

Translucency as a percentage.

NNCfaces

= <option>

NNC faces to display Upstream, Downstream, Both.

FillStyle

= <option>

Fill style for grid - None, Shade, or Variable.

LightEffect

= <boolean>

Option for shading - Smooth or Paneled.

Color

= <ColorOption>

When FillStyle is Shade, this is the shade color used.

UpColor

= <ColorOption>

Color of grid on upstream faces.

DownColor

= <ColorOption>

Grid color for downstream faces.

MeshColor

= <ColorOption>

Grid color for main grid.

NNCThickness

= <double>

Thickness of mesh on NNC grids.

GridThickness

= <double>

Thickness of mesh on main grid.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotGrid Type=<option>'

Type

= <option>

Type of plot to draw - Twod or Threed.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'ResetView'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Update3DView'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'WellOptions [parameters]'

Defines the well display options on grid plots.

DisplayOption

= <option>

Option for limiting well display - All or Selected.

SelectedWells

= <string, string, …​>

List of well names to display.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'ArbSlices [parameters]'

Set options for displaying Inside Views in 3D Grid plots using Arbitrary Slices.

Show

= <boolean>

Show Arbitrary Slices True or False

Create

= <name, X1, Y1, X2, Y2>

Create a new slice definition. 5 strings must be included, each must be surrounded by quotes. The first string is the slice name, followed by the Xy coordinates of the two end points.

Delete

= <string, string, string, …​>

Delete slice definitions. Strings indicate the slice names to delete.

Select

= <string, string, string, …​>

Identifies the slices selected for display. Names must be enclosed in quotes.

Clip

= <boolean>

Clip slices at endpoints True or False

Hide

= <string, string, string, …​>

Identifies slices which are not displayed. Names must be enclosed in quotes.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'ClearAllSlices'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'IJKBlanking [parameters]'

Show

= <boolean>

Show IJK Blanked slices True or False

Invert

= <boolean>

Option to invert blanking status - True or False.

Planes

= <name, Imin, Imax, Jmin, Jmax, Kmin, Kmax>

Planes to be shown in slices. First string is the name of the local grid refinement (or Global for the main grid). This must be followed by six values which represent the min and Max range for the I, J, and K planes, respectively. All items must be enclosed in double quotes.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'IJKSlices [parameters]'

Show

= <boolean>

Show IJK Slices True or False

IJK

= <option>

View planes selection I, J, or K. Follow this with a Sliceplanes option to designate the plane numbers.

Sliceplanes

= <string, string, string, …​>

Planes to be shown in slices. First string is the name of the local grid refinement (or Global for the main grid), and remaining values are the plane numbers. All strings must be enclosed in double quotes.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'InsideFaults Show=F'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'InsideFaults Persistent=T'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'InsideFaults Select="Constraint:Tranx⇐0", "Fault2" ,"NNCs:Upstream"'

Set options for displaying Inside Views of faults in 3D Grid plots.

Select

= <string, string, string, …​>

Selects one or more named faults, defined constraints, and/or NNCs, which must be specified as displayed in the Tecplot RS sidebar (see example syntax above)

Show

= <boolean>

Show faults True or False

Persistent

= <boolean>

If True, the Faults Inside View will remain visible when switching to other Inside Views.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'InsideLGRs [parameters]'

Show

= <boolean>

Show LGRs True or False

LGR

= <string, string, string, …​>

LGRs to be shown. Global refers to the global grid.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Isosurfaces [parameters]'

Set options for displaying Inside Views in 3D Grid plots using Iso-surfaces.

Show

= <boolean>

Show Iso-surfaces True or False

Variable

= <string>

Specify the variable that defines the iso-surface

Count

= <integer>

Specify the number of iso-surfaces (1 or 2).

Value1

= <double>

Sets value for first iso-surface

Value2

= <double>

Sets value for second iso-surface

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'WellBlanking [parameters]'

Set options for displaying Inside Views in 3D grid plots using Well Blanking.

Show

= <boolean>

Show Well Blanked cells True or False

Include

= <boolean>

Option to include cells between completion nodes - True or False.

DisplayOption

= <option>

Option for limiting which wells are displayed - All or Selected.

Selectedwells

= <string, string, …​>

List of well names (enclosed in quotes) to include in display.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYZSlices [parameters]'

Set options for displaying Inside Views in 3D Grid plots using XYZ Slices.

Show

= <boolean>

Off

Show XYZ Slices True or False

XYZ

= <parameter>

X

Slice plane X, Y or Z.

Planes

= <integer>

1

Number of planes to display.

Min

= <integer>

25

Relative position of first plane, expressed as a percentage from 0 to 100.

Max

= <integer>

75

Relative position of last plane, expressed as a percentage from 0 to 100.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'MultiFrameOptions [parameters]'

Set multiple frame options.

FrameMode

= <option>

Frame mode Single or Multi.

LinkViews

= <boolean>

Link frame views True or False.

LinkBlanking

= <boolean>

Link frames for cell value blanking, pick blanking and inside views True or False.

LinkLayers

= <boolean>

Link layer toggles on frames True or False.

LinkWells

= <boolean>

Link well display on frames True or False.

Numrows

= <integer>

Number of rows of frames (for multi-frame mode).

NumCols

= <integer>

Number of columns of frames.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PaperLayout [parameters]'

Set options from the paper layout dialog.

ColorNum

= <integer>

Integer between 0 and 63, corresponding to Tecplot standard colors

DesignMode

= <boolean>

True or False. When editing the paper templates, you must surround the commands with the On and Off modes to indicate that commands are being applied to the paper layout template rather than the plot frame.

DynamicText

= <string>

Adds dynamic text to the active frame

Footerheight

= <integer>

If a footer is included, the height as a percentage of paper height.

FooterWidth

= <integer>

If a footer is included, the width as a percentage of paper width.

HeaderHeight

= <integer>

If a header is included, the height as a percentage of paper height.

Headerwidth

= <integer>

If a header is included, the width as a percentage of paper width.

PageNumber

= <integer>

Sets the starting page number.

PaperOrientation

= <string>

Landscape or Portrait

ShowFooter

= <boolean>

Include a footer frame True or False.

ShowHeader

= <boolean>

Include a header frame True or False.

ShowPaper

= <boolean>

Set paper display in the Tecplot RS workspace

Size

= <string>

Letter, Double, A4, A3, Custom1 or Custom2

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'Performance [parameters]'

This command allows you to set options affecting Tecplot RS performance.

GraphicsCache

= <option>

Sets the graphics caching mode. All, Lightweight, or None

Approximation

= <option>

Sets the approximation mode - Off, Auto, Noncurrent, or All.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Axis [parameters]'

Set options for plotting axes on Xy plots.

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 Standard Options.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Cell_Labels [parameters]'

Set options for labeling cells on grid plots

Color

= <ColorOption>

Label color. Any of the standard colors listed in Standard Options.

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 Standard Options.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Grid [parameters]'

Set options for plotting grids.

MeshColor

= <ColorOption>

Any of the colors listed in Standard Options, 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

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Gridaxes [parameters]'

Set options for plotting axes on grid plots.

Parameter

Syntax

Notes

Color

= <ColorOption>

Label color. Any of the standard colors listed in Standard Options.

Font

= <FontOption>

Label font.

LineColor

= <ColorOption>

Axis line color. Any of the standard colors listed in Standard Options.

ShowXYZ

= <boolean>

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

Size

= <double>

Label size, ranging from 0.1 to 5.0.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Inactivegrid [parameters]'

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

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.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Labels [parameters]'

Set label options.

Font

= <FontOption>

Any of the allowable fonts specified in Standard Options.

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 Standard Options.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Misc [parameters]'

Set time variable and animation options.

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".

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Scaling [parameters]'

Set options for scaling.

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

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Well_Labels [parameters]'

Set options for labeling wells on grid plots.

Include

= <boolean>

Include well names.

Color

= <ColorOption>

Label color. Any of the standard colors listed in Standard Options.

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 Standard Options.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Well_Options [parameters]'

Set options for general well display on grid plots.

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

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_WellSymbols [parameters]'

Set options for plotting wells and bubbles.

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 Standard Options.

Size

= <double>

Size (in percent).

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotOptions_Xy [parameters]'

Set options for Xy plots.

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 Standard Options, 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 Standard Options, 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.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'RSVFile Type=<RSVType>'

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

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.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UpdateOptions'

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

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SelectionSet_Save Entity=<List> Name=<String>'

This command saves or edits a selection set.

Entity

= <String, String, …​>

One or more paired entity names and entity numbers. The entity number should be zero in most cases. If the entity represents a well layer or completion, the value should be the completion number. If the entity is from an RFT file, the number represents the time step for that well name.

Name

= <String>

The name to be assigned to the selection set.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SelectionSet_Delete Name=<String>'

This command deletes an existing selection set.

Name

= <String>

The name to be assigned to the selection set.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SelectionSet_Rename Name=<String> Name=<String>'

This command renames an existing selection set. Two names must be provided the original name and the new name.

Name

= <String>

The original name of the selection set.

Name

= <String>

The new name of the selection set.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'MakeUserGroups
                             SumVars = "<String>", "<String>", "<String>"
                             AvgVars = "<String>", "<String>"
                             NewVars = "<String>", "<String>", "<String>"
                             SelectionSets = "<String>", "<String>"
                             Active = "<Boolean>" '

This command creates a user group from one or more existing selection sets.

SumVars

= <String>, <String>, …​

List the variables for Tecplot RS to include in a summation.

AvgVars

= <String>, <String>, …​

List the variables for Tecplot RS to include in an average (OPT).

NewVars

= <String>, <String>, …​

List the variables that you wish Tecplot RS to calculate.

SelectionSets

= <String>, <String>, …​

List the existing selection sets you wish Tecplot RS to use.

Active

= <Boolean>

Controls whether the group creation affects only the active data set (TRUE) or all loaded data sets (FALSE). Defaults to TRUE.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'MakeWellPatterns
                             SumVars = "<String>", "<String>", "<String>"
                             NewVars = "<String>", "<String>", "<String>"
                             SelectionSets = "<String>", "<String>" '

This command creates a user group from one or more existing selection sets.

CumVars

= <String>, <String>, …​

List the cumulative variables, which show the accumulated production for each time step

SumVars

= <String>, <String>, …​

List the variables for Tecplot RS to include in a summation.

NewVars

= <String>, <String>, …​

List the variables that you wish Tecplot RS to calculate.

SelectionSets

= <String>, <String>, …​

List the existing selection sets you wish Tecplot RS to use.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'CompareSetup [parameters]'

If the comparison toggle is turned on for a plot, use this command to choose the comparison data sets and options for displaying them.

CompareDataSet

= <string, string, …​>

Specify one or more file names. Order of files determines how they will appear in legend. Files must be loaded first.

If a filename is listed more than once, the duplicates will be ignored. For example: CompareDataSet 'f1.hist' 'f2.hist' is equivalent to: CompareDataSet 'f1.hist'

If a filename is the active filename, it will be ignored since the active file cannot be a comparison file. For example: CompareDataSet 'f1.hist' 'f1.usmry' is equivalent to CompareDataSet 'f1.hist' if 'f1.usmry' is the active file.

DataSetOrdering

= <string, string, …​>

Sets the ordering in which datasets will be displayed in the Compare XY Data Sets dialog.

ShowReference

= <boolean>

Controls whether the reference data are shown when the Delta option is turned on.

StyleSet

= <option>

Option for handling comparison style set when more files are compared than there are available stylesets Cycle or Repeat

LegendStyle

= <option>

Control how comparison file names appear in the legend Name, NamePlus, or None

DeltaType

= <string>

Defines option for computing delta values. Allowed options are:
VC-VR (Default)
VR-VC
VC represents V_ref, the active value, and VR represents V_comp, the comparison value(s).

Normalize

= <boolean>

Defines whether to normalize the delta values by V_ref True or False.

DeltaMagnitude

= <boolean>

Defines whether to use delta magnitudes True or False.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'CompletionSetup [parameters]'

Sets parameters for completion profiles.

Well

= <string>

Name of layered well to plot.

Times

= <integer>

Time to plot (one-based index).

ShowPercentages

= <boolean>

Show/hide percentages.

CompletionLabels

= <option>

Possible values: None, Depth, KPlane

XAxis1

= <string, string, …​>

X1-axis variable names

XAxis2

= <string, string, …​>

X2-axis variable names

XAxis3

= <string, string, …​>

X3-axis variable names

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'PlotXY Type=<PlotType>'

This command draws an XY plot of the specified type. Before using this command, you should call the Setup command for the associated plot type. For example, before doing an XY Entities plot, specify the variables and entities to plot with one or more XYEntitiesSetup commands.

Type

= <option>

Type of plot to draw. Must be XYEntities, XYVariables, XYSubsets, XYFreeStyle, RFT, Custom, CustomEntities or Completion.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'RFTSetup [parameters]'

Set parameter options for RFT plots.

Entity

= <string, string>

Paired entity name and entity number. The entity number represents the time step for that well name.

XAxis

= <string>

X-axis variable name.

YAxis

= <string>

Y-axis variable name.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'SolvePTime Variable="GPR" ApplyToAllFiles=T'

Finds the time production started, creating a new variable called PTime that stores the time relative to the start of production for each entity.

Parameter

Syntax

Notes

Variable

=<string>

Variable that becomes non-zero when a well or other entity begins production (usually OPR or GPR)s

Parameter

Syntax

Notes

ApplyToAllFiles

= <boolean>

If True, PTime will be calculated for all open files. If False, it is calculated only for the current file. Default: False.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions SelectBy=Source'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions ColorBy=Sink'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions Variable="Swat"'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions Skip=4'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions LineThickness=0.4'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions TimePercent=60'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions LogScale=T'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'StreamLineOptions SelectStreams="1"'

Options for controlling the appearance of streamlines in 3D plots.

SelectBy

= <option>

All, Source, Sink, Pair

ColorBy

= <option>

Source, Sink, Pair, Variable, TOF

Variable

= <string>

Variable name for ColorBy option

Skip

= <integer>

1 to 100. Skip interval for thinning the number of streams to display.

TimePercent

= <integer>

0 to 100. Slider position for TOF display.

LogScale

= <boolean>

True or False. Determines whether TOF is scaled logarithmically

Persistent

= <boolean>

If True, causes streamlines to continue to be displayed when another Inside View is selected.

SelectStreams

= <string>

Identifiers for streams to plot. Allowable values depend on SelectBy option.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UpdateStreamLines'

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'UpdateStyles'

Force updating of plot styles.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYCustomSetup [parameters]'

Set options for XY Custom plots.

Entity

= <string, string>

Paired entity name and entity number. The entity number should be zero in most cases. If the entity represents a well layer or completion, the value should be the completion number. If the entity is from an RFT file, the number represents the time step for that well name.

Compare

= <boolean>

Compare data sets.

Delta

= <boolean>

Use delta to compare data sets. Ignored if Compare=False.

Frame

= <integar>

Frame number of the first of (potentially) multiple frames to plot.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYDisplayName FName= "<string>" Name="<string>"'

Specifies the label to identify the file in legends and paper layouts. This is especially useful when working with comparison plots.

FName

= <string>

File name.

Name

= <string>

Name to display when file FName is in use.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYEntitiesSetup [parameters]'

Sets options for the XY Entities plot.

Entity

= "<name1>","<number1>",
"<name2>","<number2>"…​

One or more paired entity names and entity numbers. The entity number should be zero in most cases. If the entity represents a well layer or completion, the value should be the completion number. If the entity is from an RFT file, the number represents the time step for that well name.

YAxis

= <string>

Y-axis variable.

XAxis

= <string>

X-axis variable.

Sum

= <boolean>

Sum option.

Average

= <boolean>

Average option.

ManualFrameAssignments

= <string>[,<string>,…​]

Each string is of the from "[frame number], [variable name]". For example, to assign the variable "Api", to multi frame 2, use the following command:

ManualFrameAssignments="2,Api"

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYEquations EquationList=<string, string, …​> Apply=<option.>'

Defines one or more equations to be used to create new XY variables.

EquationList

= <string, string, …​>

List of equations. Note that any existing equations will be removed and replaced with the equations specified in this list.

Equation

= <string>

Appends a single equation to the list of XY equations to define.

Apply

= <option>

Entity type on which equations are to be applied (can be repeated) Wells, Completions, Field, Areas, Regions, FlowStat, QualityData, RFTdata, GatherStat, Aquifer, BlockData, UserGroups, or Other.

Errorignore

= <boolean>

If No (the default), Tecplot RS displays an error message when a division by zero occurs and does not create any new variables. If Yes, the affected data value will be set to 0 (when the number being divided is zero) or -999999 (when the dividend is nonzero).

ApplyToAllFiles

= <boolean>

Default is False.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYFiltering [parameters]'

Set filtering options for XY plots.

TypeFilter

= <option, option, …​>

Type filter can select more than one. Wells, Completions, Field, Areas, Regions, FlowStat, QualityData, RFTdata, GatherStat, Aquifer, BlockData, UserGroups, Nodes, Connections, ConnList, or Other.

EntityFilter

= <string, string>

If further filtering is desired, this lists the entities (paired entity name and entity number). The entity number should be zero in most cases. If the entity represents a well layer, the value represents the completion number. If the entity is from an RFT file, the number represents the time step for that well name.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYManualSetup PageNumber = <integer>'

Specifies the page number for the XY FreeStyle plot.

PageNumber

= <integar>

Specify the page number for the XY FreeStyle plot.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYSorting [parameters]'

Set sorting options for entities in XY plots.

SortType

= <option>

Sort type ByName, ByType, or ByVariable.

SortDir

= <option>

Sort direction - Ascending, or Descending

Sortvariable

= <string>

If sort type is by variable, the variable name on which sorting is performed.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYSubsetSetup [parameters]'

Set options for XY Subset plots.

Entity

= <string>

Entity Name

XAxis

= <string>

Name of the variable assigned to the X-Axis.

YAxis

= <string>

Name of the variable assigned to the Y-Axis.

Sum

= <boolean>

Set to True to sum the variable across all entities being plotted.

Average

= <boolean>

Set to True to display the average value for all selected entities.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'XYVariablesSetup [parameters]'

Set parameter options for XY Variables plot.

Entity

= <string, string>

Paired entity name and entity number. The entity number will be zero in most cases. If the entity represents a well layer or completion, the value should be the completion number. If the entity is from an RFT file, the number represents the time step for that well name.

XAxis

= <string>

X-axis variable name.

YAxis1

= <string, string, …​>

Y1-axis variable name(s).

YAxis2

= <string, string, …​>

Y2-axis variable name(s).

YAxis3

= <string, string, …​>

Y3-axis variable name(s).

YAxis4

= <string, string, …​>

Y4-axis variable name(s).

YAxis5

= <string, string, …​>

Y5-axis variable name(s).

Compare

= <boolean>

Compare data sets.

Delta

= <boolean>

Show delta. Ignored if Compare=False.

ManualFrameAssignments

=<string>[,<string>,…​]

Each string is of the form "[frame number], [entity name], entity layer]". For example, to assign the entity "Oil-3", layer 0, to multi frame 2, use the following command:

ManualFrameAssignments="2,Oil-3,0"

The layer number must be included even if it is zero.

$!AddonCommand
   AddonID = 'Tecplot RS'
   Command = 'WriteXYData FName=<string>
      Separator=<separator> FileMode=<FileMode>'

This command creates an Ascii text file from the current XY line plot. Before calling this command, you must set up an XY line plot either in the Gui or with other RS macro commands.

You may continue to append to the same data file by calling this command more than once with Append=True. Typically you would do this after modifying the XY plot.

FName

= "<string>"

Template folder.

Separator

= <separator>

One of either Comma, Tab, Space (default Comma). For importing into Excel, Comma is recommended with a .csv filename.

FName

= <FileMode>

Append or Overwrite. Default is Overwrite

Black

Olive

Blue

Orange

Brown

Pink

Cream

Purple

Cyan

Red

Gold

Rose

Gray

Sapphire

Green

Silver

Indigo

Sky

Lilac

Teal

Lime

Violet

Maroon

White

Navy

Yellow

Courier

CourierBold

Helvetica

HelveticaBold

Times

TimesBold

TimesBoldItalic

TimesItalic

Parameter

Syntax

Notes

Use_RSManagerSettings

= <boolean>

Was used to designate whether the Plot Options dialog controlled settings that could be adjusted by selecting "Assign Axis Variables" from the Plot menu. False ignored the settings in the Plot Options dialog in favor of settings made in a now-obsolete Tecplot RS dialog.