modelRead

Block that allows a signal to be read as an FMU output
Diagram of ReadOpen the diagram
▶ Check in your browser

Extends from Modelica.Blocks.Routing.RealPassThrough (Pass a Real signal through without modification).

Information

This block enables the reading of a signal and its meta-data by an external program without the need to explicitly propogate the signal to a top-level model.

Typical use and important parameters

This block is typically used by the BOPTEST framework (see BOPTEST) to identify and read signals as measurements by test controllers. It is used in combination with a dedicated parser to perform this task (see Parser Code). This block is also used by BOPTEST to specify if the signal is needed for calculation of specific key performance indicators (KPI).

The block output y is equal to the input u so that the block can be used in line with connections. However, input signal will also be directed to an external program as an output.

It is important to add a brief description of the signal using the description parameter, assign a unit to the output variable y, assign a type if needed for KPI calculation using the KPIs parameter, and assign a zone designation using the zone parameter if the KPI calculation is specific to a particular zone (for multi-zone models). See documentation for the parameter zone for more details.

Parameters

TypeNameDefaultDescription
StringdescriptionDescription of the signal being read
SignalTypes.SignalsForKPIsKPIsSignalTypes.SignalsForKPIs.NoneTag with the type of signal for the calculation of the KPIs
Stringzone"1"Zone designation, required if KPIs is AirZoneTemperature, RadiativeZoneTemperature, OperativeZoneTemperature, RelativeHumidity, or CO2Concentration
BooleanboptestReadtrueParameter that is used by tools to search for read block in models

Connectors

TypeNameDefaultDescription
RealInputu (from SISO)Connector of Real input signal
RealOutputy (from SISO)Connector of Real output signal

Revisions

  • February 17, 2022 by David Blum:
    Made parameter boptestRead unprotected. This is for #1585.
  • February 23, 2020 by David Blum:
    Added zone designation for KPI calculation by parameter zone. See #1257.
  • January 9, 2020 by David Blum:
    Updated documentation to prompt user to add unit to output. See #1276.
  • July 17, 2019 by Michael Wetter:
    Changed parameter name from Description to description.
  • April 11, 2019 by Javier Arroyo:
    Enumeration type KPI tags added.
  • December 17, 2018 by David Blum:
    First implementation. See #1059.