Important RCL DEFINE Commands

Most of the settings for the DEFINE commands that you'll list in your scripts (and there will probably be a lot!) will be gleaned using the menu summaries, as described in the Overview section.  However, the following are important "menuless" options - they are automated during normal program operation, and must be specifically listed in the script in order to perform certain functions.

Contents

• Creating 2-D & 3-D Diagrams
• Creating Data and Report Output
• Enabling & Disabling Output Display
• Defining Section, Fence, and Profile Locations
• Defining Solid Model Slice Locations
• Updating GRD Files to RwGrd format
• Updating MOD Files to RwMod format

See also these additional topics:

• RCL Scripting - Overview
• Special RCL Commands
• Important RCL EXECUTE Commands
• RCL Commands - Imports

Creating 2-D & 3-D Diagrams

Creating Two-Dimensional Diagrams

Before executing any procedure that creates two-dimensional diagrams, you should specify the name for the output (Rw2D graphic) file.  Assigning the name in advance is recommended, otherwise, you'll get a stack of "untitled" plot windows which will then require saving manually.  Defining the output file name is accomplished by setting the GENERAL    OUTPUT_2D variable. 

Example

DEFINE:  2D_STRUCTURE  STRAT_UNIT  1 DEFINE:  2D_STRUCTURE  GRID_NAME   Structure01.grd DEFINE:  GENERAL       OUTPUT_2D   Structure01.Rw2D EXECUTE: STRUCTURE_2D

For those programs that generate two 2D graphics, such as a cross-section and a section location map, you only need to define one file name.  A suffix will be added automatically for the second file name.  For example, the section could be named "cross-section.rw2d", and the map would be automatically named "cross-section_A.rw2d".

Creating Three-Dimensional Diagrams

Before executing any procedure that creates three-dimensional diagrams, you should specify the name for the output (Rw3D graphic) file. Assigning the name in advance is recommended, otherwise, you'll get a stack of "untitled" plot windows which will then require saving manually.  Defining the output file name is accomplished by setting the GENERAL    OUTPUT_3D variable. 

Example

DEFINE:  GENERAL   OUTPUT_3D   strat_logs.Rw3D EXECUTE: LOG_FENCE

For those programs that generate two 3D graphics, such as a volume-extracted isosurface and a 3D extraction surface, you only need to define one file name.  A suffix will be added automatically for the second file name.  For example, the isosurface view could be named "volume-extract.rw3d", and the 3D surface view would be automatically named "volume-extract_A.rw3d".

See also: Displaying the diagrams

Table of Contents

Creating Data and Report Output

Creating Datasheet Output

Before executing any procedure that performs computations that result in a row-and-column datasheet, you should specify the name for the output file. This is accomplished by setting the GENERAL   DATASHEET_OUTPUT variable.

Example

DEFINE:  GENERAL  DATASHEET_OUTPUT  lith_volume.rwdat EXECUTE: LITH_VOLUME

For those programs that generate two datasheets, you only need to define one file name.  A suffix will be added automatically for the second file name.  For example, one datasheet could be named "startingdata.rwdat", and the second one would be automatically named "startingdata_A.rwdat".

Creating Text Report Output

Before executing any procedure that performs computations that result in a text report, you should specify the name for the output file.  This is accomplished by setting the GENERAL   REPORT_OUTPUT variable.

Example

DEFINE:  GENERAL  REPORT_OUTPUT  gridstats.txt EXECUTE: GRID_STATS

For those programs that generate two reports, such as a reserves report and grid statistics, you only need to define one file name.  A suffix will be added automatically for the second file name.  For example, the reserves report could be named "coal_reserves.txt", and the second one would be automatically named "coal_reserves_A.txt".

See also: Displaying the output

Table of Contents

Enabling & Disabling Output Display

