System Coupling Setup

System Coupling Setup
This container holds Set Up data for an instance of System Coupling.

Methods

CreateDataTransfer

Creates a data transfer.

Return The new data transfer that was created.
Type DataReference

Required Arguments

Name The name for this data transfer.
Type string

Optional Arguments

SourceParticipant The source of this data transfer.
Type DataReference
SourceRegion The source Region for this data transfer.
Type DataReference
SourceVariable The source Variable for this data transfer.
Type DataReference
TargetParticipant The destination for this data transfer.
Type DataReference
TargetRegion The destination region for this data transfer.
Type DataReference
TargetVariable The destination variable for this data transfer.
Type DataReference

Example

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)

ExportSCIFile

Writes the system coupling input file at the specified path.

Required Arguments

Path Fully qualified path of the SCI File.
Type string

GetAnalysisSettings

Returns the analysis settings entity in a container.

Return Data reference of the analysis settings in the container.
Type DataReference

GetDataTransfer

Returns the data transfer of a given name in a container.

Return The data transfer that matches the specified name.
Type DataReference

Required Arguments

Name The name or display name of the data transfer.
Type string

GetDataTransfers

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.
Type DataReferenceSet

GetExpertSettings

Returns the expert settings entity from a system coupling setup container.

Return Data reference of the expert settings in the container.
Type DataReference

GetIntermediateRestartDataOutputControls

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.
Type DataReference

GetParticipant

Returns the participant with a given name from a system coupling setup container.

Return The participant that matches the specified name.
Type DataReference

Required Arguments

Name The internal name or display name of the participant.
Type string

GetParticipants

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.
Type DataReferenceSet

GetSequenceControls

Returns the sequence controls from a system coupling setup container.

Return Data reference of the sequence controls in the container.
Type DataReference

ReadRestartPoints

Generates a list of restart points in analysis settings

Data Entities

AnalysisSettings

The entity to store the analysis settings for a coupling run.

Properties

AnalysisType

The coupled analysis type.

Type CoupledAnalysisType
Read Only No

DisableSolutionUpdate

This flag disables updates if restarts are not supported and solution data exists

Type bool
Read Only No

DisplayText

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.

Type string
Read Only No

DurationDefinedBy

This property specifies how we should determine the end of the coupling run.

Type DurationType
Read Only No

EndTime

The end time for the coupling run

Type Quantity
Read Only No

Initialization

The initialziation setting.

Type InitializationType
Read Only No

MaximumIteration

The maximum number of iterations per coupling step for the coupling run.

Type int
Read Only No

MinimumIteration

The minimum number of iterations per coupling step for the coupling run.

Type int
Read Only No

NumberOfSteps

The number of time steps for the coupling run.

Type int
Read Only No

RestartStep

The restart step for the coupling run.

Type int
Read Only No

RestartTime

The restart time for the coupling run.

Type Quantity
Read Only No

StepSize

The step size for the coupling run.

Type Quantity
Read Only No

DataTransfer

Entity to store a data transfer information.

Properties

DisplayText

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.

Type string
Read Only No

IsSuppressed

Suppression state of the entity.

Type bool
Read Only No

SourceParticipant

Participant system providing the data.

Type DataReference
Read Only No

SourceRegion

Participant region providing the data.

Type DataReference
Read Only No

SourceVariable

Variable provided by the source participant.

Type DataReference
Read Only No

TargetParticipant

Participant consuming the data.

Type DataReference
Read Only No

TargetRegion

Participant region consuming the data.

Type DataReference
Read Only No

TargetVariable

Variable consumed by the target participant.

Type DataReference
Read Only No

TransferSettings

Settings to specify how the data transfers are executed.

Type DataReference
Read Only No

Methods

Delete

Deletes a specified data transfer.

Duplicate

Duplicates the data transfer.

Return Data reference to the duplicate data transfer.
Type DataReference

GetSettings

Returns the settings for a specified data transfer.

Return The data transfer settings.
Type DataReference

