data_transfer_child

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

Bases: Container

Configure data transfers for a coupling interface.

Properties

display_namestr

Display name of the data transfer.

suppressbool

Controls whether this data transfer is suppressed

target_sidestr

Target side (“One” or “Two”) of this data transfer.

optionstr

How the transfer data is specified.

Allowed values:

• “UsingVariable” - The data being transferred is defined as a single source-side variable.

• “UsingExpression” - The data being transferred is defined as an expression in terms of source-side variables.

source_variablestr

Variable associated with the source side of the interface.

Specified only for variable-based transfers (and not expression-based).

target_variablestr

Variable associated with the target side of the interface.

valueRealType

Expression string (or constant real value) defining the data being transferred from the source.

Specified only for expression-based transfers.

Any variable referenced must be a source side variable.

ramping_optionstr

Specify whether to apply ramping to the data transfer.

Ramping is used to slow the application of the source-side value on the target side of the interface.

Allowed values:

• “None” - No ramping to be applied.

• “Linear” - Apply linear ramping.

relaxation_factorRealType

Factor multiplying the current data transfer values for specified quantity when under-relaxing them against the previous values.

convergence_targetRealType

RMS-based target value used when evaluating convergence of the specified quantity within a coupling iteration.

mapping_typestr

Type of mapping used for the data transfer. (Read only.)

Possible values:

• “Conservative” - A conservative mapping algorithm is used for transfers of extensive quantities.

• “ProfilePreserving” - A profile-preserving mapping algorithm is used for transfers of intensive quantities.

unmapped_value_optionstr

Option to fill target values not mapped by the regular mapping algorithm.

Possible values:

• “ProgramControlled” - Program decides the best algorithm depending on the data topologies and locations.

• “Nearest Value” - Copy the data from the nearest mapped target location.

• “Interpolation” - Smoothly interpolate the data based on nearby mapped target locations.

• “Extrapolation” - Smoothly extrapolate the data based on nearby mapped target locations.

time_step_initialization_optionstr

Method to initialize first transfer in new coupling step.

Children

Child	Summary
stabilization	Stabilization and Acceleration method.

Included in:

Parent	Summary
data_transfer	Configure data transfers for a coupling interface.