AddExpressionFunction()

Given arguments specifying the associated Python module and function definition, adds a Python expression function to the data model.

Cannot be run after participants have started.

For more detailed information on the object created, see ExpressionFunction.

Essential Keyword Arguments

Module : string

String specifying the name of the Python module containing the definition of the function to be added to the coupled analysis.

A module of the specified name must exist in the user-created Modules subdirectory of System Coupling's working directory.

Function : string

String specifying the Python name of the function to be added to the coupled analysis.

The specified function must be defined in the Python module specified by the Module argument.

FunctionName : string

String defining the name to be referenced in when using the expression function in an expression.

If not specified, defaults to value of the Function argument.

Return Type

None

Examples

Example 9: Add an expression function by specifying all arguments


AddExpressionFunction( 
	Module = 'tempModule',
	Function = 'temperature1*10',
	FunctionName = 'Temp2Expr')