Distribution Command Line Options
The user should include options specifying how the job should be distributed in the command line. These command line options will override options specified using the HPC and Analysis Options dialog box or obtained from the registry. See Running Ansys Electronics Desktop from a command line for more information on command line options.
For both scheduler batch jobs and interactive scheduler jobs, the -MachineList num=<num distributed tasks> format is the most common way to specify the number of tasks for the job. The other formats (-MachineList list=... or -MachineList file=...) allow the user to specify the number of tasks and cores to use on each host. These formats may be useful with clusters of heterogeneous machines, by allowing the user to specify different numbers of tasks or cores for different hosts. If either of the latter two formats is used, the user must ensure that the hosts and cores specified on the product command line are compatible with the hosts and cores allocated to the job.
Batchoptions for Interactive Scheduler Jobs
For interactive scheduler jobs, only a limited set of batchoptions are supported. These batchoptions include the DSO configuration options, the design-type-specific options, and the following additional design-type-specific options that are not currently listed in the user interface or command line help windows:
- CreateStartingMesh: Create the starting mesh only. Do not solve any other steps. Often used for multi-step jobs where the mesh creation is solved in a separate step using fewer resources than the rest of the analysis.
- NumCoresPerDistributedTask: Specifies the number of cores that are allocated to the job to use for each distributed task, used when running jobs under a scheduler. The scheduler communicates the number of cores allocated to the job on each host. This setting is used to determine how to allocate the cores to each task.
- SolveAdaptiveOnly: Solve adaptive passes only. Do not solve any other steps. Often used for multi-step jobs where the adaptive passes are solved in a separate step using fewer resources than the rest of the analysis.
- TotalNumOfCores: The total number of cores for the job. This option is only used for EKM (Engineering Knowledge Manager).
- ValidateOnly: Only validate the specified setup, design, or project. Do not analyze the specified setup, design or project.
Any other batchoptions will result in a warning message and will be ignored.
Example:
ansysedt -batchoptions " 'TempDirectory'='C:\\TEMP'
'HFSS/SelectedDSOConfiguration'='Local'
'Desktop/Settings/ProjectOptions/DoAutoSave'=1
'LargeScaleDSO/MaxFolderInMB'=100 "
Batchoptions
Batchoptions may be specified in the command line used to launch the product. Any valid batchoptions specified in the command line will override the associated registry settings. Batchoptions also override options specified using HPC and Analysis Options window or other dialog boxes used to specify options.
Setting MPI Version
When submitting a job using the Ansys Electromagnetics job submission GUI, the MPI Version may be specified using the batchoption with pathname DesignType/MPIVersion, where DesignType is the type of design to analyze (e.g. HFSS). It allows selection of which Intel MPI version to use, for both Windows and Linux. Valid values are "Default", "2018", and "2021".
For interactive solves, the MPI version may be specified with the batchoption in the command line used to launch the product, or as a design type option in the HPC and Analysis Options dialog box.