Let's say that you want RockWorks to create a two-dimensional diagram but you don't necessarily want the user to see it (e.g. you intend to overlay the diagram later on with another diagram or you want to export the diagram to a bitmap format and then import it into your program).  This can be accomplished by disabling the automatic display within RockPlot2D via the GENERAL   DISPLAY_2D setting:

Example

DEFINE:  GENERAL  DISPLAY_2D  False

In a similar fashion, the automatic display of three-dimensional diagrams may also be suppressed via the GENERAL  DISPLAY_3D setting.

Example

DEFINE:  GENERAL  DISPLAY_3D  False

The display of program-computed data in an embedded datasheet tab can be enabled/disabled using the GENERAL  DATASHEET_DISPLAY setting.

Example

DEFINE:  GENERAL  DATASHEET_DISPLAY  False

The display of a program-computed text report in an embedded text tab can be enabled/disabled using the GENERAL  REPORT_DISPLAY setting.

Example

DEFINE:  GENERAL  REPORT_DISPLAY  False

Table of Contents

Defining Section, Profile, and Fence Locations

Profile Locations

For profile diagrams, you have these options:

• Use the currently-defined default, displayed in the Profile Selection Map tab in the program.
• List the profile's X1Y1, X2Y2 coordinates right in the RCL script, as shown in example 1 below.
• Define the profile location in a Profile Table in the project database.  You can then list this table's name in the script.

Example 1

DEFINE:  PROFILE   X1         652779.486902801 DEFINE:  PROFILE   Y1         5535121.486902800 DEFINE:  PROFILE   X2         653464.178006590 DEFINE:  PROFILE   Y2         5535833.565650742 DEFINE:  GENERAL   OUTPUT_2D  profile.rw2d EXECUTE: STRAT_PROFILE

Example 2

DEFINE:  TABLES        PROFILE_TABLE    SouthProfile DEFINE:  LOG_PROFILE   TRUNCATE         false DEFINE:  GENERAL       OUTPUT_2D        profile.rw2d EXECUTE: STRAT_PROFILE

This example names a Profile Table stored in the database under the name "SouthProfile".
This example also illustrates the profile "truncate" option (here, set to false).

Section Locations

For cross sections, you have these options:

• Use the currently-defined default, displayed in the Section Selection Map tab in the program.
• Define the cross-section panel locations in an XY Coordinates Table in the project database.  You can then list this table's name in the script.
• Define the cross-section panel locations in an external ASCII "tab" file.  You can either create this from scratch, or export this from the XY Coordinates Table in the database.  You can then list this file's name in the script.

Example

DEFINE:  TABLES   XY_TABLE   North to South DEFINE:  GENERAL  OUTPUT_2D  N-S.rw2d EXECUTE: STRAT_SECTION

This example names an XY Coordinates table stored in the database under the name "North to South".

Example

DEFINE:  TABLES   XY_TABLE   north to south.tab DEFINE:  GENERAL  OUTPUT_2D  N-S.rw2d EXECUTE: STRAT_SECTION

This example names an external, ASCII "tab" file named "north to south.tab" which has been created by the user or exported from the XY Coordinates table in the database.

Fence Locations

For fence diagrams, you have these options:

• Use the currently-defined defaults, displayed in the Fence Selection Map tab in the program.
• Define the fence panel locations in an XY Pairs Table in the project database.  You can then list this table's name in the script.
• Define the fence panel locations in an external ASCII "tab" file.  You can either create this from scratch, or export this from the XY Pairs Table in the database.  You can then list this file's name in the script.  These tab files simply list the X1 Y1 X2 Y2 coordinates of each panel on a row.

Example

DEFINE:  TABLES   XY_PAIR_TABLE   North End DEFINE:  GENERAL  OUTPUT_3D       north.rw3d EXECUTE: STRAT_FENCE

This example names an XY Pairs table stored in the database under the name "North End".

Example

DEFINE:  TABLES   XY_PAIR_TABLE   north end.tab DEFINE:  GENERAL  OUTPUT_3D       north.rw3d EXECUTE: STRAT_FENCE

