Mechanical Solution
Mechanical Solution
This container holds Solution data for an instance of Ansys Mechanical.
Methods
Edit
Opens the Mechanical editor and attaches geometry.
Optional Arguments
- Hidden Specify if Mechanical will open in hidden mode. The default value is false.
- Type bool
- Default Value False
- Interactive Specify if Mechanical will open in interactive mode. The default value is true.
- Type bool
- Default Value True
- StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.
- Type bool
- Default Value False
- Example
To edit the solution component with default optional parameter values.
solution.Edit()Or by specifying optional parameter values:
solution.Edit(Interactive=True)
Exit
Exit the Mechanical editor
Optional Arguments
- SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting
- Type bool
- Default Value True
Export
Exports the results(*.db, *.rth, *.rmg, and *.rst) files to given DirectoryPath.
Required Arguments
- DirectoryPath Directory path to export the result files to.
- Type string
GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and Scripting
GetExpertProperties
This query is used to obtain the ExpertProperties object for Journaling and Scripting
GetMechanicalSystemType
Query to return the reference to the container's MechanicalSystemType data entity.
-
ReturnA reference to the requested MechanicalSystemType data entity. - Type DataReference
GetModalUpdateOptionsForCdbTransfer
Query to return the data reference to the modal options for solution to model
-
ReturnA reference to the requested data entity. - Type DataReference
Required Arguments
- Name The entity of interest.
- Type string
GetPhysicsType
Query to return the reference to the container's MechanicalSystemType data entity.
-
ReturnA reference to the requested MechanicalSystemType data entity. - Type DataReference
GetRBDUpdateOptionsForMechdbTransfer
Query to return the data reference to the static options for solution to model
-
ReturnA reference to the requested data entity. - Type DataReference
Required Arguments
- Name The entity of interest.
- Type string
GetSolutionSettings
Returns a DataReference to the Solution Settings object for this container
-
ReturnThe Data Entity containing settings for this component. - Type DataReference
GetStaticUpdateOptionsForCdbTransfer
Query to return the data reference to the static options for solution to model
-
ReturnA reference to the requested data entity. - Type DataReference
Required Arguments
- Name The entity of interest.
- Type string
SendCommand
Executes a JScript or python command in the Mechanical editor.
If the Mechanical editor is not open, then the editor's GUI will not be available, causing some commands to fail. In this case, consider calling the container's Edit method to open the editor before using SendCommand.
Furthermore, if the Mechanical editor is not open, SendCommand will start the editor without the GUI, issue the specified command, and then close the editor. For multiple SendCommands, this may degrade performance.
Required Arguments
- Command Command argument containing the command.
- Type string
Optional Arguments
- Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Mechanical editor:
model.SendCommand(Command="WBScript.Out(\"My Text\",true);" )To run a JScript file already saved to disk using Run Macro from Mechanical:
setup.SendCommand(Command="WB.AppletList.Applet(\"DSApplet\").App.Script.doToolsRunMacro(\"C:\\\\macro.js\")")
Data Entities
ExtendedComponentSettingsForRsmDpUpdate
Extended Component settings when solved as part of design point update via RSM Currently used for Addins with solvers that would like to take advantage of SMP
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
SharedMemoryParallel
A boolean flag indicating whether or not to restrict the solver to using SMP, instead of distributed parallel
- Type bool
- Read Only No
ModalUpdateOptionsForCdbTransfer
ModalUpdateOptionsForCdbTransfer
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
ProcessElementComponents
Should we process the element components for the system
- Type bool
- Read Only No
RBDUpdateOptionsForMechdbTransfer
RBDUpdateOptionsForMechdbTransfer
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
ProcessElementComponents
Should we process the element components for the system
- Type bool
- Read Only No
SimulationSolutionSettings
Mechanical specific simulation solution settings entity used for Journaling and Scripting. Not based on the common Infrastructure.Rsm.Queries entity.
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
SimulationSolutionSpeosObj
DataTransfer provider that holds the file reference to a obj file.
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
TransferDataObject
The data transfer object provided by this provider
- Type DataReference
- Read Only No
SimulationSolutionToSpaceClaimObj
DataTransfer provider that holds the DataTransfer Objects from Simulation Solution to SpaceClaim.
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
StaticUpdateOptionsForCdbTransfer
StaticUpdateOptionsForCdbTransfer
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
ProcessElementComponents
Should we process the element components for the system
- Type bool
- Read Only No