User-defined keywords page

This is the Next >> page accessed via WizGen in Flexible project mode from the Coordinate System page or by selecting the Goto... button for Define new keywords for cell or connection properties from the Contents page.

Up to 10 new Cell Property and/or 5 new Connection Property keywords can be added to allow the inclusion of user-defined properties in the calculations performed by TransGen. Each new keyword added on this page is appended to the TGNEWKEY keyword string in the TGDATA runfile.

Examples of the need for User-defined keywords

To import new user-defined cell or connection properties into the model; the new properties are identified as keywords which can then be entered on the Included Data page.

To define new cell or connection properties for use in FSP and/or User-defined plugins. See Example below where User-defined keywords are used to build a FSP measure via the CELLPROP plugin.

To graphically display (or output to file) cell/connection properties in ViewGen which are not automatically available, e.g. effective vshales associated with a particular Fault Seal Potential measure and/or which cells are designated as shales in the current model run.

NOTE:- In TransGen Version 2, the item Effective Vshale appeared in the cell properties pulldown menu in the graphical interface. In Version 3 there is no longer necessarily a unique value of Effective Vshale in each grid-block, since each FSP measure (up to 5 of which can be included in a single TransGen run) can be based on a different definition of Effective Vshale. Therefore, if graphical display of an Effective Vshale associated with a particular FSP is required, it must be defined as a user-defined cell property.

1. Input required Cell and/or Connection Properties

Click on the relevant Property type (Cell Property is selected by default) and type an appropriate name.
For example, the keywords evs1 and binary_shale have been input as 2 new Cell Properties.

Up to 10 new user-defined Cell Property and 5 new Connection Property keywords can be added. Each name can be up to 32 characters long and may contain underscores (_) and numbers as well as letters. However, the first character of the name MUST be a letter.

HINT:- The letters can be either upper or lower case or a mixture of both.  If the property is used in a plugin (to calculate a FSP measure or in a user-defined plugin), remember C++ is case sensitive and all prefix and property names should be used in lower case.

2. Save to TGDATA runfile

Click on the Save button at the bottom right of the page to add the TGNEWKEY to the TGDATA run file with following strings:-

TGNEWKEY
'evs1' 1 /
'binary_shale' 1 /
/

Once user-defined cell or connection properties have been defined by keywords added on this page, they can be included in the TransGen run in exactly the same way as standard grid-block properties such as ntg, tgvs, permx, permy (via the Included Data page of WizGen) and/or used in a FSP measure (via the Fault Seal Potential Variables page of WizGen) and/or in a User-defined plugin (via User-defined plugin page of WizGen as shown in the example below), output as data files (via the Output page) and visualised in the graphics interface.

Using the two-phase flow functionality

If you are licensed to use the Two-phase flow module and have chosen to Include two-phase fault rock calculations (via Title page of WizGen) in the current TransGen run, the property used to declare the across-fault flow rates must be declared on the User-defined keywords page and the associated file loaded via the Included data page.

The across-fault flow rates are either loaded as a user-defined fault property, i.e. a single value of across-fault flow rate (Darcy velocity) loaded for each connection or calculated from a grid of cell pressures loaded as a user-defined cell property.

In the example shown below, keywords for both these methods of calculating across-fault flow rates have been added to the User-defined keywords page. Each of these keywords appears as the first entry in the relevant data file which then needs to be added to the Included Data page of WizGen.

Including User-defined fault trace properties

If you are licensed to use this new functionality and have chosen to Include fault drag and hierarchical zone effects (via Title page of WizGen) in the current TransGen run, up to 10 user-defined fault trace properties can be declared as keywords on the User-defined keywords page and the associated file(s) containing the keyword(s) and properties loaded via the Included Data page (for further details see Trace Properties in the section on Traces and Fault zones).

To continue the workflow, click on Next >> to view/edit the Included Data page.

Alternatively, click on the << Back button to return to the Coordinate System page to view/edit the title for the current project.

Or click on the Contents button to access the Contents page to view/edit any of the current TGDATA file settings, inspect the project's TGDATA file and/or inspect the log generated by last ViewGen calculation.

Click on Save to save any modifications made to the current TGDATA runfile.
Click on Quit to exit from WizGen with or without saving the any changes to the TGDATA runfile.