AnsysEMInstallGuide-Windows

Ansys Electromagnetics Suite 2022 R1
Windows Installation Guide
Release 2022 R1
ANSYS, Inc.
January 2022
Southpointe
2600 Ansys Drive ANSYS, Inc. and
Canonsburg, PA 15317 ANSYS Europe,
ansysinfo@ansys.com Ltd. are UL
registered ISO
https://www.ansys.com
9001:2015 com-
(T) 724-746-3304 panies.
(F) 724-514-9494
Ansys Electromagnetics Suite 2022 R1 Windows Installation Guide
Copyright and Trademark Information
© 1986-2022 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.
ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand,
product, service and feature names, logos and slogans are registered trademarks or trademarks
of ANSYS, Inc. or its subsidiaries located in the United States or other countries. ICEM CFD is a
trademark used by ANSYS, Inc. under license. All other brand, product, service and feature
names or trademarks are the property of their respective owners. FLEXlm and FLEXnet are
trademarks of Flexera Software LLC.
Disclaimer Notice
THIS Ansys SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE

SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC.,
ITS SUBSIDIARIES, OR LICENSORS. The software products and documentation are furnished
by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement that contains
provisions concerning non-disclosure, copying, length and nature of use, compliance with export-
ing laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The
software products and documentation may be used, disclosed, transferred, or copied only in
accordance with the terms and conditions of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
U.S. Government Rights
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license
agreement, the use, duplication, or disclosure by the United States Government is subject to
restrictions stated in the ANSYS, Inc. software license agreement and FAR 12.212 (for non-
DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for Ansys pro-
prietary software and third-party software. If you are unable to access the Legal Notice, please
contact ANSYS, Inc.
Ansys Electromagnetics Suite 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates.

Conventions Used in this Guide
Please take a moment to review how instructions and other useful information are presented in
this documentation.
l Procedures are presented as numbered lists. A single bullet indicates that the procedure
has only one step.
l Bold type is used for the following:
o Keyboard entries that should be typed in their entirety exactly as shown. For
example, “copy file1” means you must type the word copy, then type a space, and
then type file1.
o On-screen prompts and messages, names of options and text boxes, and menu
commands. Menu commands are often separated by greater than signs (>). For
example, “click HFSS > Excitations > Assign > Wave Port.”
o Labeled keys on the computer keyboard. For example, “Press Enter” means to
press the key labeled Enter.
l Italic type is used for the following:
o Emphasis.
o The titles of publications.
o Keyboard entries when a name or a variable must be typed in place of the words in
italics. For example, “copy filename” means you must type the word copy, then
type a space, and then type the name of the file.
l The plus sign (+) is used between keyboard keys to indicate that you should press the
keys at the same time. For example, “Press Shift+F1” means to press the Shift key and,
while holding it down, press the F1 key also. You should always depress the modifier key
or keys first (for example, Shift, Ctrl, Alt, or Ctrl+Shift), continue to hold it/them down, and
then press the last key in the instruction.
Accessing Commands: Ribbons, menu bars, and shortcut menus are three methods that can
be used to see what commands are available in the application.
l The Ribbon occupies the rectangular area at the top of the application window and con-
tains multiple tabs. Each tab has relevant commands that are organized, grouped, and
labeled. An example of a typical user interaction is as follows:
"Click Simulation > HPC Options"

This instruction means that you should click the HPC Options command on the Sim-
ulation ribbon tab. An image of the command icon, or a partial view of the ribbon, is often
included with the instruction.
l The menu bar (located above the ribbon) is a group of the main commands of an applic-
ation arranged by category such File, Edit, View, Project, etc. An example of a typical user
interaction is as follows:
"On the File menu, click the Open Examples command" means you can click the File
menu and then click Open Examples to launch the dialog box.
l Another alternative is to use the shortcut menu that appears when you click the right-
mouse button. An example of a typical user interaction is as follows:
“Right-click and select Assign Excitation> Wave Port” means when you click the right-
mouse button with an object face selected, you can execute the excitation commands
from the shortcut menu (and the corresponding sub-menus).
Getting Help: Ansys Technical Support
For information about Ansys Technical Support, go to the Ansys corporate Support website,
http://www.ansys.com/Support. You can also contact your Ansys account manager in order to
obtain this information.
All Ansys software files are ASCII text and can be sent conveniently by e-mail. When reporting
difficulties, it is extremely helpful to include very specific information about what steps were
taken or what stages the simulation reached, including software files as applicable. This allows
more rapid and effective debugging.
Help Menu
To access help from the Help menu, click Help and select from the menu:
l [product name] Help - opens the contents of the help. This help includes the help for the
product and its Getting Started Guides.
l [product name] Scripting Help - opens the contents of the Scripting Guide.
l [product name] Getting Started Guides - opens a topic that contains links to Getting
Started Guides in the help system.
Context-Sensitive Help
To access help from the user interface, press F1. The help specific to the active product (design
type) opens.
You can press F1 while the cursor is pointing at a menu command or while a particular dialog
box or dialog box tab is open. In this case, the help page associated with the command or open
dialog box is displayed automatically.

Table of Contents
Table of Contents Contents-1
1 - Getting Started 1-1
Installation Prerequisites 1-1
Ansys Electromagnetics Suite Software 1-1
License File 1-1
License Server 1-1
TCP/IP 1-2
OpenGL 1-2
Firewall Exceptions 1-3
Windows Requirements 1-3
Additional Resources 1-3
2 - Installing Ansys Electromagnetics Suite Software 2-1
Obtaining a License File 2-1
Installing the Software 2-1
Integrating Ansys Electromagnetics Products with Ansys Workbench 2-6
Integration with Ansys Workbench during Ansys Electromagnetics Product Install-

ation 2-6
Integration with Ansys after Ansys Electromagnetics Product Installation 2-7
3 - High Performance Computing 3-1
Distributing Analysis to Multiple Hosts 3-1
Distributing Analysis Across Platforms 3-2
Options for Distributed Analysis 3-2
Remote Simulation Manager (RSM) 3-3
When do you need RSM? 3-4
Installing RSM 3-4
Registering Ansys Electromagnetics Product Engines for use with RSM 3-6
Contents-1

Changing the AnsoftRSMService Listening Port 3-7
AnsoftRSMService Configuration 3-7
Ansys Electromagnetics Desktop Configuration 3-8
Supported Job Schedulers 3-10
Custom Scheduler Integration 3-10
Running HPC Test Jobs on a Cluster 3-11
Non-distributed job 3-11
Non-MPI job distributed to multiple hosts 3-12
MPI job distributed to multiple hosts 3-13
Submitting and Running the Tests 3-13
Submitting and running a non-distributed job 3-15
Submitting and running a non-MPI job distributed to multiple hosts 3-16
Submitting and running an MPI job distributed to multiple hosts 3-17
Scheduler Specific Configuration and Testing 3-20
Windows HPC 3-20
Job Submission Host Configuration 3-20
Cluster Configuration Guidelines 3-20
Running Test Jobs 3-20
Non-distributed job 3-21
IBM Platform LSF 3-22
Cluster Configuration Guidelines 3-22
Running Test Jobs 3-22
Non distributed job 3-23
4 - Updating Software and Licenses 4-1
Contents-2

Using Maintenance Mode 4-1
Updating a Software License 4-2
Specifying License Server Machines via the ansyslmd.ini file or Environment Vari-
ables. 4-3
5 - Message Passing Interface (MPI) Installation 5-1
Intel MPI 5-1
Microsoft MPI 5-1
Windows 5-1
Install Intel MPI 5-2
Install Microsoft MPI 5-4
MS-MPI Launch Service 5-4
General Notes 5-5
Scenario 1 5-5
Scenario 2 5-5
Scenario 3 5-5
Windows HPC Scheduler 5-6
Network Installation 5-7
Troubleshooting Section 5-8
A - Silent Installation A-1
Running the Silent Installation A-1
Performing a Silent Uninstall A-3
B - License hostid B-1
Network Interface Card B-1
Windows B-1
Linux B-2
Hardware Key B-2
Installing a Hardware Key on a USB Port B-2
C - System Coupling with Maxwell C-1
Contents-3

Enabling System Coupling with Maxwell C-1
Contents-4

1 - Getting Started
Installation Prerequisites
Before installing Ansys Electromagnetics Suite software, you need the following:
l The Ansys Electromagnetics product CD or product download (see "Additional Resources
" on page 1-3 for download information).
l A license file based on the ansoftd vendor daemon.
l The Ansys License Manager software download.
l A computer with TCP/IP installed, for counted evaluation and purchased licenses.
l A computer that meets the minimum or recommended system requirements, which
depends on the specific Ansys Electromagnetics products you plan to run.
Ansys Electromagnetics Suite Software

The Ansys Electromagnetics product or equivalent download contains:
l The Ansys Electromagnetics Suite software and project examples.
l The help system and PDFs.
License File
Most Ansys Electromagnetics products require a license, which is sent as an e-mail attachment.
After you receive a license file, save it to a temporary location.
The license file requires a license hostid, which is a hardware device used to validate the license.
A list of supported hostids, and a general explanation of hostids, is available in "License hostid "
on page B-1
If you do not have a license file for the Ansys Electromagnetics software you are about to install,
please contact your Ansys sales representative.
License Server
Once you have purchased the software, you must designate a machine on your network to act
as a license server. The Ansys License Manager must be installed in one of the following two loc-
ations:
l On the computer where the software will be installed.
l On another machine accessible over the network.
Getting Started 1-1

Note:
You can install the Ansys License Manager before or after you install the Ansys Elec-
tromagnetics software.
See the Ansys License Manager instructions available as part of the Ansys License Manager
download.
TCP/IP
Transmission Control Protocol/Internet Protocol (TCP/IP) is required for any Ansys Elec-
tromagnetics software—even for a single computer in stand-alone mode.
l TCP/IP must be installed on the machine that is running Ansys License Manager (the
server) and on each machine that obtains licenses from that server.
l By default, TCP/IP is usually already installed on a computer running a Windows platform.
l TCP/IP is usually bound to a network card. If a network card is already installed and set up
for TCP/IP, no additional action is needed during installation.
l If a network card is not installed, then you can satisfy the TCP/IP requirement by installing
the Microsoft Loopback Adapter (MLA). The MLA is a software module that emulates a
network card. For more details, see the appropriate help topics in Microsoft Windows (on
the Windows taskbar, click Start>Help or Start>Help and Support, depending on the
operating system).
OpenGL
All Ansys Electromagnetics software (excluding Ansys License Manager) requires that the
OpenGL libraries be accessible from the machine running Ansys Electromagnetics software.
Most graphics card drivers automatically come with OpenGL software for Windows.
Graphics Card and Performance
In the case of laptops that have both Intel and NVidia cards, the installation removes existing pro-
files for AEDT and SIwave and adds new profiles that specify the use of NVIDIA graphics card
for both applications. To verify that the NVidia cards are the defaults, go to the NVIDIA Control
Panel>3D Settings>Manage 3D Settings>Program Settings . Check that the settings for
Ansys Electronics Desktop and Ansys SIwave both specify NVIDIA as the preferred graphics
processor.
Getting Started 1-2

Note:
For some graphics cards, there may be slowdown for field animations, rotating and
zooming for complex models, and selection display. This includes
NVidia Quadro 2000M
NVidia Quadro FX 3800M
NVidia Quadro 4000
NVidia Quadro FX 1800
The problem does not show on the following graphic adapters:

ATI FirePro V5800
Quadro NVS 295
Quadro NVS 290
To correct the problem, set the NVIDIA Control Panel>3D Settings>Manage 3D Set-
tings>Global Settings>Global Presets: Workstation App - Dynamic Streaming
Firewall Exceptions
Firewall exceptions are needed for the COM engines and Ansys Electromagnetics products if
solving remotely (something that does not necessarily require RSM). Exceptions are also
required for RSM as well if it is installed. This comes up most frequently with the Windows fire-
wall.
Windows Requirements
For supported platforms and system requirements, go to:
http://www.ansys.com/Solutions/Solutions-by-Role/IT-Professionals/Platform-Support
Additional Resources
General: The Ansys web site: http://www.ansys.com.
Downloads: Software downloads (including Ansys License Manager) and installation-
related documentation are available at the Ansys customer portal,
http://www.ansys.com/customerportal
Online Tech- Available through the Ansys customer portal:
nical Support: http://www.ansys.com/customerportal
Under Online Support, choose Ansys Electromagnetics Customer
Support.
The Ansys Electromagnetics technical support site provides access to fre-
quently asked questions, application notes, presentations, and example
Getting Started 1-3

scripts.
Product Docu- The help system is accessible from the Help menu. Information about the
mentation: release can be found in the What's New documents. In addition, PDF ver-
sions of the help system are accessible from within the help system.
Getting Started 1-4

2 - Installing Ansys Electromagnetics

Suite Software
To install Ansys Electromagnetics Suite software on a Windows operating system:
l Obtain a license file for the software you are installing. See "License File " on page 1-1
for more information.
l Install the Ansys Electromagnetics Suite software.
l Set up a license server if prompted to do so.
Obtaining a License File

Ansys Electromagnetics requires a license for all software. If you do not have a license file for the
Ansys Electromagnetics software you are about to install, contact your Ansys sales rep-
resentative. See "License File " on page 1-1 for more information.
Installing the Software

To install Ansys Electromagnetics software:
1. Log in as Administrator, or log on to an account with administrator privileges.

2. If you downloaded the Ansys Electromagnetics product ("Additional Resources " on
page 1-3 ), unzip the download, and run the autorun.exe file in the newly created directory.
The Installation Shell appears.
3. Click Install Electromagnetics Suite.
The initial screen appears.
4. Click Next.
The License Agreement screen appears.
5. Read the license agreement carefully. Click Yes if you accept the terms of the agreement.
6. Click Next.
The Choose Destination Location screen appears.
7. Under Destination Folder, do one of the following to accept the default path or specify a
new one:
l Accept the default installation directory listed under Destination Folder.
l To select a different directory, click Browse. The Choose Folder window appears.
Select a directory, and click OK. If you have other Ansys Electromagnetics software,
Ansys recommends that you install new software in the same directory.
l To create a new directory, click Browse. The Choose Folder window appears. Enter
the new name in the Path field, and click OK.
8. Click Next.
Installing Ansys Electromagnetics Suite Software 2-1

Depending on the software and version being installed, you may see one or both of the fol-
lowing screens before the Select Program Folder screen: the Choose Default Temp
Directory Location screen and/or the Choose Library Option screen.
9. If the Default Temporary Directory Location screen appears, select a default location
for all simulations (including local) to use as a temporary work space.
l If desired, change the temporary folder assignment. You can edit the field directly or
use the Browse button to display file browser to let you navigate the folders on your
machine and network.
l If desired, check the option to add read/write permissions for Everyone. If the install-
ation will be used for remote simulation by multiple users, all users must have per-
missions on the temporary folder.
10. If the Choose Library Option screen appears, do one of the following to specify the loc-
ation of Ansys Electromagnetics libraries:
Note:
Ansys Electromagnetics libraries are large databases of electronic components,
developed by Ansys and various manufacturers.
l Click This local installation to copy and install the default Ansys Electromagnetics
component libraries, and then click Next.
l Click The following common location to use libraries that are already installed (loc-
ally or on the network). Click Browse, select the appropriate path, and click OK. Click
Next.
11. Click Next.
The Integration with Ansys screen may appear.
If Ansys is installed on the machine, you have the choice of integrating "Integrating Ansys
Electromagnetics Products with Ansys Workbench" on page 2-6 or "Integration with
Ansys after Ansys Electromagnetics Product Installation" on page 2-7 . If Ansys is not
installed, the choice of integrating now is disabled.
12. Click Next.
The License Information screen appears.

For additional information about the three license options, click Help me decide which of
the following options to choose. This displays a browser page with additional explan-
ations.
Note:
You can review the current license configuration by clicking View current license con-
figuration.

13. Select one of the following three license options:

Note:
If you want to change the license server after installation, modify the ansyslmd.ini
file in AnsysEM/Shared Files/Licensing. See Updating a Software License.
14. On the Select Program Folder screen, do one of the following to specify a name for the
program folder:
l Accept the default name displayed in the Program Folder box.
l Select an item from the Existing Folders list.
l Type a new name for the folder in the Program Folder box.
Note:
The program folder, which appears on the Windows Start menu, is a grouping
of related software that includes executable files and other components. The
default programs folder is Ansys EM (Start>Ansys EM).
15. Click Next.

The Review settings before copying files screen appears.
16. In the Review settings before copying files screen, review the information displayed
under Current Settings, and then do one of the following:
l If the settings are correct, click Next to start copying files.
l If the settings are incorrect, click Back as many times as necessary, and change your
selections. Verify each screen before clicking Next to go to the next screen. When all
information is correct, return to the Review settings before copying files screen, and
click Next.
The Setup Status screen appears, displaying a progress bar, and installation begins.
You can click Cancel at any time to exit the installation.
Note:
If you receive a message about read-only files, you typically want to overwrite
them with the newer versions.
17. Once the files have all been copied, one of the following messages may appear:
l If you identified as the license server the same machine where you installed the Ansys
Electromagnetics software, then a message appears that informs you that you must
install the Ansys License Manager on this machine. Click OK.

l If you identified as the license server a machine other than where you installed the
Ansys Electromagnetics software, then a message appears that identifies that machine
as the license server and informs you that you must install the Ansys License Manager
on that machine. Click OK.
18. When the installation is complete, the InstallShield Wizard Complete window appears.
You will see one of two check box options:
l If RSM is not installed, you will see a check box to launch the RSM installation and,
once the installation is complete, register this Ansys Electromagnetics product with
RSM. If you select this option and click Finish, the product installation ends and the
RSM installation is automatically started.
l If RSM is installed, you will see a check box to register this Ansys Electromagnetics
product with RSM.
See Installing RSM for more details.
19. Click Finish.
The initial setup Installation Shell reappears.
Integrating Ansys Electromagnetics Products with Ansys

Workbench
You can integrate Ansys Electromagnetics products with Ansys Workbench in one of two ways:
l "Integration with Ansys Workbench during Ansys Electromagnetics Product Install-
ation" below, or
l "Integration with Ansys after Ansys Electromagnetics Product Installation" on the facing
page
Integration with Ansys Workbench during Ansys Electromagnetics Product

Installation
You can choose to integrate Ansys Electromagnetics products with Ansys Workbench during
installation as follows:
1. If you have not already installed Ansys, do so before proceeding. Refer to the Installation
Guide for Ansys.
2. Proceed through the Ansys Electromagnetic Suite installation dialogs.
3. When the Integration with Ansys 2022 R1 dialog box displays, select the Yes radio but-
ton to have the installer automatically integrate the Ansys Electromagnetics product with

Ansys.
Note:
If you choose not to integrate the product with Ansys during installation, you can per-
form this step "Integration with Ansys after Ansys Electromagnetics Product Install-
ation" below
4. Complete the product installation and exit the installer.
Integration with Ansys after Ansys Electromagnetics Product Installation

If you want to integrate Ansys Electromagnetics Suite with Ansys after installation, do the fol-
lowing:
1. From the Start menu, select Ansys EM Suite 2022 R1 > Modify Integration with Ansys
2022 R1.

2. In the Integration with Ansys 2022 R1 dialog box, ensure that the Yes radio button is
selected.

Then click OK to complete the integration process. Then OK the information dialog box.
You can confirm that Ansys is “aware” of the Ansys Electromagnetics integrated applic-
ations via the Ansys Workbench Options dialog (Tools > Options), which shows the
paths to the integrated Ansys Electromagnetics applications.


3 - High Performance Computing

Ansys Electromagnetics products have a variety of ways to use multiple threads, multiple cores
or multiple hosts to improve productivity. These additional computational resources may be used
to solve larger problems, to solve a given problem faster, or to improve the quality of a solution
(using more stringent convergence criteria, for example) in the same amount of time. This sec-
tion describes the configuration and requirements for using additional resources by Ansys Elec-
tromagnetics products.
To make effective use of the resources allocated to the analysis, the job settings must match the
job requirements. In addition, the cluster configuration and the resources must be allocated to
the job in a way that the products are able to make effective use of the resources.
Note:
For additional information about high performance computing not in this guide, see the
Ansys Electromagnetics HPC Administrator's Guide in the help system.
Distributing Analysis to Multiple Hosts

If an analysis is distributed to multiple hosts, then the Ansys Electromagnetics Suite must gen-
erally be installed at the same path on all hosts used for the analysis. This may be a shared net-
work installation that is accessible using the same path on all analysis hosts (such as
\\servername\sharename\AnsysEM\v221\Linux64). If this approach is used, then there must not
be any local installations of Ansys Electromagnetics Suite on any of the hosts with the same
major and minor version numbers. Installing a service pack does not affect the major and minor
version numbers. Alternatively, a separate, local installation on each host may also be used. In
the latter case, the pathname of the installation directory (such as C:\Program Files\An-
sysEM\v221) must be the same on all hosts, and all installations must include the same service
pack or packs.
A distributed analysis that does not use MPI distribution does not need to meet the above require-
ment. Because MPI is used for all distribution types except for variations, MPI will not be used
only for the following cases:
• If the design type does not support the Auto option and does not allow distribution types
other than distribution of variations, then MPI will not be used for distribution. This currently
includes the Circuit Design, Circuit Netlist, Emit, RMxprt, Maxwell Circuit, Twin Builder, and
Mechanical design types.
• If the Auto option is not selected, and no distribution type other than Variations is enabled,
then MPI will not be used.
High Performance Computing 3-1

For these cases, the Ansys Electromagnetics Suite may be installed at different locations on dif-
ferent hosts. These locations must be registered with the RSM Service running on each host.
Distributing Analysis Across Platforms

In general, all analysis hosts should be on the same platform. That is, either all analysis hosts
should be Windows hosts or all analysis hosts should be Linux hosts. One additional con-
figuration is supported, with limitations: the Ansys Electronics Desktop may run on a Windows
host, with all of the solvers running on Windows hosts. This configuration is supported except for
cases in which 1) auto mode is enabled and 2) variations are distributed. If auto mode is dis-
abled or if all variations are analyzed sequentially, then this mode is enabled.
For this type of analysis, the machine list specified in the command line (for batch jobs) or the
machines specified in the UI (for interactive jobs) should only include the Linux solver machines.
This configuration is not supported in a scheduler environment. The Ansoft RSM Service must
be installed and running on all of the Linux hosts, and the software must be registered with the
Ansoft RSM Service on each of the Linux hosts. If the analysis uses MPI distribution, then the
installation path must be the same on all of the Linux hosts; this is the same requirement as for
other configurations.
Options for Distributed Analysis