SetSuppression

Suppresses or unsuppresses a data transfer

Required Arguments

Suppressed The boolean value to specify if the item should be suppressed or unsuppressed
Type bool

DataTransferSettings

Entity to store the settings for the data transfer control.

Properties

ConvergenceTarget

The target value used when evaluating convergence of the data transfer within a coupling iteration.

Type double
Read Only No

DisplayText

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.

Type string
Read Only No

Ramping

Setting that defines the ramping.

Type RampingType
Read Only No

TransferAt

Setting that defines when the transfers should happen.

Type TransferAtType
Read Only No

UnderRelaxationFactor

Convergence stability factor for highly non-linear couplings.

Type double
Read Only No

ExecutionControlSettings

No details are provided for this entry.

Properties

DisplayText

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.

Type string
Read Only No

EngineVersion

No details are provided for this entry.

Type int
Read Only No

ExpertSettings

The entity to store advanced options for data mapping.

Properties

DisplayText

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.

Type string
Read Only No

Settings

The expert setting parameters dictionary.

Type Dictionary<string, string>
Read Only No

Methods

AddProperty

Adds a property to expert settings.

Required Arguments

Property Property to be added.
Type string

GetProperty

Returns the property value for a specified property.

Return The value of the property.
Type string

Required Arguments

Property The name of the property.
Type string

RemoveProperty

Removes an existing property from expert settings.

Required Arguments

Property Property to be removed.
Type string

SetProperty

Sets the value of a property in expert settings.

Required Arguments

Property The name of the property.
Type string
Value The value of the property.
Type string

IntermediateResultFilesOutputControls

The entity to store the settings for result files creation during a coupling run.

Properties

DisplayText

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.

Type string
Read Only No

OutputFrequency

This property specifies the frequency at which the result files are generated.

Type OutputFrequencyType
Read Only No

StepInterval

The step interval at which the result files are generated.

Type int
Read Only No

SequenceControl

The entity to store solver sequence information for a coupling run.

Properties

DisplayText

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.

Type string
Read Only No

Sequence

Dictionary containing sequence values for each participant.

Type Dictionary<DataReference, int>
Read Only No

Methods

GetSequence

Returns the sequence value for a participant.

Return Sequence value for the given participant.
Type int

Required Arguments

Participant The participant for which to get the sequence.
Type DataReference

SetSequence

This command will set the sequence number for the specified participant.

Required Arguments

Participant The participant for which to set sequence value.
Type DataReference
Value Sequence value for the given participant.
Type int

SystemCouplingCoSimulationParticipant

This is a base class for the entity which represents System Coupling Co-simulation Participant information.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingParticipant

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

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingRegion

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.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The name of the region as understood by the solver

Type string
Read Only No

Topology

The topology of the region

Type TopologyType
Read Only No

SystemCouplingStaticDataParticipant

This is a base class/entity for the entity which represents System Coupling Static Data Participant information.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingSteadyCoSimulationParticipant

The entity represents System Coupling Steady Co-simulation Participant information e.g. information related to Static Structural Participant System for coupling purpose.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingSteadyStaticDataParticipant

The entity represents System Coupling Steady Static Data Participant information e.g. information related to External Data Participant System for coupling purposes.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingTransientCoSimulationParticipant

The entity represents System Coupling Transient Co-simulation Participant information e.g. information related to Transient Structural Participant System for coupling purposes.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingTransientStaticDataParticipant

The entity represents System Coupling Transient Static Data Participant information.

Properties

DisplayText

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.

Type string
Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string
Read Only No

SystemCouplingVariable

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.

Properties

DataType

The tensor type of the variable

Type DataTypeEnumeration
Read Only No

DisplayText

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.

Type string
Read Only No

Exposure

The type of transfer that will be done with this variable

Type VariableExposure
Read Only No

InternalName

The name of the variable

Type string
Read Only No

PhysicalType

The quantity type of the variable

Type string
Read Only No