Project
This container holds the Systems, Components and Templates in the project.
Data entity representing a component of a system in the schematic.
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.
Delete the heavyweight data (e.g. solution and/or results) of this component to reduce the size of the project.
Removes all sharing affecting the specified component.
Optional Arguments
Deletes the transfer connection between two components.
Required Arguments
This method is available only in AIM. For the given Physics Definition schematic component, return it's valid Mechanical Physics Definition output
Return
The AIMMechanicalPhysicsDefinitionOutput object associated with the project schematic component.
This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentMesh output
Return
The AIMFluentMeshOutput object associated with the project schematic component.
This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentMesh output
Return
The AIMFluentPartMeshOutputProvider object associated with the project schematic component.
This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentPhysicsDefinition output for Fluent
Return
The AIMFluentPhysicsDefinitionOutput object associated with the project schematic component.
This method is available only in AIM. For the given Meshing schematic component, return it's valid GeometryMesh output
Return
The AIMGeometryMeshOutput object associated with the project schematic component.
This method is available only in AIM. For the given project schematic component, return it's anchor object.
Return
The anchor object associated with the project schematic component.
For the given Meshing schematic component, check whether it supports Part Mesh
Return
Returns true if it supports Part Mesh otherwise false
For the given Meshing schematic component, check whether it supports volume Fill Mesh
Return
Returns true if it supports Volume Fill Mesh otherwise false
Refreshes the input data for a component by reading all changed data from upstream (source) components. Does not perform any calculations or updates based on the new data.
Deletes the component and all dependents from a system.
Required Arguments
Replaces a component in a system with a shared copy of a component from another system. The data sources of any downstream components are updated to include the new component.
Required Arguments
Optional Arguments
The following example illustrates a replace of a component with a shared copy of another system's component.
componentToShare = sys2.GetComponent("componentName")
componentToReplace = sys1.GetComponent("componentName")
componentToReplace.ReplaceWithShare(ComponentToShare=componentToShare)
Note that you do not need to specify the TargetSystem and SourceSystem. They are only retained for legacy compatibility.
Creates a data transfer connection between two components in the project.
Required Arguments
Create a data transfer connection between two existing components, specifying the type of data to be transferred. This is used in some situations where more than one type of data can be exchanged between two components.
See also component.TransferData(TargetComponent=...)
Required Arguments
Updates the component by refreshing the input from all upstream components and then performs a local calculation based on current data.
Optional Arguments
This entity provides information used in the creation of a new component in the project. A component template has no user modifiable properties and is typically only referenced when creating a new system that includes data connections.
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 component based on a given component template.
Required Arguments
Optional Arguments
The following example illustrates Component creation from a template.
system1 = CreateSystem(...)
template = GetComponentTemplate("MyTemplate")
template.CreateComponent(System=system1)
Optional properties allow you to modify component creation, including the establishment of upstream component connections.
system1 = CreateSystem(...)
upstreamComponent = ...
template = GetComponentTemplate("MyTemplate")
template.CreateComponent(Name="MyComponent", System=system1, UpsatreamComponent=[upstreamComponent], AllSystemProperties=None)
A project snippet template containing multiple systems and their links.
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 names of the systems to create, one for each entry in the SystemTemplates list.
Templates for the systems making up this snippet.
Design point update settings entity.
whether reserved licenses should be checked out when the remote job starts, as opposed to by the local session before submitting the jobs
retained design point update behavior
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 represents a hyperlink on UI that is used to open a License Reserved dialog.
Maximum number of jobs if job submission is "Specify Number of Jobs"
whether reserved licensing should apply to pre-RSM update
This data entity holds properties that control the appearance of the Project Schematic.
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.
A collection of components brought together to complete a specific type of analysis or data generation within a project.
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 new system containing a copy of all the data in this system.
Return
The reference to the created system.
Optional Arguments
The following example illustrates System duplication. No components are shared. The new, copied system will appear to the right of the existing system. Its name will be "MyNewSystme".
mySystem = CreateSystem(...)
mySystem2 = mySystem.Duplicate(ComponentsToShare=[],
Position="Right",
RelativeTo=mySystem,
Name="MyNewSystem")
Query to return the component reference for a given component base name in the system.
Return
Data Container Reference
Required Arguments
Query to return the container for a given component base name in the system.
Return
Data Container Reference
Required Arguments
A query to return the list of templates that can be used to replace the current system.
See also template.ReplaceSystem(System=...).
Return The list of System Template references that can be used to replace this system.
Moves an existing system in the schematic.
Required Arguments
Recreates new versions of any components that have been deleted from the system.
Refreshes the input data for all components in the system by reading changed data from upstream sources. Does not perform any calculations or updates based on the new data.
Updates all components in the system by refreshing the input from all upstream sources, and then performing local calculation based on current data.
Optional Arguments
A template that is used to create a system within the project.
The user-visible name for the type of systems created from this template.
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 system type, displayed in the User Interface in the header of the system block.
The system type abbreviation, used to create the system unique directory name and also serves as the system object's base name.
Creates a new system from a system template.
Return
The reference to the created system.
Optional Arguments
Two examples are presented. This first section gets the template for a "Fluid Flow (CFX)" system, and then creates an empty, stand-alone system in the default position.
template1 = GetTemplate(TemplateName="Fluid Flow", Solver="CFX")
system1 = template1.CreateSystem()
In the second part of the example, we create a Static Structural (ANSYS) system connected to the previous Fluid Flow system. The Geometry component from the Fluid Flow system (component1) is shared with the new Static Structural system. The Solution component from the Fluid Flow system (component2) transfers results data into the Setup component of the Static Structural system. The new system is created to the right of the existing system.
template2 = GetTemplate(TemplateName="Static Structural", Solver="ANSYS")
component1 = system1.GetComponent(Name="Geometry")
component2 = system1.GetComponent(Name="Solution")
componentTemplate1 = GetComponentTemplate(Name="SimulationSetupTemplate_StructuralStaticANSYS")
system2 = template2.CreateSystem(
CellsToShare=[component1],
DataTransferFrom=[{"FromComponent": component2,
"TransferName": "CFXTransferResultsTemplate",
"ToComponentTemplate": componentTemplate1}],
Position="Right",
RelativeTo=system1)
Replace an existing system with one based on the selected System Template.
There are a number of restrictions on the template that can be used to replace an existing system. See system.GetReplaceableTemplates() to determine the list of allowable templates.
Return The reference to the created system.
Required Arguments
Optional Arguments