System Coupling Solution

System Coupling Solution
This container holds Solution data for an instance of System Coupling.

Methods

CreateConvergenceChart

Creates a new convergence chart.

Return     The data reference to the new convergence chart.
    Type     DataReference

Required Arguments

Name    The name for this Convergence Chart.
    Type     string

CreateSolutionInformation

Creates a new solution information entity and adds it to the specified system coupling solution container.

Return     The new solution information that was created.
    Type     DataReference

Required Arguments

Name    The name for this Solution Information.
    Type     string
SolutionInformationFilePath    The path of the file to read solution information.
    Type     string

GetAllSolutionInformation

Returns the collection of solution information entities in a container. If no solution information entities are in the container, the collection is empty.

Return     Collection of the solution informations in the container.
    Type     DataReferenceSet

GetChartVariableNames

Returns a dictionary of fully qualified chart variable names and display names.

During System Coupling Solution cell Update or after Solution cell Update, these names can be used to create chart variable using "CreateVariable" data entity method of "ConvergenceChart".

Data transfer chart variable

Qualified Name Format - "Target Participant Internal Name":"Data Transfer Internal Name":"Variable Name": "Operator Name"
Qualfied Name Example- "Solution 1:Data Transfer 1:Change:Maximum"
Display Name Example- "Fluid Flow (FLUENT):Data Transfer 1:Change:Maximum"

Solver chart variable

Qualified Name Format - "Participant Internal Name":"Variable Name"
Qualfied Name Example- "Solution 1:Continuity Convergence"
Display Name Example- "Fluid Flow (FLUENT):Continuity Convergence"

Return    A dictionary of fully qualified chart variable names and display names
  Please see summary documentation of this (GetChartVariableNames) query on details of format and example of fully qualified name.
    Type    Dictionary<string, string>

GetConvergenceChart

Returns the convergence chart of a given name in a container.

Return     The convergence chart that matches the specified name.
    Type     DataReference

Required Arguments

Name    The name or display name of the convergence chart.
    Type     string

GetConvergenceCharts

Returns the collection of convergence charts in a container. If no convergence charts are in the container, the collection is empty.

Return     Collection of the convergence charts in the container.
    Type     DataReferenceSet

GetSolutionComponentProperties

Returns the solution component properties for a system coupling solution container.

Return     Data reference to the properties objects.
    Type     DataReference

GetSolutionInformation

Returns the solution information of a given name in a container.

Return     The solution information that matches the specified name.
    Type     DataReference

Required Arguments

Name    The name or display name of the solution information.
    Type     string

Data Entities

AxisContinuous

A chart axis that spans a set of continuous values. An example is an axis of an XY plot

Properties

AutomaticRange

The property to define whether or not automatic scaling should be applied to the axis, or whether the RangeMin and RangeMax should be used.

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
QuantityName

The name of the quantity associated with axis data.

E.g. Coupling Iteration, Coupling Step, Coupling Time

Type    string
Read Only    No
RangeMaximum

The maximum range of the values in this axis.

Type     double
Read Only    No
RangeMinimum

The minimum range of the values in this axis.

Type     double
Read Only    No
Scale

The scale of the axis. Scale can be defined as Linear/CommonLog (Log base 10)/Natural Log.

Type     Scale
Read Only    No
Title

The title of the axis.

Type     string
Read Only    No

ChartVariable

Entity representing a variable in Convergence Chart

Properties

Color

The line color of this chart variable in a plot.

This property is valid only for the chart displayed in Scene pane.

Type    Color
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
LineWidth

The width of the line drawn for this chart variable in pixels.

This property is valid only for the chart displayed in Scene pane.

Type    float
Read Only    No
QualifiedName

The variable quantity to display.

Type     string
Read Only    No
RefinementLevel

Refinement level for the data to be plotted.

Type     string
Read Only    No
SymbolSize

