add_data_transfer

class ansys.systemcoupling.core.adaptor.api_25_2.add_data_transfer.add_data_transfer(name=None, parent=None)

Bases: Command

Adds data transfer based on arguments that specify the interface, target side, and variables to be associated with each side of the interface. The command requires that you specify variables using their names, as described below in Essential Keyword Arguments. Either a variable-based or expression-based data transfer may be created with this command based on the Optional Keyword Arguments. If a variable-based data transfer argument is given, then no expression-based data transfer arguments can be used. If an expression-based data transfer argument is given, then no variable-based data transfer arguments can be used.

Cannot be run after participants have been started.

Returns the name of the Data Transfer created.

Parameters:

interfacestr

String indicating the name of the interface on which the data transfer is to be created.

target_sidestr

String indicating the side of the interface to receive the data transfer variable. Possible values are “One” or “Two”.

source_variablestr, optional

String specifying the name of the variable on the source side of the data transfer. Used when creating a variable-based data transfer. Must be combined with target_variable.

target_variablestr, optional

String specifying the name of the variable on the target side of the data transfer. Must be combined with either source_variable (when creating a variable-based data transfer) or with value_{x|y|z} (when creating an expression-based data transfer).

valuestr, optional

String specifying the expression to use on the source side of the data transfer. Used when creating an expression-based data transfer. If the target_variable is a vector, a vector-valued expression must be provided. Alternatively, value_x, value_y, value_z may be used to specify the individual components of the vector expression.

value_xstr, optional

String specifying the X component of the expression to use on the source side of the data transfer. This may optionally be used when creating an expression-based data transfer if the target_variable is a vector as an alternative to specifying a vector-valued expression in value. value_y and value_z are also required if value_x is used.

value_ystr, optional

String specifying the Y component of the expression to use on the source side of the data transfer. This may optionally be used when creating an expression-based data transfer if the target_variable is a vector as an alternative to specifying a vector-valued expression in value. value_x and value_z are also required if value_y is used.

value_zstr, optional

String specifying the Z component of the expression to use on the source side of the data transfer. This may optionally be used when creating an expression-based data transfer if the target_variable is a vector as an alternative to specifying a vector-valued expression in value. value_x and value_y are also required if value_z is used.

side_one_variablestr, optional

String specifying the name of the variable associated with side1 of the interface. Must be combined with side_two_variable. Used only when creating variable-based data transfers. Consider using source_variable/target_variable parameters instead.

side_two_variablestr, optional

String specifying the name of the variable associated with side2 of the interface. Must be combined with side_two_variable. Used only when creating variable-based data transfers. Consider using source_variable/target_variable parameters instead.

Included in:

Parent	Summary
setup_root	‘root’ object