Mechanical APDL

Mechanical APDL
This container holds data for a Mechanical APDL analysis.

Methods

AddFile

Copies the specified file to the working directory of the Mechanical APDL editor and registers the file with the Workbench project.

AddInputFile

Specifies an input file containing APDL commands for the Mechanical APDL editor for execution when the editor opens. Copies the file to the application working directory and registers it with the Workbench project.

Edit

Opens the Mechanical APDL editor to allow modification of Analysis data.

Exit

Exits the Mechanical APDL editor.

GetAnalysisSettings

Query to return the reference to the container's AnalysisSettings data entity.

GetComponentSettingsForRsmDpUpdate

This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and Scripting

GetMapdlInputFile

Query to return the reference to the container's MapdlSetup data entity.

GetMapdlSetup

Query to return the reference to the container's MapdlSetup data entity.

GetSolutionSettings

This query is used to obtain the solution settings object for Journaling and Scripting

SendCommand

Sends commands to the Mechanical APDL editor.

SwitchToBackgroundMode

Switch the Update in progress into background mode. This will enable operations that are not allowed during an Update in foreground mode (e.g. Project Save).

This command is not normally useful in a script. Journals may record the invocation of this command after an Update invoke, as the result of GUI activity while the Update is in progress. However, replay of these journals will always wait for the Update invoke to complete before invoking the next command, rendering this step ineffectual.

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
LimitOnNumberOfCores

No details are provided for this entry.

Type     int
Read Only    No
SerialOnly

No details are provided for this entry.

Type     bool
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
UseLimitOnNumberOfCores

No details are provided for this entry.

Type     bool
Read Only    No

HiddenPollingComponentSolveSettings

This class contains a derived version of solve settings where polling is disabled

Properties

ConfiguredQueue

A configured queue used for new RSM architecture

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
EnablePolling

whether enable polling during remote solve

Type     bool
Read Only    No
ExecutionMode

execution mode

Type     string
Read Only    No
NumberOfProcesses

number of processes for parallel solve

Type     int
Read Only    No
PollingInterval

polling internal during remote solve

Type     Quantity
Read Only    No
RsmJobName

RSM job name

Type     string
Read Only    No
RsmQueueDetails

Configured queue details

Type     RsmQueueDetails
Read Only    No
UpdateOption

Update mode

Type     JobRunMode
Read Only    No

MapdlInputFile

Represents an input file for the Mechanical APDL editor.

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

Methods

Delete

Deletes an input or reference file from the Mechanical APDL editor.

PublishMapdlParameter

Publishes a MAPDL variable located in an input file as a parameter.

SwitchInputOrder

Switches the order of two input files for the Mechanical APDL editor.

UnpublishMapdlParameter

a MAPDL variable located in an input file as a parameter.

MapdlReferenceFile

Represents a reference file for the Mechanical APDL editor.

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

Methods

Delete

Deletes an input or reference file from the Mechanical APDL editor.

MapdlSetup

Represents the settings used to launch the Mechanical APDL editor.

Properties

CommandLineOptions

Additional command line options for the Mechanical APDL editor.

Type     string
Read Only    No
CustomExecutablePath

Calls a custom ANSYS executable.

Type     string
Read Only    No
DatabaseMemory

Defines the portion of workspace (memory) to be used for the database. The default is 512 MB for 64-bit machines, 256 MB for 32-bit machines.

Type     int
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
Distributed

Enables Distributed ANSYS.

Type     bool
Read Only    No
DownloadDistributedFiles

Indicates whether or not to download files from slave node scratches during distributed solves

Type     bool
Read Only    No
GPUAccelerator

Specifies the type of GPU Accelerators. By default this is set to none meaning no GPU acceleration is used.

Type     GPUAccelerator
Read Only    No
Graphics

Specifies the type of graphics device. This option applies only to interactive mode. For UNIX/Linux systems, graphics device choices are X11, X11C, or 3D. For Windows systems, graphics device options are WIN32 or WIN32C, or 3D.

Type     string
Read Only    No
JobName

Specifies the initial jobname, a name assigned to all files generated by the program for a specific model. If you omit the -j option, the jobname is assumed to be file.

Type     string
Read Only    No
License

Defines which ANSYS product will run during the session (ANSYS Multiphysics, ANSYS Structural, etc.).

Type     string
Read Only    No
MachineList

Specifies the machines on which to run a Distributed ANSYS analysis.

Type     string
Read Only    No
MPIType

Defines which type of MPI the solver should use.

Type     MPIType
Read Only    No
NumberOfGpusPerMachine

Specifies the number of accelerators to use when running with GPU Acceleration.

Type     int
Read Only    No
Processors

Specifies the number of processors to use when running Distributed ANSYS or Shared-memory ANSYS.

Type     int
Read Only    No
ReadStartAns

Specifies whether the program reads the start121.ans file at start-up.

Type     bool
Read Only    No
WorkspaceMemory

Specifies the total size of the workspace (memory) in megabytes. If you omit the -m option, the default is 1 GB (1024 MB) for 64-bit machines, 512 MB for 32-bit machines.

Type     int
Read Only    No