The size of a symbol in pixels when a symbol is drawn for this variable. The rendered symbol size may be slightly smaller or larger than expected if symbol does not correctly fit into the specified number of pixels.

This property is valid only for the chart displayed in Scene pane.

Type    uint
Read Only    No

Methods

Delete

Deletes a specified chart variable.

ConvergenceChart

Entity to store a convergence chart information.

Properties

AxisX

Associated X Axis

Type     DataReference
Read Only    No
AxisY

Associated Y Axis

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

Collection of variables to be plotted.

Type     DataReferenceSet
Read Only    No
XAxis

X Axis Quantity Name

Type     string
Read Only    No

Methods

CreateVariable

Creates a chart variable based on specified quailified name and adds it to the specified convergence chart.

During System Coupling Solution cell Update or after Solution cell Update, user can create convergence chart and add chart variables. A chart variable is based on specified fully qualified name. GetChartVariableNames query returns a dictionary of fully qualified chart variable names and display names. This can be used to create charts.

Data transfer chart variable format

Qualified Name Format - "Target Participant Internal Name":"Data Transfer Internal Name":"Variable Name": "Operator Name"
Qualfied Name Example- "Solution 1:Data Transfer 1:Change:Maximum"
Display Name Example- "Fluid Flow (FLUENT):Data Transfer 1:Change:Maximum"

Solver chart variable format

Qualified Name Format - "Participant Internal Name":"Variable Name"
Qualfied Name Example- "Solution 1:Continuity Convergence"
Display Name Example- "Fluid Flow (FLUENT):Continuity Convergence"

Return    The new created chart variable.
    Type    DataReference

Required Arguments

QualifiedName    The fully qualified name for this chart variable.
  Please see summary documentation of this (CreateVariable) data entity method on details of format and example of fully qualified name.
    Type    string

Optional Arguments

DisplayName    The display name for this chart variable.
    Type    string
Example

The following example demonstrates creation of chart variables. It is assumed that user has setup partcipants (e.g. Transient Structural and Fluid Flow(Fluent) and System Coupling system, and also solved coupled analysis. 

    # Get System Couplng Solution
    system1 = GetSystem(Name="SC")
    solution1 = system1.GetContainer(ComponentName="Solution")
    # Create Convergence Chart 
    ConvergenceChart1 = solution1.CreateConvergenceChart(Name="Chart") 
    # Create a Data Transfer chart variable 
    ChartVariable1 = ConvergenceChart1.CreateVariable(QualifiedName="Solution 1:Data Transfer 1:Change:Maximum",DisplayName="Fluid Flow (FLUENT):Data Transfer 1:Change:Maximum")
    # Create a solver chart variable 
    ChartVariable2 = ConvergenceChart1.CreateVariable(QualifiedName="Solution 1:Continuity Convergence",DisplayName="Fluid Flow (FLUENT):Continuity Convergence")

Delete

Delete's a specified convergence chart.

GetAxis

Returns the axis for a specified convergence chart

Return     The axis
    Type     DataReference

Required Arguments

Name    Name of the Axis
    Type     string
GetChartVariable

Returns the chart variable of a given name from a convergence chart

Return     The chart variable that matches the specified name.
    Type     DataReference

Required Arguments

QualifiedName    The qualified name of the chart variable.
    Type     string
GetChartVariables

Returns the collection of chart variables for a given convergence chart

Return     A collection of the variables in the chart.
    Type     DataReferenceSet

SolutionComponentProperties

The entity to store additional command line options which are passed to the coupling service on update.

Properties

CommandLineOptions

Additional command line options which are passed to the coupling service on update.

Type     string
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
UpdateOption

Solution Process Update Option

Type     SolutionUpdateOption
Read Only    No

SolutionInformation

Entity to store the solution information provided by the coupled participants.

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
FilePath

The path of the solution information file.

Type     string
Read Only    No

Methods

Delete

Deletes a specified solution information entity.