modelReal_Real

Block that exchanges a vector of real values with a Python function

Extends from Modelica.Blocks.Interfaces.DiscreteBlock (Base class of discrete control blocks).

Information

Block that exchanges data with a Python function that does not need to pass an object from one call to the next.

For each element in the input vector uR[nDblWri], the value of the flag flaDblWri[nDblWri] determines whether the current value, the average over the sampling interval or the integral over the sampling interval is sent to Python. The following three options are allowed:

flaDblWri[i]	Value sent to Python
0	Current value of uR[i]
1	Average value of uR[i] over the sampling interval
2	Integral of uR[i] over the sampling interval

If the function needs to pass an object from one invocation to the next, set passPythonObject = true. Otherwise, leave it at its default value passPythonObject = false.

Parameters

Type	Name	Default	Description
SI.Time	samplePeriod (from DiscreteBlock)		Sample period of component
SI.Time	startTime (from DiscreteBlock)	0	First sample time instant
String	moduleName		Name of the python module that contains the function
String	functionName	moduleName	Name of the python function
Integer	nDblWri		Number of double values to write to Python
Integer	nDblRea		Number of double values to be read from the Python
Integer	flag	0	Flag for double values (0: use current value, 1: use average over interval, 2: use integral over interval)
Integer[nDblWri]	flaDblWri	fill(flag, nDblWri)	Flag for double values (0: use current value, 1: use average over interval, 2: use integral over interval)
Boolean	passPythonObject	false	Set to true if the Python function returns and receives an object, see User's Guide

Connectors

Type	Name	Default	Description
Modelica.Blocks.Interfaces.RealInput[nDblWri]	uR		Real inputs to be sent to Python
Modelica.Blocks.Interfaces.RealOutput[nDblRea]	yR		Real outputs received from Python

Components

Type	Name	Description
Real[nDblWri]	uRInt	Value of integral
Real[nDblWri]	uRIntPre	Value of integral at previous sampling instance
Real[nDblWri]	uRWri	Value to be sent to Python
Real[nDblWri]	uRWri_temp	Internal value

Revisions

September 19, 2025, by Michael Wetter:
Updated to Python 3.12.
August 27, 2021, by Michael Wetter:
Updated to Python 3.8.
April 10, 2020, by Jianjun Hu and Michael Wetter:
Updated to Python 3.6.
March 06, 2020, by Jianjun Hu:
Corrected implementation so it allows different flag for double values.
This is for issue #1716.
June 9, 2015 by Michael Wetter:
Set firstTrigger(fixed=true, start=false) to avoid a warning about unspecified initial conditions if Buildings.Obsolete.Utilities.IO.Python27.Examples.KalmanFilter is translated using pedantic mode in Dymola 2016. This is for #426.
September 29, 2014, by Michael Wetter:
Changed algorithm to equation section and assigned start values to avoid a translation warning in Dymola.
February 5, 2013, by Michael Wetter:
First implementation, based on Buildings.Utilities.IO.BCVTB.BCVTB.