System Coupling Setup
This container holds Set Up data for an instance of System Coupling.
Creates a data transfer.
Return
The new data transfer that was created. Required Arguments
Optional Arguments
The following example demonstrates creation of a data transfer. It is assumed that user had created two participants (e.g. Transient Structural and Fluid Flow(Fluent) and connected to System Coupling System. System Coupling User's Guide in help documentation provides information on "Tutorial: Oscillating Plate with Two-Way Fluid-Structure Interaction". The same information can be referred to see how two participants can be setup and connect to System Coupling System.
# Get System Couplng Setup
system1 = GetSystem(Name="SC")
setup1 = system1.GetContainer(ComponentName="Setup")
# Get source participant (e.g. Transient Structural) , source region and source variable
participant1 = setup1.GetParticipant(Name="Solution")
region1 = participant1.GetRegion(Name="Fluid Solid Interface")
variable1 = region1.GetVariable(Name="Incremental Displacement")
# Get target participant (e.g. Fluid Flow(Fluent), target region and target variable
participant2 = setup1.GetParticipant(Name="Solution 1")
region2 = participant2.GetRegion(Name="wall_deforming")
variable2 = region2.GetVariable(Name="displacement")
# Create a data transfer
dataTransfer1 = setup1.CreateDataTransfer(
Name="Data Transfer",
SourceParticipant=participant1,
SourceRegion=region1,
SourceVariable=variable1,
TargetParticipant=participant2,
TargetRegion=region2,
TargetVariable=variable2)
Writes the system coupling input file at the specified path.
Required Arguments
Returns the analysis settings entity in a container.
Return
Data reference of the analysis settings in the container.
Returns the data transfer of a given name in a container.
Return
The data transfer that matches the specified name.
Required Arguments
Returns the collection of data transfers in a container. If no data transfers are in the container, the collection is empty.
Return
Collection of the data transfers in the container.
Returns the debug output controls from a system coupling setup container.
Return
Data reference of the debug output controls in the container.
Returns the expert settings entity from a system coupling setup container.
Return
Data reference of the expert settings in the container.
Returns the intermediate result files output controls from a system coupling setup container. Renamed from ResultFiles to RestartData to avoid confusion for MAPDL users.
Return
Data reference of the intermediate result files output controls in the container.
Returns the participant with a given name from a system coupling setup container.
Return
The participant that matches the specified name.
Required Arguments
Returns the collection of participants in a container. If no participants are in the container, the collection is empty.
Return
Collection of the participants in the container.
Returns the sequence controls from a system coupling setup container.
Return
Data reference of the sequence controls in the container.
The entity to store the analysis settings for a coupling run.
This flag disables updates if restarts are not supported and solution data exists
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
This property specifies how we should determine the end of the coupling run.
The maximum number of iterations per coupling step for the coupling run.
The minimum number of iterations per coupling step for the coupling run.
Entity to store a data transfer information.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Settings to specify how the data transfers are executed.
Duplicates the data transfer.
Return
Data reference to the duplicate data transfer.
Returns the settings for a specified data transfer.
Return
The data transfer settings.
Suppresses or unsuppresses a data transfer
Required Arguments
Entity to store the settings for the data transfer control.
The target value used when evaluating convergence of the data transfer within a coupling iteration.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Convergence stability factor for highly non-linear couplings.
Entity to store the debug level information for solution log.
This setting controls the level of output from the �Analysis Initialization� until the �Solution� synchronization point.
This setting controls the level of output from the �Check Convergence� synchronization point until the next synchronization point, which may be either �Shutdown� or �Solution.�
This setting provides the default level for the different kinds of debug output. If this entry is set and another specific entry (e.g., SourceMeshCoords) also exists, then the output level for the specific entry will override the level set here.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
This setting provides the default level for the different sections of debug output. If this entry is set and another specific entry (e.g., Startup) also exists, then the output level for the specific entry will override the level set here.
This setting controls the level of output from the end of the setup validation until the �Analysis Initalization� synchronization point.
This setting controls the level of output after the �Shutdown� synchronization point.
This setting controls the level of output during the setup of coupling steps and iterations. This output does not include information related to the data transfers.
This setting controls the level of output for the source data in all data transfers.
This setting controls the level of output for mesh coordinates of the source region in all data transfers.
This setting controls the level of output for mesh topology (elements and nodes) of the source region in all data transfers.
This setting controls the level of output from the start of the coupling service until creation of the �Summary of SC Setup� banner in the SCL file.
This setting controls the level of output for the target data in all data transfers.
This setting controls the level of output for mesh coordinates of the source region in all data transfers.
This setting controls the level of output for mesh topology (elements and nodes) of the source region in all data transfers.
The entity to store advanced options for data mapping.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Adds a property to expert settings.
Required Arguments
Returns the property value for a specified property.
Return
The value of the property.
Required Arguments
Removes an existing property from expert settings.
Required Arguments
The entity to store the settings for result files creation during a coupling run.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
This property specifies the frequency at which the result files are generated.
The entity to store solver sequence information for a coupling run.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Dictionary containing sequence values for each participant.
Returns the sequence value for a participant.
Return
Sequence value for the given participant.
Required Arguments
This command will set the sequence number for the specified participant.
Required Arguments
This is a base class for the entity which represents System Coupling Co-simulation Participant information.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
This is a base class for the entity which represents System Coupling Participant information. System Coupling Participant information comprises of System and solver-level information related to coupling. Note- Coupling participants are systems that will provide and/or consume data in a coupled analysis. Example systems in Workbench include: Analysis Systems – Steady-State Thermal, Transient Thermal, Static Structural, Transient Structural, Fluid Flow (Fluent) Component Systems – Fluent, External Data
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
This entity represents a System Coupling Region. A region is most often a point, line, surface or volume that is part (or all) of the geometry or topology of a coupling participant.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
This is a base class/entity for the entity which represents System Coupling Static Data Participant information.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
The entity represents System Coupling Steady Co-simulation Participant information e.g. information related to Static Structural Participant System for coupling purpose.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
The entity represents System Coupling Steady Static Data Participant information e.g. information related to External Data Participant System for coupling purposes.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
The entity represents System Coupling Transient Co-simulation Participant information e.g. information related to Transient Structural Participant System for coupling purposes.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
The entity represents System Coupling Transient Static Data Participant information.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The internal name of the multiphysics participant (usually a solver) that is providing this data
This entity represents a System Coupling Variable. A variable is a physical quantity such as force, length, or temperature that can be transferred between regions of participant systems.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The type of transfer that will be done with this variable