There are several options for configuring Ansys Electromagnetics products to take advantage of
additional computational resources. The simplest approach is to use the Remote Simulation
Manager (RSM) for Ansys Electromagnetics products. RSM may be installed, configured, and
started on one or more hosts. It runs as a Windows Service. An analysis may be distributed to
any of the hosts where the Remote Simulation Manager is running. RSM is bundled with Ansys
Electromagnetics products.
There are a number of job schedulers available from third parties, such as IBM Platform LSF. A
job scheduler may also be called a distributed resource management system, a cluster man-
ager, a batch system or a distributed resource manager. These systems provide queuing of jobs,
load balancing, assigning resources to jobs, and many other management and monitoring fea-
tures. Ansys Electromagnetics products integrate with several of the most widely used job sched-
ulers. The user is able to submit jobs to the scheduler. When the job runs, the product uses the
resources allocated to the job to accomplish the analysis.
Users may be able to use job schedulers which are not included in the list of supported job sched-
ulers via “custom scheduler integration.” The end user, working with Ansys Electromagnetics
products support engineers, will provide an IronPython script or code library to act as an inter-
face between the scheduler and the Ansys Electromagnetics products.
The RSM for Ansys Electromagnetics products may be used for running an analysis on a remote
host or for running an analysis distributed to multiple hosts. However, the user is required to man-
age the jobs and resources used by these jobs; no ability to queue jobs until needed resources

