Math Blocks > Integrator function block

Integrator function block parameters

The following table lists the system parameters for the Integrator function block:

Table: Integrator function block system parameters

Parameter

Units

Definition

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

ABSTOTAL

EU of OUT

The sum of the integrated absolute values of input.

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.

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.

BLOCK_ERR

None

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

  • Out of Service - The block is in Out of Service mode.

  • BadPV - The source of the block's process variable is bad.

CLOCK_PER

Seconds

Specifies the period for the time-based integration and reset cycle.

ENABLE_IN_2

None

Specifies whether or not IN_2 is used in the integration:

  • True (1) = use IN_2

  • False (0) = do not use IN_2.

GOOD_LIM

Percent

Sets the good limit for PCT_INCL. If PCT_INCL is above this limit, then OUT receives the status, GOOD.

IN_1

Set by TIME_UNIT1

The first input value and status.

IN_2

Set by TIME_UNIT2

The second input value and status.

INTEG_OPTS

None

Use integration options to specify whether positive and/or negative net values are integrated and whether carryover to the next cycle is used. The integration options are:

  • Flow Forward

  • Flow Reverse

  • Carry

INTEG_TYPE

None

Integration type. Allows you to specify integration and reset behavior. The integration types are:

  • 0 to SP - auto reset at SP

  • 0 to SP - demand reset

  • SP to 0 - auto reset at SP

  • SP to 0 - demand reset

  • 0 to ? - periodic reset

  • 0 to ? - demand reset

  • 0 to ? - periodic and demand reset.

Note  TOTAL_SP is the equivalent of  SP when the function block is located in a fieldbus device.

MODE

None

Parameter used to show and set the block operating state.

N_RESET

None

The number of times the integrator has been reset.

OP_CMD_INT

None

The operator command to reset the integrator. Use either 0 (false/no reset) or 1 (true/reset).

OUT

EU of IN

The integration output value and status. OUT equals TOTAL when the integration type counts up (0 to SP). OUT equals TOTAL when the integration type counts down (SP to 0).

OUT_PTRIP

None

Discrete output that is set True when the integrated value comes within PRE_TRIP of SP or 0.

OUT_TRIP

None

Discrete output that is set when the integrated value reaches the trip target (SP or 0).

OUTAGE_LIM(1)

None

The maximum tolerated duration for power failure.

PCT_INCL

Percent

Indicates the percentage of integrated values with a GOOD status.

PRE_TRIP

EU of OUT

The distance before the trip limit where OUT_PTRIP is set. Note that if PRE_TRIP = 0, OUT_PTRIP is never set.

RESET_IN

None

Discrete input that resets the integrator.

REV_FLOW1

None

Discrete input that designates IN_1 as positive or negative.

REV_FLOW2

None

Discrete input that designates IN_2 as positive or negative.

RTOTAL

Application defined

The accumulated absolute value of all inputs with rejected statuses (BAD or UNCERTAIN).

SABSTOTAL

Application defined

The value of ABSTOTAL immediately before ABSTOTAL is reset.

SP

EU of OUT

The block's setpoint value.

Note  TOTAL_SP is the equivalent of  SP when the function block is located in a fieldbus device.

SRTOTAL

Application defined

The value of RTOTAL immediately before RTOTAL is reset.

SSP

None

The value of SP immediately before SP is reset.

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.

STATUS_OPTS

None

Status options determine how status is handled and processed. If the block is assigned to a controller, the available option is:

  • Uncertain if Man mode

If the block is assigned to a fieldbus device, the STATUS_OPTS parameter is not available.

STOTAL

Application defined

The value of TOTAL immediately before TOTAL is reset.

STRATEGY(1)

None

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

TIME_UNIT1

Selectable time unit

Specifies IN_1 rate time base (seconds, minutes, hours, days).

TIME_UNIT2

Selectable time unit

Specifies IN_2 rate time base (seconds, minutes, hours, days).

TOTAL_SP(1)

None

The setpoint for a batch totalization.

UNCERT_LIM

Percent

Sets the uncertain limit for PCT_INCL. If PCT_INCL is below this limit, OUT receives the status, BAD.

UNIT_CONV

Scalar

User-specified numeric conversion factor to scale IN_2 units to IN_1 units.

Note

Do not include a time factor in the UNIT_CONV value. For example, when IN_1 is liters/hour and IN_2 is gallons/minute, UNIT_CONV = 3.785.

(1) These parameters are only visible when the function block is located in a fieldbus device.
Note

Default values and data type information for the parameters are available by expanding the Parameter View window.