This example names an external, ASCII "tab" file named "north end.tab" which has been created by the user or exported from the XY Pairs table in the database.

Table of Contents

Defining Solid Model Slice Locations

The Plan tools in many of the solid model menus (Lithology, I-Data, etc.) require user selection of the slice location.  When you run the program normally, this is done via a pop-up program window.  When you run the program via RCL, you need to use these declarations.

Define the Slice Orientation

Use the MODEL_SLICE   ORIENTATION  setting.  You can choose from horizontal or vertical slices.  Vertical slices are limited to north-south bearing or east-west bearing; oblique slices are not available.

Example

DEFINE:  MODEL_SLICE  ORIENTATION  1 DEFINE:  MODEL_SLICE  COORDINATE   1430 DEFINE:  GENERAL      OUTPUT_2D    plan.rw2d EXECUTE: LITH_PLAN

• Horizontal slices are noted with a "1" as shown above.
• Vertical, East-West slices are noted with a "2".
• Vertical, North-South slices are noted with a "3".

Define the Slice Locations

Use the MODEL_SLICE   COORDINATE  setting.

Example

DEFINE:  MODEL_SLICE  ORIENTATION  1 DEFINE:  MODEL_SLICE  COORDINATE   1430 DEFINE:  GENERAL      OUTPUT_2D    plan.rw2d EXECUTE: LITH_PLAN

• For horizontal slices, you'll be defining an elevation coordinate.
• For vertical, east-west slices, you'll be defining a Northing coordinate.
• For vertical, north-south slices, you'll be defining an Easting coordinate.

Display the Slice Dialog

Use the MODEL_SLICE   DISPLAY_DIALOG  setting if you wish to see the interactive RockWorks slice dialog box displayed.

Example

DEFINE:  MODEL_SLICE  ORIENTATION     1 DEFINE:  MODEL_SLICE  DISPLAY_DIALOG  true DEFINE:  GENERAL      OUTPUT_2D       plan.rw2d EXECUTE: LITH_PLAN

"True" will display the interactive dialog, "false" will not. 

 

Updating GRD Files to RwGrd Format

The format of RockWorks grid models has changed since RockWorks15. This RCL command set is designed to update a series of existing .GRD files to the newer .RwGrd format.

Example

DEFINE:  GRID_CONVERT  GRID_INPUT   A-Horizon_top.grd DEFINE:  GRID_CONVERT  GRID_OUTPUT  A-Horizon_top.RwGrd EXECUTE: GRID_15_TO_16 DEFINE:  GRID_CONVERT  GRID_INPUT   A-Horizon_base.grd DEFINE:  GRID_CONVERT  GRID_OUTPUT  A-Horizon_base.RwGrd EXECUTE: GRID_15_TO_16

• You can repeat this sequence for as many GRD files as you wish to convert.
• RockWorks will assume that the grid models are to be geo-referenced using the current project coordinate system.
• In case you are wondering, RockWorks16 and RockWorks17 use the same RwGrd file format.

Updating MOD Files to RwMod Format

The format of RockWorks solid models has changed since RockWorks15. This RCL command set is designed to update a series of existing .MOD files to the newer .RwMod format.

Example

DEFINE:  SOLID_CONVERT  SOLID_INPUT   Benzene.mod DEFINE:  SOLID_CONVERT  SOLID_OUTPUT  Benzene.RwMod EXECUTE: SOLID_15_TO_16 DEFINE:  SOLID_CONVERT  SOLID_INPUT   Toluene.mod DEFINE:  SOLID_CONVERT  SOLID_OUTPUT  Toluene.RwMod EXECUTE: SOLID_15_TO_16

• You can repeat this sequence for as many MOD files as you wish to convert.
• RockWorks will assume that the solid models are to be geo-referenced using the current project coordinate system.
• In case you are wondering, RockWorks16 and RockWorks17 use the same RwMod file format.

  Back to RCL Overview

RockWare home page