are available is provided. In general, a job scheduler is more appropriate if there are a number of
hosts shared between a number of users, because a scheduler is better able to manage the jobs
and the resources. It can queue a job and delay the start the job until appropriate resources
become available. Custom scheduler integration is needed to allow jobs to be run on a cluster
that is not managed by one of the supported job schedulers.
Remote Simulation Manager (RSM)

The Remote Simulation Manager (RSM) for Ansys Electromagnetics products may be used for
running an analysis on a remote host or for running an analysis distributed to multiple hosts.
When using RSM, the users are required to manage the jobs and resources used by these jobs.
No load balancing or queueing of jobs is provided. The Remote Simulation Manager is not used
if the analysis is run as a job on one of the supported job schedulers, such as LSF or Windows
HPC. See "Supported Job Schedulers" on page 3-10 for a list of these jobs schedulers. RSM is
also not used if the analysis is run as a job using custom scheduler integration with a scheduler
that is not supported by default. See "Custom Scheduler Integration" on page 3-10 for more
information.
If the the Remote Simulation Manager is running on a host, by default, jobs started on remote
hosts may distribute jobs to the local host. A user may disable this access or re-enable this
access using the Options dialog box. The Tools>Options>General Options menu item pops
up the Options dialog box. Select Remote Analysis.
The Disable access by remote machines check box, in the RSM Service Options group box
controls access. If this check box is not checked, the default setting, then remote hosts can dis-
tribute jobs to the local host. If this check box is checked, then remote hosts cannot distribute
jobs to the local host.

When do you need RSM?

RSM is needed only to run an analysis on a remote host or an analysis distributed to multiple
hosts. RSM is also required if some of the solvers are running on a hosts that run under a dif-
ferent OS than the OS host that is running Ansys Electronics Desktop. If RSM is required, then
the RSM daemon or service must be configured and running on all remote hosts for the analysis.
Please note that RSM is not needed:

l To run an analysis only on the local host.
l To run an analysis using integration with a supported job scheduler or using custom sched-
uler integration.
You should not install RSM on hosts that are managed by a scheduler.
Installing RSM
To install Ansys Electromagnetics RSM software:

1. If you checked to install the Remote Simulation Manager during the software installation,
the Ansys Electromagnetics Remote Simulation Manager installer appears. You can also
install the Remote Simulation Manager as an installation option on the installation CD.
2. To install the Ansys Electromagnetics Remote Simulation Manager, click Next.
The License Agreement screen appears.
3. Read the license agreement carefully. Click Yes if you accept the terms of the agreement.
The Choose Destination Location screen appears.
4. Under Destination Folder, do one of the following to accept the default path or spe-
cify a new one:
l Accept the default installation directory listed under Destination Folder.
l To select a different directory, click Browse. The Choose Folder window appears.
Select a directory, and click OK. If you have other Ansys Electromagnetics software,
Ansys recommends that you install new software in the same directory.
l To create a new directory, click Browse. The Choose Folder window appears. Enter
the new name in the Path field, and click OK.
5. Click Next.
The Remote Simulation Manager Service Configuration window appears.
6. Choose to run the Ansys Electromagnetics Communication service as the System User
or as A specific user (who must have administrative privileges).
If you select A specific user, the fields for User name, Password, and Machine or domain
name are enabled.
Note:
The user selected will run remote and distributed analyses when no user is spe-
cified in the product interface.
7. On the Select Program Folder screen, do one of the following to specify a name for the
program folder:
l Accept the default name displayed in the Program Folders box.
l Select an item from the Existing Folders list.
l Type a new name for the folder in the Program Folders box.
Note:
The program folder, which appears on the Windows Start menu, is a grouping
of related software that includes executable files and other components. The
default programs folder is (Start>Ansys EM Suite).
8. Click Next.

The Review settings before copying files screen appears.

9. In the Review settings before copying files screen, review the information displayed
under Current Settings, and then do one of the following:
l If the settings are correct, click Next to start copying files.
l If the settings are incorrect, click Back as many times as necessary, and change your
selections. Verify each screen before clicking Next to go to the next screen. When all
information is correct, return to the Review settings before copying files screen, and
click Next.
The Setup Status screen appears, displaying a progress bar, and installation begins.
You can click Cancel at any time to exit the installation.
Note:
If you receive a message about read-only files, you typically want to overwrite
them with the newer versions.
At the end of the installation, RSM is automatically started as a service on this machine.
The InstallShield Wizard complete window appears. If you want to view the README file
(recommended before using the software), check the box.
10. Click Finish to close the install window.
If you use RSM, it must be installed on all remote machines. In addition, the product
engines must be registered on RSM.
l If this installation was automatically launched from a product installation, then the regis-
tration will occur automatically.
l To register the engines at any time on Windows, choose Start>Ansys EM Suite 2022
R1>Register with RSM. You can also run RegisterEnginesWithRSM.exe, located in
the product subdirectory (for example, C:\Program Files\An-
sysEM\v221\Win64\RegisterEnginesWithRSM.exe). In each case, you see a dialog
confirming the registration. OK the dialog.
Registering Ansys Electromagnetics Product Engines for use with RSM

You must make each installation of RSM aware of each Ansys Electromagnetics product, so that
remote simulation requests are properly routed to the product. For network installations, you
need only to register each Ansys Electromagnetics product once, regardless of the number of
machines. Otherwise, you need to register each Ansys Electromagnetics product on each
machine running RSM.
l To register an Ansys Electromagnetics product with RSM, either:
Click Start > Ansys EM Suite 2022 R1 > Register with RSM.
Or run RegisterEngineswithRSM.exe, located in the product installation directory (for
example, c:\Program Files\AnsysEM\v221\Win64\RegisterEnginesWithRSM.exe). The

RegisterEngineswithRSM.exe command should be run from the installation path to be

registered with RSM.
l To unregister an Ansys Electromagnetics product from RSM, either:
Click Start > Ansys EM Suite 2022 R1 > Unregister with RSM.
Or run UnregisterEngineswithRSM.exe, located in the product installation directory (for
example, c:\Program Files\AnsysEM\v221\Win64\UnregisterEnginesWithRSM.exe).
Changing the AnsoftRSMService Listening Port

For Remote Analysis or Distributed Analsysis, processes may need to be started on multiple
hosts. If the Ansys Electromagnetics Desktop needs to start a process on a remote host, the
AnsoftRSMService is used to start these remote processes. By default, the AnsoftRSMService
listens for socket connections from the Ansys Electromagnetics Desktop on port 32958.
This section describes how to change the port number used by the AnsoftRSMService.
To change the port number, both the AnsoftRSMService and the Ansys Electromagnetics
Desktop must be configured to use the new port number. The same port number must be used
for Ansys Electromagnetics Desktop and for the AnsoftRSMService process running on each
host used for the analysis.
AnsoftRSMService Configuration
The AnsoftRSMService port number is configured in the ansoftrsmservice.cfg configuration file.

This configuration file is located in the platform specific subdirectory of the RSM installation dir-
ectory.
The default location of this directory is C:\Program Files\AnsysEM\RSM\Win64 on Windows.
The default location of this directory is /opt/AnsysEM/rsm/Linux64 on Linux.
To modify the AnsoftRSMService configuration, first stop the ansoftrsmservice, then modify the
ansoftrsmservice.cfg configuration file, then restart the ansoftrsmservice.
The beginning of the configuration file should appear as follows:
$begin 'AnsoftCOMDaemon'
$begin 'Default:CommDetails'
$begin 'CommDetails'
'ListenPort'='32958'
$end 'CommDetails'
$end 'Default:CommDetails'
If there are additional lines between the following two lines, then they should not be modified:

To change the port number, modify the ListenPort setting within the single quotes from 32958 to
the desired port number. The single quotes should not be removed or changed.
For previous versions of the software, the ansoftrsmservice.cfg file may not contain the lines:
$end 'CommDetails'
If these lines are not present, then add them to the ansoftrsmservice.cfg file after the first line of
the file, and change the ListenPort to the desired port number. For example, to change the port
number to 32000, the beginning of the ansoftrsmservice.cfg file should look like the following
after the changes:
$end 'CommDetails'
Ansys Electromagnetics Desktop Configuration
The port number for connecting to the AnsoftRSMService is configured using the General
Options dialog box. Use the desktop menu commandTools> Options>General Options to
open the General Options dialog box. Navigate to the General>Remote Analysis page.

In the RSM Service Options groupbox, the Ansoft Service Port control shows the current
AnsoftRSMService port number.
1. Press the Change... button to modify this setting. This opens the Change Ansoft Service
Port popup.

2. Enter the new port number in the Ansoft Service Port edit control of the popup dialog.
3. Press the OK button to close the dialog and accept the new port number.
4. Press the OK button to close the General Options dialog and accept the changes.
Supported Job Schedulers

The supported job schedulers of Ansys Electromagnetics Suite 2022 R1 are listed in Job Sched-
ulers and Queuing Systems Support.
The versions earlier than the latest tested version indicated in the table may also work fine and
might have been tested in previous versions of the product. Newer versions may also work if
backward compatibility is maintained by the scheduler.
Custom Scheduler Integration

