Math Blocks > Arithmetic function block

Arithmetic function block parameters

The following table lists the parameters for the Arithmetic function block.

Table: Arithmetic function block parameters

Parameter

Units

Description

ABNORM_ACTIVE

None

The indication that a block error condition not selected in BAD_MASK (on the function block level) is True (Active) or the indication that an error condition (at the module level) not selected in MERROR_MASK is True (Active) or a module status not selected in MSTATUS_MASK is True (Active).

ALERT_KEY(1)

None

A user-assigned identification number reported in alarm messages from the block that allows HMI applications to sort and filter alarms and events. Set this parameter for each function block to indicate the physical unit the function block is associated with. This information can be used in the host for sorting alarms, and so on.

ARITH_TYPE

None

The set of nine arithmetic functions applied as compensation to or augmentation of the range extended input.

BAD_ACTIVE

None

The indication that a block error condition selected in BAD_MASK (at the function block level) is True (Active) or the indication that an error condition (at the module level) selected in MERROR_MASK is True (Active) or a module status selected in MSTATUS_MASK is True (Active).

BAD_MASK

None

The set of active error conditions that triggers a user-defined Bad condition. The user selects a subset of block error (BLOCK_ERR) conditions in the BAD_MASK parameter. When any of these conditions are True, the BAD_ACTIVE parameter becomes True. When any of the BLOCK_ERR conditions that are not included in BAD_MASK are True, ABNORM_ACTIVE becomes True.

BAL_TIME

Seconds

Specifies the time for a block value to match an input, output, or calculated value or the time for dissipation of the internal balancing bias.

BIAS

None

The bias value

BIAS_IN_1

None

The bias value for IN_1

BIAS_IN_2

None

The bias value for IN_2

BIAS_IN_3

None

The bias value for IN_3

BLOCK_ERR

None

The summary of active error conditions associated with the block. The possible block errors are:

  • Out of Service

  • Input Failure/Bad PV

COMP_HI_LIM

EU of PV_SCALE

Determines the high limit of the compensation input

COMP_LO_LIM

EU of PV_SCALE

Determines the low limit of the compensation input

GAIN

None

The proportional gain (multiplier) value

GAIN_IN_1

None

The proportional gain (multiplier) value for IN_1

GAIN_IN_2

None

The proportional gain (multiplier) value for IN_2

GAIN_IN_3

None

The proportional gain (multiplier) value for IN_3

IN

Determined by source or EU of PV_SCALE or EU of IN_SCALE

The analog input value and status. The number of inputs is an extensible parameter in some function blocks.

IN_1

Determined by supplying block or source

The first analog input value and status

IN_2

Determined by supplying block or source

The second analog input value and status

IN_3

Determined by supplying block or source

The third analog input value and status

IN_LO

None

The value used for the input whenever IN is below range

INPUT_OPTS

None

Allow you to set the options for using IN and IN_LO when Uncertain. They also allow you to set the options for using IN_1, IN_2 and IN_3 when any are either Bad or Uncertain. When a particular option is not selected and the status is Bad or Uncertain, the last usable value is used. A value is usable if the status is Good or if the status is not Good but the input option for that status (Bad or Uncertain) is selected to use it. To change the input options while using the on-line view, first change the mode to OOS.

MODE

None

The mode record of the block. MODE contains the actual, target, permitted, and normal modes. In some function blocks, this parameter is used to request and show the source of the setpoint, the source of the output, and/or the block operating state.

OUT

EU of OUT_SCALE or Percent or EU of IN

The analog output value and status. The number of outputs is an extensible parameter in some blocks.

OUT_HI_LIM

EU of OUT_SCALE or Supplied by IN

The maximum output value allowed

OUT_LO_LIM

EU of OUT_SCALE or Supplied by IN

The minimum output value allowed

PRE_OUT

EU of PV_SCALE

The calculated result of the selected math function after limiting

PV

EU of OUT or EU of PV_SCALE or EU of IN_SCALE

The process variable used in block execution and alarm limit detection

PV_SCALE(1)

None

The high and low scale values, the engineering units code, and the number of digits to the right of the decimal point associated with the PV.

RANGE_HI

EU of PV_SCALE

The high limit for IN

RANGE_LO

EU of PV_SCALE

The low limit for IN. If IN is less than RANGE_LO, then IN_LO is used.

ST_REV(1)

None

The revision level of the static data associated with the function block. To support tracking changes in static parameter fields, the associated block's static revision parameter is incremented each time a static parameter field value is changed. Also, the associated block's static revision parameter is incremented if a static parameter field is written but the value is not changed.

STRATEGY(1)

None

Used to identify groupings of blocks. This data is not checked or processed by the block.

(1) These parameters are only visible when the function block is extended to a fieldbus device.