*Parameters

<< Click to Display Table of Contents >>

Navigation:  Flexcom > Data Inputs > $PREPROCESSOR >

*Parameters

Previous pageNext page

Purpose

To define parameters whose names may be referenced subsequently in the definition of other input variables.

Theory

Refer to Parameters and Equations for further information on this feature.

Keyword Format

Two types of lines that may be mixed and/or repeated as often as necessary.

A line defining a single parameter:

Parameter Name, Value

 

A line defining a list type parameter, that generates a number of single parameters:

Parameter Name Prefix, /List of Named and/or Unnamed Values/

 

The list part of the list type parameter must be enclosed in a pair of forward slashes. The List of Named and/or Unnamed Values is a comma or space separated list of parameters to be generated from the list. For Named Values the semicolon is used to separate the name from the value and the name of the resultant parameter is a concatenation of the Parameter Name Prefix and the name of the Named Value. For Unnamed Values the resultant parameter name is a concatenation of the Parameter Name Prefix and the index of the Unnamed Value in the list.

There can be as many Named and/or Unnamed Values in the list as desired. Equations may be used to define the values. If the value is a character expression (as opposed to a numerical value or equation) and contains a space, tab or a comma, then it must be enclosed in quotation marks.

For example the following list type parameter:

Point, /X:11, Y:22, Z:=[Point_X + 10], "unnamed value one", "unnamed value two"/

results in the following individual parameters generated as if they were specified as separate single parameters:

Point_X, 11

Point_Y, 22

Point_Z, =[Point_X + 10]

Point_1, "unnamed value one"

Point_2, "unnamed value two"

 

Refer to ‘Notes’ below for further details.

Table Input

Input:

Description

Parameter:

The name of the parameter being defined. See Note (a) below for details.

Value:

The value of the parameter being defined. Both single and list type parameters may be defined as described above. See Notes (a) and (b) below for details.

Notes

(a)The parameter name and the named value name should not contain white spaces or tabs and must start with a letter character.

(b)If the value is a character expression (as opposed to a numerical value or equation) that contains spaces or tabs then it must be enclosed in quotation marks.

(c)When referencing a parameter, the variable definition must be preceded by the characters =[ and followed by the ] character. Specifically the variable definition will appear in the format =[Parameter], rather than just having an explicitly specified value. For example, you could define a parameter called "OceanDepth", assign it a numerical value, and reference it subsequently using "=[OceanDepth]" rather than explicitly specifying a numerical value.