For the above job schedulers in a standard configuration, Ansys Electromagnetics products
provide an out-of-the-box integrated solution. For integration with other schedulers or non-stand-
ard scheduler configurations, user (or scheduler vendor) needs to provide a component called
"custom scheduler proxy." Using this small component, AnsysEM mainly identifies the compute
nodes allocated by a scheduler to the AnsysEM job, and launches solver processes on those
nodes.
A custom scheduler proxy is usually an IronPython script file that has a class that implements a
specified interface. Functionally, the methods of this class mediate the interactions between
AnsysEM processes and the scheduler. Physically, such a proxy is a small text file, and does not
require to be compiled/linked. This is often the preferred approach, as it is easier to install and
test. The details of this interface and its methods are described elsewhere. Installing a custom
scheduler proxy usually means just adding a .py file under schedulers subdirectory of the
AnsysEM installation directory. By providing a custom scheduler proxy written in IronPython, you
can even override the default scheduler proxy for a supported scheduler.

Note: IronPython is an implementation of the Python programming language targeting the .NET
runtime. You do not need to install IronPython, as AnsysEM already comes with IronPython.
AnsysEM supports it on both Windows and Linux. For more information, see the "Introduction to
IronPython" section.
Alternately, a custom scheduler proxy can be a dynamically linked library (on Microsoft Win-
dows) that implements a set of functions. This library is loaded by the AnsysEM at runtime, and if
it is running as part of a scheduler job, the AnsysEM interacts with the library to get information
from the scheduler, and to start additional processes on specified hosts. Each such library imple-
ments a set of extern "C" functions needed to mediate the interactions between AnsysEM and
the scheduler. The details of these functions are described elsewhere.
Limitations
Implementing your own custom scheduler proxy does not allow use of the job management GUI.
It also does not provide tight-integration of scheduler for MPI-based jobs.
Running HPC Test Jobs on a Cluster

This section describes how to submit and run a small number of test jobs to verify that the
product installation, the cluster configuration, and the MPI installation and configuration are sat-
isfactory for running Ansys Electromagnetics analysis jobs. These tests are not comprehensive,
but successful completion of all of the jobs indicates that the basic requirements for running
Ansys Electromagnetics jobs have been met. Before running these tests, the following steps
should be completed:
l The Ansys Electromagnetics product or products should be installed
l The cluster should be configured for running Ansys Electromagnetics analysis jobs, as
described in "Scheduler Specific Configuration and Testing "on page 3-20
l MPI should be installed and configured as described in "Message Passing Interface (MPI)
Installation " on page 5-1
Each of the test jobs should run to completion in a few minutes or less. They should be run in the
order specified, proceeding to the next test only if any problems found in the preceding test have
been addressed. Three different test jobs are described.
l Non-distributed job
l Non-MPI job distributed to multiple hosts
l MPI job distributed to multiple hosts
Non-distributed job
This is a simple job that uses one core on one host. This test uses the Tee.aedt example project,
which is located in the “Examples/HFSS/RF Microwave” subdirectory of the product installation
directory. The files Tee.PDF and Tee.aedt are needed for this test. This test uses Setup1, but it
does not use the frequency sweep, Sweep1, so the frequency sweep must be disabled.

