System Coupling Solution
This container holds Solution data for an instance of System Coupling.
Creates a new convergence chart.
Return
The data reference to the new convergence chart.
Required Arguments
Creates a new solution information entity and adds it to the specified system coupling solution container.
Return
The new solution information that was created.
Required Arguments
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.
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 Returns the convergence chart of a given name in a container.
Return
The convergence chart that matches the specified name.
Required Arguments
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.
Returns the solution component properties for a system coupling solution container.
Return
Data reference to the properties objects.
Returns the solution information of a given name in a container.
Return
The solution information that matches the specified name.
Required Arguments
A chart axis that spans a set of continuous values. An example is an axis of an XY plot
The property to define whether or not automatic scaling should be applied to the axis, or whether the RangeMin and RangeMax should be used.
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 name of the quantity associated with axis data.
E.g. Coupling Iteration, Coupling Step, Coupling Time
The scale of the axis. Scale can be defined as Linear/CommonLog (Log base 10)/Natural Log.
Entity representing a variable in Convergence Chart
The line color of this chart variable in a plot.
This property is valid only for the chart displayed in Scene View.
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 width of the line drawn for this chart variable in pixels.
This property is valid only for the chart displayed in Scene View.
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 View.
Entity to store a convergence chart 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.
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.
Required Arguments
Optional Arguments
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")
Returns the axis for a specified convergence chart
Return
The axis
Required Arguments
Returns the chart variable of a given name from a convergence chart
Return
The chart variable that matches the specified name.
Required Arguments
Returns the collection of chart variables for a given convergence chart
Return
A collection of the variables in the chart.
The entity to store additional command line options which are passed to the coupling service on update.
Additional command line options which are passed to the coupling service on update.
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.
Entity to store the solution information provided by the coupled participants.
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.