Use the following steps to copy the project files and disable the frequency sweep, if needed.
1. Copy the files Tee.aedt and Tee.PDF from the Examples/HFSS/RF Microwave sub-
directory of the product installation directory to another directory.
2. Run the product (ansysedt.exe).
3. Open the copy of the project.
4. In the Project Manager window, expand the tree item TeeModel (Driven Model)>Ana-
lysis>Setup1>Sweep1. If frequency sweep Sweep1 is enabled, right-click on TeeModel
(Driven Model>Analysis>Setup1> Sweep1, and select the item Disable Sweep in the
popup menu to disable the frequency sweep.
5. Save and close the project.
Successful completion of this job indicates that the following requirements have been met:
l The job submission host is correctly configured for submitting jobs to the cluster.
l The job user account is authorized to run jobs on the cluster.
l The product installation is accessible from the cluster host allocated to the job.
l The project directory is accessible from the cluster host allocated to the job.
l Communication between different job processes on the cluster host allocated to the job is
not blocked.
Non-MPI job distributed to multiple hosts

This job uses multiple cores distributed to multiple hosts. It does not use MPI. This job will start
on one host, but portions of the analysis will be distributed to the other hosts allocated to the job.
This test also uses the Tee.aedt example project, which is located in the Examples/HFSS/RF
Microwave subdirectory of the product installation directory. The files Tee.PDF and Tee.aedt are
needed for this test, the same as the previous test. This test uses Setup1, and it uses the fre-
quency sweep, Sweep1, so the frequency sweep must be enabled.
Use the following steps to copy the project files and enable the frequency sweep, if needed.

2. Open the copy of the project.
3. In the Project Manager window, expand the tree item TeeModel (Driven Model)>Ana-
lysis>Setup1>Sweep1. If frequency sweep Sweep1 is disabled, right click on TeeModel
(Driven Model)>Analysis>Setup1>Sweep1, and select the item Enable Sweep in the
popup menu to enable the frequency sweep.
Successful completion of this job indicates that the following additional requirements have been
met:
l A job process on one cluster host allocated to the job is able to use the cluster to start addi-
tional job processes on other cluster hosts allocated to the job.

l Communications between job processes running on different cluster hosts allocated to

the job are not blocked.
MPI job distributed to multiple hosts

This job uses MPI processes distributed to multiple hosts. This job will start on one host, but por-
tions of the analysis will be distributed to MPI ranks running on the first execution host and ranks
running on other hosts allocated to the job. This test uses the differential_stripline.aedt example
project, which is located in the Examples/HFSS/Transmission Lines subdirectory of the product
installation directory. The files differential_stripline.pdf and differential_stripline.aedt are needed
for this test. This test uses Setup1, but it does not use the frequency sweep, DC_10GHz, so the
frequency sweep must be disabled.
Use the following steps to copy the project files and disable the frequency sweep, if needed.
1. Copy the files differential_stripline.aedt and differential_stripline.pdf from the

“Examples/HFSS/Transmission Lines” subdirectory of the product installation directory to
another directory.
3. Open the copy of the project. In the Project Manager window, expand the tree item dif-
ferential_stripline -> Differential Stripline (Driven Terminal)>Analysis>GHz>DC_10GHz. If
frequency sweep DC_10GHz is enabled, right-click on differential_stripline> Differential
Stripline (Driven Terminal)>Analysis>GHz>DC_10GHz, and select the item Disable
Sweep in the popup menu to disable the frequency sweep.
Successful completion of this job indicates that the following additional requirements have been
met:
l If needed, MPI is installed and configured on the cluster hosts.
l If needed, user passwords are registered with MPI on the cluster hosts.
l If needed, the MPI prerequisites are installed on the cluster hosts.
Submitting and Running the Tests

This section includes general instructions for submitting and running the jobs. For additional
notes on running any of the test jobs on a specific cluster, see the information for the specific
scheduler in "Scheduler Specific Configuration and Testing " on page 3-20
The test jobs may be submitted to a cluster using the Ansys Electromagnetics job submission
GUI. To use this GUI, start the product, ansysedt.exe, on a host which is configured as a sub-
mission host for the cluster. The product should be started in an environment configured for sub-
mitting jobs to the cluster.
Before submitting the first job, the scheduler must be selected. Use menu item Tools>Job Man-
agement>Select Scheduler to pop up the Select Scheduler dialog.

For a Windows HPC cluster, select Windows HPC in the Choose scheduler drop-down list.
Enter the name of the head node in the Head node edit control. The “...” button may be used to
access a dialog to browse computers accessible via a network.
For other clusters, select the scheduler type in the Choose scheduler drop-down list. Select lsf
for IBM Platform LSF.
Pressing the Refresh button causes the connection to the cluster to be verified, and basic
cluster information to be displayed in the Scheduler info text control. When finished, click OK.
The selected scheduler (and head node, if applicable) will be used for subsequent jobs sub-
mission using the Submit Job GUI. To change the scheduler or head node, pop up the Select
Scheduler dialog again, and select a different scheduler or head node.
To submit a job, use menu item Tools>Job Management>Submit Job to pop up the Submit
Job To: dialog box. The controls applicable to options that are used less frequently are only
shown if the Show advanced options check box is checked. Three tabs are shown on this dia-
log:
l Analysis Specification: Basic analysis parameters, including the product pathname, the
project pathname, and the setup or setups to analyze. Several additional options may be
specified using this tab.
l Compute Resources: The user selects the resources to be allocated to the job and
options for job distribution. Scheduler specific resources may be specified using the
“Resource selection parameters.”
l Scheduler Options: Options for the job to be submitted to the scheduler, such as the job
name and job priority.
Use the Preview Submission button to display information about the job to be submitted to the
cluster. For Windows HPC, this pops up a dialog showing the parameters of the job to be sub-
mitted, and the parameters of the first execution task, including the full command line of this task;
for distributed jobs, additional tasks will be started automatically, as needed, to complete the job.
For other clusters, the dialog shows the job submission command and the contents of the job
script for the job. If a problem is detected with the selected job parameters, a message box con-
taining an error message may be shown, instead of the job submission parameters.
Use the Submit Job button to submit the job to the selected cluster. If there is an error sub-
mitting the job, then an error message will be shown. If the job is submitted successfully, then a
dialog box showing the job ID is displayed to the user. If the Begin monitoring this job now
check box is checked when this dialog is dismissed, then the Monitor Job dialog pops up to
monitor the job. The Monitor Job dialog may be dismissed at any time, and the job will continue
to run. To resume monitoring the same job, select menu item Tools> Job Man-
agement>Monitor Jobs to access the Monitor Job dialog box. Selecting a project file using
the Recent Jobs drop-down list or the file browser popped up by the “...” button will resume mon-
itoring of the most recent job submitted for the selected project. Monitoring will not be possible

from the Monitor Job dialog if there is no network connection between the submission host and
the cluster execution host where the Desktop process runs, or if this connection is blocked.
"Submitting and running a non-distributed job " below
"Submitting and running a non-MPI job distributed to multiple hosts" on the next page
"Submitting and running an MPI job distributed to multiple hosts" on page 3-17
Submitting and running a non-distributed job
1. Copy the files Tee.aedt and Tee.PDF from the Examples/HFSS/RF Microwave sub-
directory of the product installation directory to a directory which is accessible from the
cluster hosts using the same path. This directory, the project directory, must be readable
and writeable by the user running the job. Disable the frequency sweep as described
above.
The scheduler (and head node, if applicable) should be set as described above before sub-
mitting the job to the cluster.
2. Select menu item Tools>Job Management>Submit Job to activate the Submit Job To:
dialog box.
3. In the Analysis Specification tab, ensure that the Product path edit control contains a
pathname of the product that is valid for the cluster execution nodes.
a. Specify the path to the project file in the Project edit control.
b. Specify the setup “TeeModel:Nominal:Setup1” in the Analysis Setups group box.
4. Switch to the Compute Resources tab, and make sure that the Use automatic settings
check box is not checked.
a. For the Method, select Number of Tasks and Cores in the drop-down list.
b. Set the Total number of tasks to 1.
c. Set the Cores per distributed task to 1.
d. Ensure that the Limit number of tasks per node to: check box is not checked.
The other options on all tabs may be set to any values.
5. Press the Preview Submission button. If no errors are found, then the Preview Submit
Job Results dialog should display information on how the job will be submitted to the
cluster. If an error is displayed instead of the Preview Submit Job Results dialog box,
then address the error before continuing. This dialog should indicate that only one host is
needed for the job. If this is not the case, then review the job resources specified on the
Compute Resources tab, and retry. If the job and task parameters are correct, then close
the Preview Submit Job Results dialog and continue.
6. Submit the job using the Submit Job button. If an error occurs on job submission,
address the error before submitting the job again. If the cluster is Windows HPC, you may
be prompted for a password if it is not cached. If this occurs, enter the password and con-
tinue. If possible, monitor the job until it finishes.
If the job fails to complete successfully, check the following items:

l The user submitting the job must be authorized to run jobs on the cluster.
l The pathname of the product must be accessible on the cluster execution node(s) where
the job runs, and the job user must have permission to run the product executables.
l The pathname of the project must be accessible on the cluster execution node(s) where
the job runs. The job user must have permission to read from and write to the directory
containing the project file, and there must be adequate disk space for the job results.
l The temp directory used by the job must exist and it must have adequate disk space for
the job temporary files.
l Check for errors or warnings in the Monitor Job dialog box, and address these issues.
l Check the cluster for errors or warnings related to the job and address these issues. The
job ID is displayed in a dialog when the job is successfully submitted. The job ID of the last
job run on the specified project is also shown in the Monitor Job dialog.
Submitting and running a non-MPI job distributed to multiple hosts
The cluster must have at least two hosts with the same number of cores per host. Let N be the
smallest number of cores per host, such that the cluster contains at least two hosts with N cores
per host. The job will be submitted to run on two hosts with N cores per host, requesting a total of
2 * N cores. For many clusters, selecting N = 4 may be a good choice.
1. Copy the files Tee.aedt and Tee.PDF from the “Examples/HFSS/RF Microwave” sub-
directory of the product installation directory to a directory which is accessible from the
cluster hosts using the same path. This directory, the project directory, must be readable
and writeable by the user running the job. Enable the frequency sweep as described
above.
dialog box.
3. In the Analysis Specification tab, ensure that the Product path edit control contains a
a. Specify the path to the project file in the Project edit control.
b. Specify the setup “TeeModel:Nominal:Setup1” in the Analysis Setups group box.
b. Set the Total number of tasks to 2 * N.
e. In the Job distribution group box, press the Modify button to access the Job Dis-
tribution dialog.

f. In the Enable Distribution Types section, uncheck the Use defaults check box,
and check only the Frequencies check box.
g. In the Distribution levels section, select the Single level only radio button.
h. Click OK to close the Job Distribution dialog.
5. For the schedulers which support setting the minimum and maximum cores per node for a
job (Windows HPC and LSF), set both of these values to the value N, determined earlier,
as follows:
a. Click on the “...” button to activate the Compute Resource Selection Parameters
dialog box.
b. For the MinCoresPerNode parameter, check the Specify Parameter check box,
and set the value to N.
c. For the MaxCoresPerNode parameter, check the Specify Parameter check box,
d. Click OK to close the Compute Resource Selection Parameters dialog.
then address the error before continuing. This dialog should indicate that a total of 2 * N
cores are required for the job, and that N cores will be needed on each host allocated to
the job. If this is not the case, then review the job resources specified on the Compute
Resources tab, and retry. If the job and task parameters are correct, then close the Pre-
view Submit Job Results dialog and continue.
If the job fails to complete successfully, check the following items, in addition to the items men-
tioned for the first test:
l The Desktop process will use the cluster to launch processes on the other hosts allocated
to the job. Verify that the cluster configuration allows a job to launch processes on the
other hosts allocated to the job.
l Job processes on different hosts allocated to the job need to communicate. Verify that
communication between these job processes is not blocked.
Submitting and running an MPI job distributed to multiple hosts
Determine which MPI Vendor will be used for MPI jobs, Intel MPI or Microsoft MPI. This test
should use the same MPI Vendor that will be used by cluster users. If no MPI Vendor is specified
by the user, then the default MPI Vendor (Microsoft) is used. Intel MPI is denoted by the string
“Intel.” Microsoft MPI is denoted by the string “Microsoft.” If both MPI Vendors may be needed by

cluster users, then this test should be run twice, once with each MPI Vendor specified. Consult
"Message Passing Interface (MPI) Installation " on page 5-1 to determine if the MPI provided by
the selected MPI Vendor needs to be installed and to determine how it should be configured.
The cluster must have at least two hosts with the same number of cores per host. Let N be the
smallest number of cores per host, such that the cluster contains at least two hosts with N cores
per host. The job will be submitted to run on two hosts with N cores per host, requesting a total of
2 * N cores.
1. Copy the files differential_stripline.aedt and differential_stripline.pdf from the

Examples/HFSS/Transmission Lines subdirectory of the product installation directory to a
directory which is accessible from the cluster hosts using the same path. This directory,
the project directory, must be readable and writeable by the user running the job. Disable
the frequency sweep as described above.
dialog box.
3. In the Analysis Specification tab, ensure that the Product path: edit control contains a
a. Specify the path to the project file in the Project: edit control.
b. Specify the setup Differential Stripline:Nominal:3GHz in the Analysis Setups
group box.
c. In the Analysis options group box, set the HFSS/MPIVendor batchoption to the
desired MPI Vendor, “Intel” or “Microsoft”. If this batchoption is present, but set to a
different value, then you can use the Edit button to change the value; edit the value
in the Edit Batchoption dialog and press the Update button to register the new
value before closing the dialog with the Done button. If it is not set, then use the
Add button to add it; in the Add Batchoption dialog box, select the registry key
“HFSS/MPIVendor” in the grid, and then edit the text in the Value control, if needed,
and press Add to register the new value, before closing the dialog with the Done
button.
b. Set the Total number of tasks to 2 * N.
e. In the Job distribution group box, press the Modify button to access the Job Dis-
tribution dialog.
f. In the Enable Distribution Types section, uncheck the Use defaults check box,
and check only the Direct Solver Memory check box.

g. In the Distribution levels section, select the Single level only radio button.
h. Click OK to close the Job Distribution dialog.
5. For the schedulers which support setting the minimum and maximum cores per node for a
job (Windows HPC and LSF), set both of these values to the value N, determined earlier,
as follows:
a. Click on the “...” button to activate the Compute Resource Selection Parameters
dialog box.
b. For the MinCoresPerNode parameter, check the Specify Parameter check box,
c. For the MaxCoresPerNode parameter, check the Specify Parameter check box,
d. Click OK to close the Compute Resource Selection Parameters dialog.
then address the error before continuing. This dialog should indicate that a total of 2 * N
cores are required for the job, and that N cores will be needed on each host allocated to
the job. If this is not the case, then review the job resources specified on the Compute
Resources tab, and retry. If the job and task parameters are correct, then close the Pre-
view Submit Job Results dialog and continue.
If the job fails to complete successfully, in addition to the items mentioned for the first and
second tests, MPI configuration issues may cause job failures. Check the following MPI con-
figuration issues:
l Verify that the correct MPI Vendor (“Intel” or “Microsoft”) is specified using a batchoption
setting in the Submit Job To: dialog box. The controls for specifying batchoptions are loc-
ated in the Analysis Options group box on the Analysis Specification tab of the Sub-
mit Job To: dialog.
l Verify that the specified MPI Vendor is installed (if needed) and configured correctly for
the user submitting the job, as described in "Message Passing Interface (MPI) Installation
" on page 5-1 Pay close attention to the registration of user passwords because the lack
of a cached password when one is required, or a cached password that is incorrect or out
of date (even if no cached password is required) may cause authentication errors. Note
that passwords are cached separately on each cluster host, so a job may have authen-
tication errors on some hosts but not on other hosts.

Scheduler Specific Configuration and Testing

The sections below describe configuration requirements for each supported scheduler. Methods
for running tests to verify the configuration are included.
"Windows HPC" below
"IBM Platform LSF" on page 3-22
Windows HPC
Job Submission Host Configuration
In order to submit jobs to a Windows HPC cluster from the Ansys Electromagnetics Desktop, the
Windows HPC Client Utilities must be installed on the job submission host. The recommended
version is Microsoft (R) HPC Pack 2019. Only the Client Components are required on the job
submission host.
The Bin subdirectory of the Windows HPC Client Utilities installation directory (typically "C:\Pro-
gram Files\Microsoft HPC Pack 2019\Bin") must be included in the PATH environment variable
or in the ANSYSEM_WINHPC_CLIENT_UTILS_PATH environment variable. If this folder is not
added to the PATH environment variable during the installation of the Client Utilities, or if it has
been removed from the PATH environment variable, then it may need to be manually added to
one of these environment variables. The ANSYSEM_WINHPC_CLIENT_UTILS_PATH envir-
onment variable may be used instead of the PATH environment variable to prevent the PATH
environment variable from becoming too long. The ANSYSEM_WINHPC_CLIENT_UTILS_
PATH environment variable may contain multiple directories separated by semicolon (;) char-
acters, just like the PATH environment variable.
Cluster Configuration Guidelines
The Windows HPC cluster affinity setting should be set to “Non-Exclusive jobs” or “No jobs.” Set-
ting the Windows HPC cluster affinity to “All jobs” may prevent the job from using all of the
resources allocated to the job, for the reasons outlined below.
Each Ansys Electromagnetics analysis job is started as a single process on a single host. If the
job needs to distribute a portion of the analysis to a different host, a single core task is started on
the remote host to start the analysis processes on that host. Only one core is allocated for the
task used to start these processes, even if multiple process are started by the task or multiple
cores are needed by any of the processes started by the task. If the Windows HPC cluster affin-
ity setting is set to “All jobs,” then the remote processes would be limited to using a single core
on the remote host, even if the job was allocated multiple cores on the remote host.
Running Test Jobs
When attempting to submit a job to the cluster, if there is a problem connecting to the head node,
check the following items:

l The head node name is correct

l There is a network connection between the job submission node and the head node
l No firewall blocks communication between the job submission node and the head node
l The 64 bit Windows HPC 2008 R2 Client Utilities are installed on the job submission node
l The user making the connection is an authorized Windows HPC cluster user
If the job cannot be monitored from the Ansys Electromagnetics Monitor Job dialog because
there is no network connection between the submission node and the cluster execution node (or
the connection is blocked), then the HPC Job Manager installed with the Windows HPC Client
Utilities can be used to monitor the job.
If errors occur with any of the test jobs, then information on the failure can be found by viewing
the job in the HPC Job Manager. Check for messages in the Job Progress window. For any
failed tasks, check the Results, Details, and Allocated Nodes tabs for more information on pos-
sible problems.
Non-distributed job
If the job fails to complete successfully, check the following items:

l The pathname of the product must be accessible by the user running the job from the
cluster execution node(s) where the job runs.
l The pathname of the project must be accessible by the user running the job from the
cluster execution node(s) where the job runs. The directory containing the project file must
be writable by the user running the job from the cluster execution node(s) where the job
runs, and there must be adequate disk space for the job results.
l The temp directory specified by batchoptions or using the installation default setting on
the cluster execution node(s) where the job runs must have adequate disk space for the
job temporary files.
l Also check the Job using the Windows HPC Job Manager. Check for error and warning
messages associated with the job. Also check for failed tasks, and check the task inform-
ation for any failed tasks.
This job will be submitted to run on two hosts with N cores per host, requesting a total of 2 * N
cores, where N is the smallest number of cores per host, such that the cluster contains at least
two hosts with N cores per host.
l In addition to the task used to start the job (the Desktop task), an additional task is started
each of the other job hosts to start processes on these hosts. For this task, there should

be one such task (a Remote Engine Task). Verify that the Remote Engine Task is able to
start and communicate with the Desktop task.
This job will be submitted to run on two hosts with N cores per host, requesting a total of 2 * N
cores, where N is the smallest number of cores per host, such that the cluster contains at least
two hosts with N cores per host.
If the MPI Vendor is “Intel,” then installation of Intel MPI on all cluster nodes is required as
described in the "Install Intel MPI " on page 5-2
If the job fails to complete successfully, in addition to the items mentioned for the first and
second tests, MPI configuration issues may cause job failures. Check the following MPI con-
figuration issues:
l Verify that the correct MPI Vendor (“Intel” or “Microsoft”) is specified via a batchoption set-
ting when submitting the job.
l Verify that the specified MPI Vendor is installed and configured correctly for the user sub-
mitting the job, as described in "Message Passing Interface (MPI) Installation " on page 5-
1 . Note that MPI password registration is done separately for each cluster host. If authen-
tication errors occur for some cluster hosts but not for other cluster hosts, then the errors
may be due to an incorrect password or no password registered on some hosts.
IBM Platform LSF

Cluster Configuration Guidelines
To allow users to submit exclusive jobs, the users must have access to queues which are con-
figured with the EXCLUSIVE property set to Y. Appropriate queues should be configured with
the EXCLUSIVE property set if users need to submit exclusive jobs.
Using the Ansys Electromagnetics job submission GUI, a user may submit jobs where the user
specifies tasks automatically and specifies the “Number of Cores and (Optional) RAM.”
However, the RAM per core may only be specified if the LSF cluster is configured with parameter
RESOURCE_RESERVE_PER_SLOT set. This LSF cluster configuration parameter should be
set to allow user to specify the RAM per core for the job.
Running Test Jobs
If there is a problem connecting to the scheduler when the job submission node is the local node
(where the GUI is running) and the lsf scheduler is specified, check the following items:
l The cluster is up and running normally.
l The local node is configured as a job submission node for the cluster.
l The user running the GUI has permission to submit jobs to the cluster.

l The environment was configured for submission of jobs to the cluster before starting the
product, ansysedt.
Non distributed job
l If the job fails to complete successfully, check the following items:

l The pathname of the product must be accessible by the user running the job from the
cluster execution node(s) where the job runs.
l The pathname of the project must be accessible by the user running the job from the
cluster execution node(s) where the job runs. The directory containing the project file must
be writable by the user running the job from the cluster execution node(s) where the job
runs, and there must be adequate disk space for the job results.
l The temp directory specified by batchoptions or using the installation default setting on
the cluster execution node(s) where the job runs must have adequate disk space for the
job temporary files.
This job is submitted to run on two hosts with N cores per host, requesting a total of 2 * N cores,
where N is the smallest number of cores per host, such that the cluster contains at least two
hosts with N cores per host.
For this test, the product, ansysedt, runs on one of the hosts, and the LSF blaunch command is
used to start an ansoftrsm process on the other host. The ansoftrsm process is used to start any
additional processes needed by the job on the other host. In some cases, multiple ansoftrsm pro-
cesses are started on the other host, but only one such process should be running on a given
host at any time.
l Verify that the LSF blaunch command is able to start the ansoftrsm process on the other
host.
This job is submitted to run on two hosts with N cores per host, requesting a total of 2 * N cores,
where N is the smallest number of cores per host, such that the cluster contains at least two
hosts with N cores per host.
If the MPI Vendor is “Intel,” then installation of Intel MPI on all cluster nodes is required as
described in"Install Intel MPI " on page 5-2 If the job fails to complete successfully, in addition to
the items mentioned for the first and second tests, MPI configuration issues may cause job fail-
ures. Check the following MPI configuration issues:

l Verify that the correct MPI Vendor (“Intel” or “Microsoft”) is specified via a batchoption set-
ting when submitting the job.
l Verify that the specified MPI Vendor is installed and configured correctly for the user sub-
mitting the job, as described in "Message Passing Interface (MPI) Installation " on page 5-
1 MPI password registration is done separately for each cluster host. If authentication
errors occur for some cluster hosts but not for other cluster hosts, then the errors may be
due to an incorrect password or no password registered on some hosts.

4 - Updating Software and Licenses

After installation, you may need to reinstall the software, update a license, or add a software com-
ponent, such as a library. If you have already installed the software, the next time you run the
Setup program, the installation starts in Maintenance mode.
Using Maintenance Mode

The following options are available in Maintenance mode:
l Modify: Allows you to modify the existing installation. Use this option to select new soft-
ware components or to select a new license file.
l Repair:Upgrades the existing software with new features and defect patches and
refreshes files.
l Remove:Removes all installed software components.
l Update/Remove (This displays only if the version you are installing is newer than what is
installed.)
To start the software in Maintenance mode:
1. Use the Windows Control Panel to access the Apps & Features window.
2. From the Apps & Features list, click the desired Ansys Electromagnetics product program
folder.
3. Click Modify.
The Modify, Repair or Remove window appears for the desired Ansys Electromagnetics
software.
Updating Software and Licenses 4-1

4. Select one of the following:

l Modify: Change the program features installed by the previous setup. You can also
choose this option to specify new license files or a new server.
l Repair: Reinstall all program features installed by the previous setup.
l Remove:Remove the Ansys Electromagnetics product previously installed.
5. Click Next, and follow the instructions that appear.
Updating a Software License

There may be times when you need to update a software license. This may occur for a number
of reasons:
l When you change servers, do the following:
1. Install Ansys License Manager on the new server machine, and add the new license
file.
2. Run each Ansys Electromagnetics software installation in Maintenance mode, and
specify the names of the new servers.
l When you receive an updated purchased license file, you only need to update the license
file using the Ansys License Manager.

If you are changing the name of the license server used by the software, you need to modify the
client installation:
1. Follow the steps to run in maintenance mode.

The Modify, Repair or Remove window appears for the desired Ansys Electromagnetics
software.
2. Click Modify.
3. Click Next in each window.
4. On the License Information screen, select the new license file.
Note l Select I have a new license file to change the license file (if you
received a new one from Ansys Electromagnetics, either evaluation or
purchased).
l Select I want to specify a license server if you need to change the
name of the machine where the Ansys License Manager is installed.
See "Installing the Software " on page 2-1 for more details on available license
options.
Specifying License Server Machines via the ansyslmd.ini file or Envir-

onment Variables.
The Specify the License Server Machine option during installation creates or updates the
ansyslmd.ini file that is located in the licensing directory. Entries in the ansyslmd.ini file tell
ANSYS, Inc. products which license server(s) to query to find a valid license. Using this option
allows all users at your site to use this setting without having to individually set the ANSYSLMD_
LICENSE_FILE or ANSYSLI_SERVERS environment variables to specify the license server
machine(s). It also eliminates the need to have a copy of the license file on every system at your
site.
The order that the SERVER lines are listed in the ansyslmd.ini file dictates the order in which
the license request is granted. To reorder the entries in the list, highlight a server and use the
Move up or Move down buttons.
You are not limited to designating one set of license server machines for your network. You can
have multiple single-server or three-server (redundant triad) licensing systems on your network.
In this situation, you would have certain licenses connected to a set of server machines (one or
three) on the network, and other licenses connected to a different set of server machines (one or
three) on the network.
The format of the ansyslmd.ini file created by ANSLIC_ADMIN follows. Each server's spe-
cification entry in this file will typically begin with ANSYSLI_SERVERS= and SERVER= to spe-
cify the Licensing Interconnect and FlexNet port numbers, respectively.
On a single server:
ANSYSLI_SERVERS=<ansysliport>@<host>

SERVER=<flexnetport>@<host>
For multiple single servers, each server should have its own ANSYSLI_SERVERS= and
SERVER= lines.
On redundant (triad) servers on Linux platforms:

ANSYSLI_
SERVERS=<
ansysliport>@<host1>:<ansysliport>@<host2>:<ansysliport>@<host3>
SERVER=<
flexnetport>@<host1>:<flexnetport>@<host2>:<flexnetport>@<host3>
Windows platforms use semicolons (;) instead of colons:

ANSYSLI_
SERVERS=<
ansysliport>@<host1>;<ansysliport>@<host2>;<ansysliport>@<host3>
SERVER=<
flexnetport>@<host1>;<flexnetport>@<host2>;<flexnetport>@<host3>
Do not use commas as separators; use colons (:) on Linux machines and semicolons (;) on Win-
dows machines.
The Ansys Licensing Interconnect default port number is 2325 and the Ansys FlexNet default
port number is 1055. The host is the license server hostname. For example, if the license server
name is alpha1:
ANSYSLI_SERVERS=2325@alpha1
SERVER=1055@alpha1
The order of the ANSYSLI_SERVERS and the SERVER lines in the ansyslmd.ini file spe-
cifies the order in which the requested license will be granted.
You must use the port@host format; you cannot enter a path or a filename in place of the host-
name.
Overriding the ansyslmd.ini File — If you want to override the server specification settings
in the ansyslmd.ini file, you can do so by setting the ANSYSLMD_LICENSE_FILE and
ANSYSLI_SERVERS environment variables on individual machines. These environment vari-
ables are useful if you want to temporarily point to a different license server machine without dis-
rupting the machine's configuration. Use the ANSYSLI_SERVERS environment variable to
specify the Licensing Interconnect port number. Use the ANSYSLMD_LICENSE_FILE to spe-
cify the FlexNet port number.
If the ANSYSLMD_LICENSE_FILE environment variable is set but the ANSYSLI_SERVERS

environment variable is not set, the same server machines will be used to specify the Licensing
Interconnect but the port number will be replaced by the Licensing Interconnect default port of

2325. When both variables are set, ANSYSLMD_LICENSE_FILE explicitly defines the FlexNet
servers while ANSYSLI_SERVERS explicitly defines the Licensing Interconnect servers.
If you set the ANSYSLMD_LICENSE_FILE or ANSYSLI_SERVERS environment variables on

a three-server (redundant) system, specify all three systems in the same order as the SERVER
lines are listed in the license file. If you specify only the master and it is down, you could see a
“License Server Down” or “No License Found” message and the search for a license could fail.
Join redundant or multiple single server systems by separating the system names with colons on
Linux systems and semicolons on Windows systems.
To have your license server preference known each time you log in, set the environment vari-
ables ANSYSLMD_LICENSE_FILE and ANSYSLI_SERVERS (both Windows and UNIX sys-
tems). On UNIX systems, place these environment variables in your login startup file (e.g.,
.cshrc file).

PDF layout 4-6

5 - Message Passing Interface (MPI)

Installation
The two supported Message Passing Interface (MPI) options in Ansys Electromagnetics Suite
are Microsoft and Intel. MPI is not required if the analysis is not distributed, nor is it required for
manual distribution of variations only. MPI is required for all other types of distribution, such as
distribution of frequencies or domains, and for auto distribution.
Intel MPI
For Intel MPI, user authorization must be configured to distribute an analysis using MPI. Intel
MPI supports several authentication methods on Windows, including password-based author-
ization. See the Intel MPI documentation on user authorization for additional information.
No additional MPI configuration is required for distribution using Intel MPI on the local host.
For distribution using Intel MPI to multiple hosts, Intel MPI must be installed on all of the hosts
and the Hydra Service must be running on all of the hosts in addition to configuring user author-
ization on all of the hosts.
See Install Intel MPI.
Microsoft MPI
For Microsoft MPI, no configuration of user authorization is required.
For Windows HPC jobs, no additional configuration is required for distribution using Microsoft
MPI.
For distribution using Microsoft MPI on the local host (without Windows HPC), some additional
configuration is required. Microsoft MPI must be installed on the local host and the MS-MPI
Launch Service must be running. The Microsoft MPI redistributable package installs the MS-MPI
Launch Service, with the startup type set to Manual, so the MS-MPI Launch Service must be star-
ted manually. This may be done using the Windows Services Manager or using the command
line as described in the Microsoft MPI Release Notes. Distribution to multiple hosts using
Microsoft MPI is only supported under Windows HPC.
See Install Microsoft MPI.
Windows
To obtain an ethernet address as a valid license hostid when running Microsoft Windows:
1. If you are using a laptop, disconnect the laptop from the docking station if docked.
2. Go to the command prompt.
Message Passing Interface (MPI) Installation 5-1

3. Type ipconfig /all, and press Enter.

A listing of network interface cards is shown.
4. For a valid network interface card, look for the Physical Address line. The ethernet
address for that device is the value of the physical address, without dashes.
Note:
Other types of adapters, including Point-to-Point Tunneling Protocol (PPTP)

adapters and the Microsoft Loopback Adapter, may be listed here. These are not
valid for license hostids.
Install Intel MPI

1. On the Ansys Electomagnetics installation menu, click Install Distributed Simulation
Technologies > Install Intel MPI.
2. After you click Install Intel MPI, you see the following dialog.
3. Specify the installation directory, and click Extract. The MPI Library 2018 screen is dis-
played.
4. On the Intel(R) MPI Library 2018 Update 3 for Windows* screen, click Next to install the
software.

Intel MPI typically requires passwords to be registered on the simulation host machine,
which is typically the first machine in the distributed machine list. Password registration
may also be required on other machines to allow access to network resources, such as
shared drives. Go to All Programs > Intel® Software Development Products > Intel MPI
Library Runtime Environment > Build environment for Intel® 64 > wmpiregister and enter
your account and password information.

Note:
You can work around the password registration for cases where accessing network
resources is not needed by performing the Active Directory setup (see https://soft-
ware.intel.com/en-us/mpi-developer-reference-windows-user-authorization) and set-
ting the environment variable I_MPI_AUTH_METHOD to "delegate".
5. Define the temp directory on all machines such that the designated user is allowed full con-
trol.
6. Disable the Windows firewall, or configure it as specified in the Firewall Configuration
topic in the Ansys Electromagnetics product online help.
7. After starting Ansys EM Suite, select Intel MPI to use as the MPI Vendor on the Options
tab under Tools > Options > HPC and Analysis Options.
Install Microsoft MPI

In order to use Microsoft MPI with Ansys EM Suite on the local host, Microsoft MPI must be
installed on the local host and the MS-MPI Launch Service must be running.
Ansys EM Suite supports using Microsoft MPI on multiple hosts or on remote hosts only under
Windows HPC.
1. On the Ansys Electomagnetics installation menu, click Install Distributed Simulation

Technologies > Install Microsoft MPI.
2. On the Welcome to the Microsoft MPI Setup Wizard, click Next.
3. On the End-User License Agreement, click the check box to accept the terms, and click
Next.
4. Install to the default (C:\Program Files\Microsoft MPI\) or change to a different folder, and
click Next.
5. Click Install.
6. When the installation is complete, click Finish.
7. After starting Ansys EM Suite, select Microsoft MPI to use as the MPI Vendor on the
Options tab under Tools > Options > HPC and Analysis Options.
MS-MPI Launch Service

You can use MS-MPI Launch Service to launch MPI processes for local and remote machines.
For more information, refer to the Microsoft MPI Release Notes.for MS-MPI Launch Service.

General Notes
Note:
The standard setup described here assumes that the user is part of a domain and is
running on computers within the given domain.
Using network resources, such as shared drives, may require password registration on all
machines for both Microsoft and Intel MPI.
It is easiest if share permissions are set to Full Control for the Everyone group for the temp dir-
ectories.
The following provides information about specific scenarios:
Scenario 1
The user is administrator or standard user on the local machine and needs to run on one or more
remote computer as an admin or a standard user. In addition, the user always puts the local
machine first in the distributed machine list so that the local machine is the simulation host.
This is the standard situation and does not require further specifications. MPI should be installed
on all machines, and the solver options and MPI configuration on the local machine will be used.
Scenario 2
The user is administrator or standard user on the local machine and is not defined as a user on
the remote machines. In addition, the user always puts the local machine first in the distributed
machine list so that the local machine is the host.
This situation is similar to Scenario 1, but the MPI jobs will run as a user that does not exist on
the remote machines. Ansys strongly recommends setting the temp directories to Full Control for
the Everyone group to avoid issues with permissions.
Scenario 3
The user is administrator or standard user on the local machine, but needs to run only on remote
machines. In this scenario the remote machine that is first in the distributed machine list will be
the host machine for the simulation.
RSM must be installed and registered on the host machine. There are two RSM settings that can
affect the simulation.
l The first setting is under RSM properties, which can be set to System User or A spe-
cific user. This setting is chosen at installation and can be changed through the Ser-
vices panel or by going to Remote Simulation Manager > Remote Simulation
Manager Maintenance > Modify.

l The second setting is in the Desktop in Tools > Options > General Options, on the
Remote Analysis Options tab. Here you can chose either Service User or Specified
User. Here is additional information about these settings:
Simulation
Remote
RSM Prop- runs on
Simulation Notes
erties remote
Options
machine as
System Service Local System Local System user will not have Ansys Elec-
User user tromagnetics Suite user preferences and may
not have necessary privileges or access to
resources.
System Specified user_A Runs as user_A
User =
user_A
Specific Service user_A Runs as user_A
User = User
user_A
Specific Specified May fail due to Not recommended
User = User = privileges
user_A user_B
The preferred setup for this situation is to assign a Specific or Specified user, but not both.
Windows HPC Scheduler

If you are using the Windows HPC Scheduler, you have the option to install the Ansys Elec-
tromagnetics Suite at the same location on each node individually. The simulation can then be
run from one of the compute nodes or from the head node using the Windows HPC Scheduler
GUI that is selected in Tools>Job Management>Select Scheduler before using Tools>Job
Management>Submit Job. The MPI setup is the same as described previously. If a registered
password expires or is changed for any other reason, then MPI failures may occur due to the
incorrect password. To clear a previously registered password, open a command window, go to
<install_dir>\win64\common\fluent_mpi\multiport\mpi\win64\pcmpi\bin, and run the following
command:
mpidiag -s <your machine name> -at -clearcache
The following command may be used to check whether a password is cached for the current
user:

mpidiag -s <your machine name> -at -iscached
For general information on using the Windows Scheduler, see the Integration with Microsoft Win-
dows HPC Scheduler topic in the Ansys Electromagnetics Suite online help.
Note:
The LSF scheduler is not supported on Windows networks for Ansys Electromagnetics
Suite simulations that require MPI (for example, DDM).
Network Installation
If you want to use a network installation with the Windows HPC Scheduler, follow these steps:
1. Install Ansys Electromagnetics Suite on the head node.

2. Share the AnsysEM directory in the head node installation (setting Full Control for Every-
one).
3. Install Intel MPI on all nodes. Register your password with MPI on all nodes. Perform Act-
ive Directory Setup on all nodes. To avoid password registration on all nodes, see the note
in "Install Intel MPI " on page 5-2 .
See http://soft-
ware.intel.com/sites/products/documentation/hpc/ics/impi/41/win/Reference_Manu-
al/Active_Directory_Setup.htm
Or
Password registration is not required for Windows HPC jobs. It is recommended that you
read the information on using for MPI Based Solves in the online help before submitting a
job.
4. Install the following Microsoft Visual C++ Redistributables on all nodes:

l Microsoft Visual C++ 2008 (x86 and x64)
l Microsoft Visual C++ 2012 (x64 only)
The necessary installers are provided in the installation folder in the Prerequisites dir-
ectory.
5. Bring up Ansys Electronics Desktop on each node using the network installation to verify
the installation was done properly.
6. Place the pjt in a shared folder (where Everyone has Full Control).
7. Launch Ansys Electronics Desktop on the head node. Set the head node from the Ansys
Electronics Desktop using Tools > Job Management > Select Scheduler.

8. Open the Windows Scheduler GUI from the Ansys Electronics Desktop to submit the job
(see Tools > Job Management > Submit Job). Information is available in the Integration
with Microsoft Windows HPC Scheduler topic in the Ansys Electronics Desktop online
help.
9. Be sure to use the UNC pathname for the product and project (see the Integration with
Microsoft Windows HPC Scheduler topic in the online help for more details).
10. Name the job and set other options as required for your setup. We recommend setting the
version of MPI (Microsoft or Intel) in the Batchoptions by adding the following, for
example:
'HFSS/MPIVendor'=Intel
'HFSS-IE/MPIVendor'=Intel
'Q3D Extractor/MPIVendor'=Intel
or
HFSS/MPIVendor'=Microsoft
'HFSS-IE/MPIVendor'=Microsoft
'Q3D Extractor/MPIVendor'=Microsoft
After the job is submitted, you can monitor the job using the HPC Job Manager.
Testing has shown that when using Windows Server 2012 with a Network installation, the head
node should not be one of the computer nodes.
Troubleshooting Section
l I am getting an error message that mentions AnsoftRSMService. Is there a prob-
lem with my installation?
[error] Unable to locate or start COM engine on 'your_machine_name_here' : Unable to
reach AnsoftRSMService. Check if the service is running and if the firewall allows com-
munication…
Do not immediately assume there is a problem with RSM, especially if your_machine_
name_here is your local machine. The message is stating that it cannot start the Com
engine. This can be the result of a misspelled machine name or an issue with the firewall.
Check these first.
If the host machine is a remote machine (your_machine_name_here is a remote com-
puter), there might be an issue with the RSM service on the remote computer. Check the
RSM installation and registration on that machine.
l Is there an easy way to test the computers in my Distributed Machine Con-
figurations?
1. Select HPC and Analysis Options.
2. Click Edit, and select one or more machine names in the list on the Machines for Dis-
tributed Analysis dialog box.

3. Click the Test Machines button. A set of tests will be run from the current machine to
the selected machines that includes pinging the computer and checking the RSM avail-
ability.
l When I attempt to simulate, I get the following error message:
[error] The attempted launch of solvers via MPI failed while connecting to communication
pipes. The probable cause is failure to install the vendor MPI on one or more machines or
password authentication failure for MPI during the launch attempt.
Followed by
Unable to create child process: mpirun.
Possible causes for the messages are:
l MPI is not installed on one or more machines.
l The wrong version of MPI is installed on one or more machines.
l The password registration is incorrect on one or more machines.
l Ansys Electromagnetics Suite is not installed in the same location on all machines.
l The user is not a registered user on the remote machines for a workgroup network.
l There is an issue with the firewall.
l When I attempt to simulate, I get the following error message:
[error] Distributing matrix solutions for domains, process mpirun error: Simulation directory
creation failed for one or more MPI solvers. Check access privileges and disk space for
the following:…
This message means you do not have the correct privilege for the temp directory on one
or more of the remote machines. In many cases the software uses the installation temp dir-
ectory that is defined during the installation on the given machine. It is recommended that
this directory be set for Everyone to have full Read/Write privileges on all machines.
l My setup was working last week, but today I am getting a password authen-
tication failure error.
This error may occur if anything changed in your network configuration. The most com-
mon cause is your login password was changed as part of a periodic update for network
security. If the passwords were registered for MPI, they need to be updated on all
machines every time the login passwords are changed.

PDF layout 5-10

A - Silent Installation
When you use the Ansys Electromagnetics silent installation feature, the software is installed on
your computer with no windows appearing during the installation process. InstallShield sup-
presses all dialog boxes, including error messages and informational message boxes.
To install Ansys Electromagnetics software using a silent installation:

l Obtain a license file for the software you are installing.
l Obtain and install a hardware key if necessary.
l On a representative machine, install the Ansys Electromagnetics software once from
the command prompt, as described in this chapter.
Running the Silent Installation

To install Ansys Electromagnetics software using a silent installation, you need to record a
response file, and then use that file to install the software on other computers. You can also
record a response file to use when performing Modify Integration with Ansys<v#>.
To record a response file, you must install the software one time on one machine:
1. Open a Windows command prompt.

2. Browse to the directory where setup.exe (full download) or the self-extracting executable
(patch) is located.
3. Type the following, and press Enter:
l Full download:
setup.exe -r -f1<.iss response file>
Note: If there are spaces in the file path, use quotation marks to indicate the spaces as fol-
lows: -f1"<path>"
l Self-extracting patch:
<path to patch .exe> -a -r
-f1<path to iss response file>
4. Follow the normal prompts for installation. Once complete, the iss response file will con-
tain information that can be used to install the same product on other Windows machines.
To install the software on other computers running Windows, perform the following steps on
each machine:
1. Open a Windows command prompt.

2. Browse to the directory where setup.exe (full download) or the self-extracting executable
(patch) is located.
3. Type the following, and press Enter:
l Full download:
Silent Installation A-1

setup.exe -s -f1<.iss response file>

-f2<path to log file>
Note: If there are spaces in the file path, use quotation marks to indicate the spaces as fol-
lows: -f1"<path>"
l Self-extracting patch:
<path to patch .exe> -a -s
-f1<path to iss response file>
-f2<path to log file>
In silent mode, no confirmation windows of any kind are displayed. In this mode,
InstallShield suppresses all dialog boxes, including error messages and informational
message boxes.
4. To verify that the silent setup succeeded, open the setup.log file, and look at the Res-
ultCode value in the [ResponseResult] section. If the value is zero, the installation was suc-
cessful.
If a failure occurs in silent mode, Setup aborts just as if you clicked the Abort button in a
wizard dialog box during a normal installation. In this case, an error is written to the log file.
Note:
The installation typically fails for one of the following two reasons:
l An invalid path was specified on the command line.
l There were differences in the dialog box sequences between the recorded
response file and the current silent installation - for example, an additional mes-
sage appearing during the playback due to differences in the two computer sys-
tems.
To record in iss file for Install Shield to use when performing Modify Integration with
Ansys<v#>:
1. Use the following command line:

setup.exe -integratewithWB -r -f1<.iss response file>
Silent Codes
Result Description
Code
0 Success.
-1 General error.
-2 Invalid mode.

-3 Required data not found in the Setup.iss file.

-4 Not enough memory available.
-5 File does not exist.
-6 Cannot write to the response file.
-7 Unable to write to the log file.
-8 Invalid path to the InstallShield Silent response file.
-9 Not a valid list type (string or number).
-10 Data type is invalid.
-11 Unknown error during setup.
-12 Dialog boxes are out of order.
-51 Cannot create the specified folder.
-52 Cannot access the specified file or folder.
-53 Invalid option selected.
Performing a Silent Uninstall
You can perform a silent uninstall of the Ansys Electromagnetics Suite by entering the following
at the Windows command prompt:
"C:\Program Files\AnsysEM\v221\Win64\Uninstall\setup.exe" /run-
fromtemp /z suppressconfirmation /removeonly
Note:
Make sure there is a space before each forward slash (/).

PDF layout A-4

B - License hostid
Software licenses for each module of Ansys Electromagnetics products you purchased are con-
tained in one or more license files provided by ANSYS. Each license file requires one or more
license hostids, which are physical devices that contain a unique identification. License hostids
are always required for the license server, and they may also be required for each machine run-
ning Ansys software.
Each supported operating system supports certain hostids:
Operating Sys- Permitted hostids

tem
Windows l The ethernet address of a network interface card (MAC
address).
l Flexera FLEXid USB port hardware key.
l Disk serial number.
To obtain the disk serial number, open a command prompt.
Type vol <drive letter>:, for example vol C:
Linux l The ethernet address of a network interface card (MAC
address).
l Flexera FLEXid USB port hardware key.
This utility will provide the disk id by default:
http://www.ansys.com/Support/Licensing/Capture+License+Server+Information
Network Interface Card

A network interface card is a physical device used to connect to a network (also known as an eth-
ernet card). Each network interface card includes a unique ID that can be used as a license
hostid.
You can obtain an ethernet address to use as a valid license hostid. The method for doing so dif-
fers depending on whether you are running Windows or Red Hat Enterprise Linux.
Windows
To obtain an ethernet address as a valid license hostid when running Microsoft Windows:
2. Go to the command prompt.
License hostid B-1

3. Type ipconfig /all, and press Enter.

A listing of network interface cards is shown.
4. For a valid network interface card, look for the Physical Address line. The ethernet
address for that device is the value of the physical address, without dashes.
Note:
Other types of adapters, including Point-to-Point Tunneling Protocol (PPTP)

adapters and the Microsoft Loopback Adapter, may be listed here. These are not
valid for license hostids.
Linux
To obtain an ethernet address as a valid license hostid when running Red Hat Enterprise Linux:
2. Start a terminal session.
3. Type ip addr (normally located in the /sbin directory) to see a listing of all active network
devices.
4. Devices with an ethernet address show a Link encap value of Ethernet. The ethernet
address for each device is the value in the HWaddr field, without colons.
Hardware Key
A Flexera FLEXid hardware key may be provided to you by Ansys Electromagnetics as your
physical device. The license hostid of a hardware key is affixed to the hardware key itself. The
hostid is a 17- to 21-character value that begins with FLEXID=.
Installing a Hardware Key on a USB Port

Only a single device can be installed on each USB port.
License hostid B-2

License hostid B-3

PDF layout B-4

C - System Coupling with Maxwell

Enabling System Coupling with Maxwell
To enable coupling with Maxwell, the environment variable ANSYSEM_ROOT221 must be set
to the location of your Ansys Electromagnetics installation.
Note: The environment variable name is ANSYSEM_ROOT<major><minor>, where

<major> is the two digit major version number (the last two digits of the year); and
<minor> is the one digit minor version number. For example, for the Ansys Electronics
2022 R1 release, the environment variable name is ANSYSEM_ROOT22. For the Stu-
dent Version of the software, the variable name is ANSYSEM_
ROOTSV<major><minor>.
l For Windows, this environment variable is automatically set during the installation of the
Ansys Electromagnetics Suite (for example, C:\Program Files\AnsysEM\v221\Win64).
Note: The environment variable must be set on all hosts if the analysis is distributed to
multiple hosts. For Windows, this environment variable must generally be set as a Sys-
tem environment variable (not a user environment variable) for distributed analysis so
that it is set for the Ansoft RSM Service.
Enabling System Coupling with Maxwell C-1

AnsysEMInstallGuide-Windows

Uploaded by

Copyright:

Available Formats

AnsysEMInstallGuide-Windows

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AnsysEMInstallGuide-Windows

Uploaded by

Copyright:

Available Formats

Ansys Electromagnetics Suite 2022 R1

Windows Installation Guide

Copyright and Trademark Information

© 1986-2022 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

THIS Ansys SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE

U.S. Government Rights

information of ANSYS, Inc. and its subsidiaries and affiliates.

Conventions Used in this Guide

"Click Simulation > HPC Options"

information of ANSYS, Inc. and its subsidiaries and affiliates.

Getting Help: Ansys Technical Support

information of ANSYS, Inc. and its subsidiaries and affiliates.

1 - Getting Started 1-1

Installation Prerequisites 1-1

Ansys Electromagnetics Suite Software 1-1

License File 1-1

License Server 1-1

Firewall Exceptions 1-3

Windows Requirements 1-3

Additional Resources 1-3

2 - Installing Ansys Electromagnetics Suite Software 2-1

Obtaining a License File 2-1

Installing the Software 2-1

Integrating Ansys Electromagnetics Products with Ansys Workbench 2-6

Integration with Ansys Workbench during Ansys Electromagnetics Product Install-

Integration with Ansys after Ansys Electromagnetics Product Installation 2-7

3 - High Performance Computing 3-1

Distributing Analysis to Multiple Hosts 3-1

Distributing Analysis Across Platforms 3-2

Options for Distributed Analysis 3-2

Remote Simulation Manager (RSM) 3-3

When do you need RSM? 3-4

Installing RSM 3-4

information of ANSYS, Inc. and its subsidiaries and affiliates.

Changing the AnsoftRSMService Listening Port 3-7

AnsoftRSMService Configuration 3-7

Ansys Electromagnetics Desktop Configuration 3-8

Supported Job Schedulers 3-10

Custom Scheduler Integration 3-10

Running HPC Test Jobs on a Cluster 3-11

Non-distributed job 3-11

Non-MPI job distributed to multiple hosts 3-12

MPI job distributed to multiple hosts 3-13

Submitting and Running the Tests 3-13

Submitting and running a non-distributed job 3-15

Submitting and running a non-MPI job distributed to multiple hosts 3-16

Submitting and running an MPI job distributed to multiple hosts 3-17

Scheduler Specific Configuration and Testing 3-20

Windows HPC 3-20

Job Submission Host Configuration 3-20

Cluster Configuration Guidelines 3-20

Running Test Jobs 3-20

Non-distributed job 3-21

Non-MPI job distributed to multiple hosts 3-21

MPI job distributed to multiple hosts 3-22

IBM Platform LSF 3-22

Cluster Configuration Guidelines 3-22

Running Test Jobs 3-22

Non distributed job 3-23

Non-MPI job distributed to multiple hosts 3-23