JMAG Version 22.

2
User's Manual
Overview

JSOL Corporation
Issue date of 1st Edition: August 2023

 COPYRIGHTS
Copyright © 2023 JSOL Corporation All Rights Reserved.
• Information in this document is subject to change without notice.
• No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means electronic or
mechanical, including photocopying and recording for any purpose other than the purchaser’s personal use without the written per-
mission of JSOL Corporation.
JMAG Division
JSOL Corporation
Tokyo/ KUDAN-KAIKAN TERRACE 11th Floor, 1-6-5 Kudanminami, Chiyoda-ku, Tokyo 102-0074, Japan
Phone: +81(03)6261-7361 Phone (Support): +81(03)6261-7362 FAX: +81(03)5210-1142
Osaka/ Tosabori Daibiru Bldg. 2-2-4 Tosabori, Nishi-ku, Osaka 550-0001, Japan
Phone: +81(06)4803-5820 FAX: +81(06)6225-3517
Email: [email protected] URL: https://www.jmag-international.com/

 Trademarks
• JMAG and JMAG-RT are registered trademarks of JSOL Corporation.
• Abaqus, CATIA, SIMULIA and SOLIDWORKS are trademarks or registered trademarks of Dassault Systemes or its subsidiaries in
the United States and/or other countries.
• AMD and AMD Opteron is a trademark of Advanced Micro Devices, Inc.
• Amesim, LMS Virtual.Lab, NX, Parasolid, Siemens, Simcenter, Simcenter 3D, Solid Edge, and STAR-CCM+ are trademarks or reg-
istered trademarks of Siemens Industry Software Inc., or its subsidiaries or affiliates, in the United States and in other countries.
• CAPRI CAE Gateway is a registered trademark of CADNexus Inc. in the United States and other countries.
• Creo and Pro/ENGINEER are registered trademarks of PTC, inc.
• DXF and Inventor are trademark or registered trademark of Autodesk, Inc. in the United States and/or other countries.
• Excel, Microsoft, Visual C++, Windows, and Windows 10 are either registered trademarks of Microsoft Corporation in the United
States and/or other countries.
• Flexera Software and FLEXlm are registered trademarks of Flexera Software LLC in the United States and other countries.
• Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other
countries.
• LabVIEW is a registered trademark of National Instruments Corporation.
• Linux is a registered trademark of Linus Torvalds in the United States and other countries.
• LSF is a registered trademark of IBM Corporation in the United States, other countries, or both.
• MATLAB and Simulink are registered trademarks of The MathWorks, Inc.
• MSC NASTRAN is a trademark of MSC Software Corporation.
• NASTRAN is a registered trademark of the National Aeronautics and Space Administration.
• NX Nastran is an enhanced proprietary version developed and maintained by Siemens Product Lifecycle Management Software Inc.
• NVIDIA is a trademark or registered trademark of NVIDIA Corporation in the United States and/or other countries.
• OpenOffice.org and Apache OpenOffice are registered trademarks of the Apache Software Foundation.
• PSIM is a registered trademark of Powersim Inc.
• ROMAX is a trademark of Romax Technology, LTD.
• Tecplot is a registered trademark of Tecplot, Inc. in the United States and other countries.
• Trademark information for PowerCore, owned by ThyssenKrupp Electrical Steel GmbH.
• All other product and company names are trademarks, registered trademarks, or service marks of their respective companies, organiza-
tions, or holders.
• This document does not include the letters ® and TM.
CONTENTS

About This Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

About User’s Manual and JMAG Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Composition of User's Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Notation Conventions for the This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
JMAG Support Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Analysis Case Studies and Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
JMAG Website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
JMAG Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

JMAG Features and Basic Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

JMAG Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Analysis Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Geometry Creation or Import Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Mesh Generation Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Result Display Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Other Optional Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Script Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Coupled Analysis Feature with Third Party Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Basic Process of FEM Analysis Using JMAG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Pre-Analysis considerations and preparations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Creating input data for an analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Performing an analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Verifying analysis results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Post-analysis evaluation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Functions Limited by the OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Functions Not Supported in JMAG Linux Module Full Edition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Save Destination of User-registered Data (JMAG User Folder) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Default Path for JMAG User Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Data Stored in the JMAG User Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Changing JMAG User Folders Through Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Operations in Windows and Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Opening the Control Panel (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Starting the Application (Windows/Linux) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Running from the Windows [Start] Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Starting from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Finding OS Type and Version (Windows/Linux) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

3
JMAG Version 22.2 User's Manual
Overview

Finding Host Name, MAC Address, and IP Address (Windows/Linux). . . . . . . . . . . . . . . . . . . . . . . . . . 39

Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Getting a List of Port Numbers That are Being Used (Windows/Linux). . . . . . . . . . . . . . . . . . . . . . . . . 40
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Finding the Registry (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Setting Environment Variables (Windows/Linux) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

4
About This Edition

“JMAG User’s Manual Overview” explains the composition of the JMAG user's manual, the notation rules, and the
support information on the functions and features of each OS.
MEMO JMAG user's manual is divided into contents.
• “JMAG Installation Manual”.
• “JMAG User's Manual Screen Configuration Edition”
• “JMAG User's Manual Operations Edition”
• “JMAG User's Manual Parameter Explanation Edition”
• “JMAG User's Manual JMAG-Express, JMAG-RT, JMAG-RT Viewer Edition”
• “JMAG User's Manual Coupled Analysis Edition”
• “JMAG User's Manual Files Edition”
• “JMAG User's Manual Licenses”
• “JMAG User's Manual Scripts Edition” and “Script Help”.
• “JMAG User's Manual Analysis Guide”
• “JMAG User's Manual Iron Loss Formulas”

5
JMAG Version 22.2 User's Manual
Overview

6
About User’s Manual and JMAG Support

This chapter describes the user's manual and the contents for users provided by JMAG.

 Topics in This Chapter

• Composition of User's Manual (page 8)
• Notation Conventions for the This Manual (page 9)
• JMAG Support Contents (page 10)

7
JMAG Version 22.2 User's Manual
Overview

Composition of User's Manual

The user's manual consists of the following editions:

Overview This edition is the overview. The organization of the user's manual and the
conventions, and the functions included in JMAG in a list are shown.
There are restrictions on the functions that can be used depending on the
OS of the machine used, so check in advance.
In addition, the procedures to be performed on machine used, such as set-
ting environment variables, are described. Refer to this information as nec-
essary.
Screen Configuration The screen configuration, menus, and toolbar buttons of JMAG-Designer,
Circuit Editor, Graph Manager, Script Editor, Geometry Editor, Trans-
former Modeling, and JMAG-Scheduler are described.
Operations The operations of JMAG-Designer, JMAG-Scheduler, Geometry Editor,
and Transformer Modeling are described.
Parameter Explanation The parameters of JMAG-Designer, JMAG-Scheduler, Geometry Editor,
and Transformer Modeling are described.
JMAG-Express 21.2 The screen configuration, operation, and parameters of JMAG-Express
21.2 is described.
JMAG-Express Classic The screen configuration, operation, and parameters of JMAG-Express
Classic is described.
JMAG-RT The screen configuration, operation, and parameters of JMAG-RT is
described.
JMAG-RT Viewer The screen configuration, operation, and parameters of JMAG-RT Viewer
is described.
Coupled Analysis The physical quantities exchanged, notes, required settings, etc. when per-
forming coupled analysis using JMAG with software other than JMAG are
described.
Files A list of files that can be handled by JMAG and notes for each is presented.
Also included are descriptions for JMAG-Explorer, a tool for managing
files output from JMAG, SIMPLE FHI, an editing tool for JMAG input
files (JCF files), and JQUERY, a results extraction tool from JMAG results
files.
Licenses A JMAG license list is presented and tools related to licenses are described.

Scripts How to use scripts in JMAG-Designer, JMAG-Scheduler, and Geometry

Editor is explained.
Analysis Guide Basic knowledge for magnetic field analysis is presented.

Iron Loss Formulas Calculation formulas for iron loss analysis is presented.

8
 About Users Manual and JMAG Support

Notation Conventions for the This Manual

The notations in the JMAG User’s Manual follows the rules indicated below:

 Names of dialogs and menus

The names of dialogs, terms used for menu bars, project manager, and toolboxes are enclosed within
brackets followed by a control name (see Example 1). Depending on the sentence, however, the con-
trol name may be omitted (see Example 2).
• Example 1:
[Materials] dialog, [OK] button, [Magnetic Material] button.
• Example 2:
Click [Properties] under [Magnetic Properties] to open the [Database Array] dialog.

 Input value
The value specified in a text box is enclosed in double quotation marks ("").
Example:
Enter “0.0216” in the [Current] box.

 Unit
The unit of measurement for physical quantities is enclosed within parentheses ( ).
Example:
Select (mm) from the [Units] list.

 Operation from the menu

Some of the operations are performed from a command in a menu that has multiple layers. In this
manual, a right angle bracket (>) is used to show the procedure of selections to navigate to an item
within a multi-layered menu.
Example:

1. Select [File] > [Open] from the menu bar.

 Keyboard commands
Each key on the keyboard is indicated within brackets.
Example:
[Ctrl] key, [F1] key

9
JMAG Version 22.2 User's Manual
Overview

JMAG Support Contents

JMAG provides the following contents as support for users:
• Documents (page 10)
• Programs (page 10)
• Analysis Case Studies and Model Data (page 10)
• JMAG Website (page 11)
• JMAG Customer Support (page 11)

Documents

Installation Manual Describes the installation and settings of the license server which controls
JMAG-Designer and its licenses.
User’s Manual Describes setting parameters for JMAG-Designer and related products.

Programs

JMAG-Designer Help This is the help based on the above-mentioned user’s manual. The man-
ual can be viewed on the monitor screen while operating JMAG-
Designer.
To start the JMAG-Designer help, select [Help] > [Help] from the menu
bar.
Self Learning System This program is provided to learn procedures, from modeling to result
evaluation, for those using JMAG-Designer for the first time with the
goal of learning analysis techniques with hands-on JMAG-Designer oper-
ations. Two types of modes can be selected depending on available study
time.
See the following web page:
https://www.jmag-international.com/support/sls/index_en.html

Analysis Case Studies and Model Data

Application Note and Analysis case studies of JMAG. Consists of analysis data and explanatory
Application Catalog documents.
See the following web page:
https://www.jmag-international.com/catalog/
Function Tutorials Function Tutorials are available for use for each function (with sample
data included).
See the following web page:
https://www.jmag-international.com/tutorial/

10
 About Users Manual and JMAG Support

JMAG-RT Model Library RTT files that can be used on circuit simulators are provided. The RTT
file contains motor characteristic data extracted from JMAG FEA result
data.
See the following web page:
https://www.jmag-international.com/modellibrary/

JMAG Website
The JMAG website provides latest information on JMAG, FAQs, papers presented at the JMAG
Users Conference, and columns written by engineers. The latest versions of our products can also be
downloaded from here.
Please visit us on the web at:
https://jmag-international.com/

JMAG Customer Support

Please feel free to contact your distributor for questions regarding JMAG operations and the con-
tents of this document, for consultation on analyses you would like to conduct, licensing, and oth-
ers.

 JMAG Distributors Information

See the following web page:
https://www.jmag-international.com/aboutus/members/

 Before you contact JMAG customer support

Customers using LM-X license server

If you inform us of the license number when you contacting us, you are able to receive the support
smoothly. A license number is an 18-digit alphanumeric character (including symbols) assigned to a
license issued by JSOL. Each license is accompanied by a unique license number.
The license number can be confirmed by the following operation:

1. Start JMAG-Designer.

Windows 10:
i. Click the Start icon in Windows.
ii. Click [All apps].
iii. Click the JMAG-Designer icon.

Linux:
i. Execute the command for starting JMAG-Designer.
If the installation folder of JMAG-Designer is set to “INSDIR”, execute the following com-
mand (INSDIR=/home/JMAG-Designer222 etc.):
cd $ INSDIR
./designer

2. Select [Help] > [About] from the menu bar.

11
JMAG Version 22.2 User's Manual
Overview

The [Version Information] dialog is displayed.

The alphanumeric characters starting from #L displayed on the right side of [License Number]
are the your license number (“#L_0123456_7890123” in the example below). Please tell support
here.

Customers using FLEXlm license server

If you inform us of the license ID when you contacting us, you are able to receive the support
smoothly. The license ID is notified to the license administrator when the license is issued.

12
JMAG Features and Basic Workflow

This section describes the products offered by JMAG:

• JMAG-Designer:
This is the primary JMAG program. From electromagnetic field to thermal and structural, JMAG-Designer
covers a wide variety of analyses, and has advanced modeling functions and various result analysis features.
JMAG-Designer comes with the following functions:
• Geometry Editor
• Transformer Modeling
• Circuit Editor
• Graph Manager
• Script Editor
• JMAG-Express
• JMAG-Scheduler
JMAG-Designer also comes with the following programs:
• JMAG-Express 21.2
• JMAG-Express Classic
• JMAG-RT
• JMAG-RT Viewer
• JMAG-Explorer
The following programs are offered separately from JMAG-Designer:
• JMAG-Express Online

 Topics in This Chapter

• JMAG Features (page 14)
• Analysis Feature (page 14)
• Geometry Creation or Import Feature (page 17)
• Mesh Generation Feature (page 19)
• Result Display Feature (page 19)
• Other Optional Features (page 20)
• Tools (page 20)
• Script Feature (page 21)
• Coupled Analysis Feature with Third Party Software (page 22)
• Basic Process of FEM Analysis Using JMAG (page 23)
• Pre-Analysis considerations and preparations (page 23)
• Creating input data for an analysis (page 24)
• Performing an analysis (page 25)
• Verifying analysis results (page 25)
• Post-analysis evaluation (page 25)

13
JMAG Version 22.2 User's Manual
Overview

JMAG Features
• Analysis Feature (page 14)
• Geometry Creation or Import Feature (page 17)
• Mesh Generation Feature (page 19)
• Result Display Feature (page 19)
• Other Optional Features (page 20)
• Tools (page 20)
• Script Feature (page 21)
• Coupled Analysis Feature with Third Party Software (page 22)

Analysis Feature
The following analysis functions (solvers) come with JMAG:
• Magnetic Field Analysis
• Static analysis (3D, 2D, axisymmetric):
A magnetic field static analysis is used when an analysis target does not have time-varying
phenomena such as motion and current variations.
• Transient analysis (3D, 2D, axisymmetric):
A magnetic field transient analysis is used when an analysis target has time-varying phenom-
ena such as motion and current variations.
• Frequency analysis (3D, 2D, axisymmetric):
A magnetic field frequency analysis is used when the current (voltage) varies sinusoidally with
time at a single frequency.
• Iron loss analysis (3D, 2D, axisymmetric):
Use the iron loss analysis solver to calculate iron loss based on magnetic flux density distribu-
tion data included in the magnetic field analysis results.
• Thermal Analysis
• Steady state analysis (3D, 2D):
A thermal steady state analysis is used when the temperature distribution does not vary with
time.
• Transient state analysis (3D, 2D):
A thermal transient state analysis is used when the temperature distribution varies with time.
• Structural Analysis
• Static analysis (3D, 2D):
A structural static analysis is used to analyze the displacement and stress when a constant
static load is applied.
• Eigenmode analysis (3D, 2D):
A structural eigenmode analysis is used to analyze the eigen value and eigenvector that are
determined by the geometry and rigidity of a structure.
• Frequency analysis (3D, 2D):
A structural frequency analysis is used to analyze the response of a structure that is constantly
vibrated.
• Modal transient analysis (3D, 2D):
A structural analysis is run when obtaining displacement or stress specified with load that

14
 JMAG Features and Basic Workflow

changes size in time. This method is effective for calculations with large scale and many anal-
ysis steps.
• Direct transient analysis (3D, 2D):
A structural analysis is run when obtaining displacement or stress specified with load that
changes size in time. This method is effective for calculations with small scale and few analysis
steps.
• Electric Field Analysis
• Static analysis (3D, 2D, axisymmetric):
Analyzes electric field analysis for the electric charge and electric potential that does not
change in time.
• Frequency analysis (3D, 2D, axisymmetric):
Analyzes electric field analysis for single waveform that has electrical potential which changes
in time by sinusoidal waveform.
• Current distribution analysis (3D):
Analyzes electric field analysis for obtaining the current distribution in a conductor deter-
mined by the electric conductivity or the electric potential.
• Thermal Stress Analysis
• Steady state analysis (3D):
Run a thermal stress analysis while in a steady state. A steady state means one where tempera-
ture distribution variations cannot be seen over the passage of time.
• Transient state analysis (3D):
Run a thermal stress analysis in a transient state. A transient state means one where tempera-
ture distribution is transient until it is steady.
• Transformer Analysis:
Runs electromagnetic field analyses specialized for transformers, reactors, and inductors.
• Transient analysis (3D, 2D):
Analyzes the transitive response to variations in the power supply.
• Frequency analysis (3D, 2D):
Analyzes the response to variations of a single frequency power supply.
• Integration Analysis:
Runs analysis of control circuits using multiple JMAG-RT models.
• Transient analysis

 Coupled analysis

One-way coupled analysis for identical solvers (or identical analysis solvers)
The following analyses are possible by combining multiple analyses and features:
• Magnetic field analysis with magnetization
• Magnetic field analysis of multiple stages using the Vector Potential Boundary condition
• Magnetic field analysis using the Frozen Permeability condition
• Magnetic field analysis using high-speed functions in eddy current calculations

15
JMAG Version 22.2 User's Manual
Overview

One-way coupled analysis combining different solvers

Analysis is run in one of the solvers, and the results are used as input values in the other solver.
In the following case, the results of magnetic field analysis are used in thermal analysis. The thermal
analysis results do not affect the magnetic field analysis results.
Handling over of data

Result of magnetic Result of thermal

Magnetic field analysis field analysis Thermal analysis analysis

Single analysis Single analysis

Example: One-way coupled analysis (magnetic field analysis and thermal analysis)

• Magnetic field transient analysis, magnetic field frequency analysis, iron loss analysis => Thermal
analysis
• Magnetic field static analysis => Structural static analysis
• Magnetic field transient analysis => Structural static analysis, structural frequency analysis, struc-
tural modal transient analysis, structural direct transient analysis
• Magnetic field frequency analysis => Structural frequency analysis
• Magnetic field transient analysis, magnetic field frequency analysis, Iron loss analysis => Thermal
stress analysis
• Thermal analysis => Magnetic field static analysis, magnetic field transient analysis, magnetic
field frequency analysis
• Thermal analysis => Current distribution analysis
• Thermal analysis => Structural analysis
• Structural static analysis, structural modal transient analysis, structural direct transient analysis
=> Magnetic field static analysis, magnetic field transient analysis, magnetic field frequency anal-
ysis, iron loss analysis
• Structural static analysis, structural modal transient analysis, structural direct transient analysis
=> Thermal transient state analysis
• Current distribution analysis, electric field frequency analysis => Thermal analysis
• Current distribution analysis, electric field frequency analysis => Thermal stress analysis
• Thermal stress analysis=> Magnetic field static analysis, magnetic field transient analysis, mag-
netic field frequency analysis
• Thermal stress analysis => Current distribution analysis

16
 JMAG Features and Basic Workflow

Direct coupled analysis

Analysis in multiple solvers are run alternately by transferring the results between them.
In the following case, the magnetic field analysis and the thermal analysis are run alternately. The
results of thermal analysis are used as input values in magnetic field analysis, and the results of mag-
netic field analysis are used as input values in thermal analysis.

Result of magnetic
Magnetic field analysis field analysis

Analysis is conducted by repeating

(automatic) hand over data.

Result of thermal
Thermal analysis
analysis

Example: Direct coupled analysis (magnetic field analysis and thermal analysis)

• Direct coupled analysis using two solvers (two-way coupled analysis)

• Magnetic field transient analysis, magnetic field frequency analysis <=> Thermal transient
state analysis
• Magnetic field transient analysis, magnetic field frequency analysis <=> Thermal stress tran-
sient state analysis
• Magnetic field transient analysis, magnetic field frequency analysis <=> Structural direct tran-
sient analysis
• Thermal transient state analysis <=> Structural direct transient analysis
• Thermal transient state analysis <=> Current distribution analysis
• Direct coupled analysis using three or more solvers
• Magnetic field analysis, thermal analysis, structural analysis

Geometry Creation or Import Feature

 Geometry Editor
This section describes creating CAD models (2D, 3D) or mesh models in a Geometry Editor for
JMAG-Designer.
MEMO CAD models including beams and shells are supported by the structural analysis and electric
field analysis but not supported by the magnetic field analysis, thermal analysis and thermal stress analy-
sis.
MEMO Geometry Editor supports 3D mouse operations.

 JMAG-Express 21.2 and JMAG-Express Classic

2D motor models can be created using the JMAG-Express.
MEMO A study for a magnetic field analysis is created for the model that is imported from JMAG-
Express to JMAG-Designer.
MEMO Geometries created on JMAG-Express can be edited by the Geometry Editor in JMAG-
Designer.

17
JMAG Version 22.2 User's Manual
Overview

 Transformer Modeling Tool

3D models of a transformer can be created using the Transformer Modeling tool.

 Coupling with commercial CAD software

JMAG-Designer can be linked with commercial CAD software. The geometry can be changed while
retaining the material and condition settings in JMAG-Designer. Materials and conditions do not
need to be set every time the geometry is changed.
The following CAD software can be linked with JMAG-Designer:
• CATIA V5
• Creo Parametric
• NX
MEMO JMAG-Designer supports 3D mouse operations.
MEMO For details about CAD software that is compatible with JMAG, see the JMAG website (https://
jmag-international.com/).

 Importing CAD data

CAD models created using a CAD software of other manufactures can be imported. The types of
files that can be imported are as follows:
• ACIS(.sat, .sab)
• IGES(.iges, .igs)
• CATIA V4(.model)
• CATIA V5(.CATpart, .CATProduct)
• Creo Parametric(Pro/ENGINEER)(.prt, .asm, .prt., .asm.)
• NX(.prt)
• Parasolid(.x_t, .xmt_txt, .x_b, .xmt_bin)
• SOLIDWORKS(.sldprt, .sldasm)
• SolidEdge(.par, .asm, .psm)
• STEP(.stp, .step)
• Inventer(.ipt, .iam)
MEMO CAD models including beams and shells are supported by the structural analysis and electric
field analysis but not supported by the magnetic field analysis, thermal analysis, and thermal stress analy-
sis.
MEMO The latest information related to versions of CAD files that can be opened in JMAG is pub-
lished in the JMAG website (https://www.jmag-international.com/).

 Importing mesh data

Mesh models created with analysis software produced by another manufacture can be imported.
The types of files that can be used to import a CAD is as follows:
• Nastran file (.nas, .bdf )
• Universal file (.unv)
MEMO The element geometry as well as mapping between each element and each part can be imported
when exporting a mesh model using analysis software produced by another manufacturer. However, the
material and condition settings cannot be imported.

18
 JMAG Features and Basic Workflow

Mesh Generation Feature

 Mesh generation in the JMAG-Designer (Automatic mesh generation)

This function is able to create mesh easily. A variety of conditions such as Motion condition, Torque
condition and Slide condition are automatically set when running a magnetic field analysis. These
settings are less likely to cause an error when they are set automatically.

 Mesh generation in the Geometry Editor (Manual mesh generation)

Mesh that can be specified in detail for geometry, element, and type (for 2D: triangular and quadri-
lateral elements, for 3D: pentahedron and hexahedron). However, an advanced knowledge in ana-
lyzing mesh is needed to create a proper mesh for analysis by the user.
MEMO A tetrahedron or four-sided pyramid model may be created when a model is revolved while a
3D mesh is being created.

Result Display Feature

 Verifying numeric value results for physical quantities in a table

Numeric value changes for physical quantities can be viewed in a table. Not only can the values for
entire models and single parts can be viewed in a table, but so can the values for specific elements
and nodes. The following items can also be viewed in a table:
• Magnetic flux linking a specific face
• Voltage of a terminal or electric potential difference between two terminals in an electric circuit
• Contact angle of a brush for an electric circuit
• Temperature of a terminal or temperature difference between two terminals in a thermal circuit

 Viewing numeric value results of physical quantities in a graph

Numeric value changes for physical quantities can be viewed in a graph. There are the following
types of graphs:
• History graph:
Displays time series changes for physical quantities in a graph.
• Section graph:
Displays physical quantities on a line (straight line or arc) specified inside the analysis target as a
graph.
• Section graph for any regions that include air regions:
Displays physical quantities on a line (straight line or arc) specified inside the any regions as a
graph.

 Visually verifying physical quantity distribution and flow

Physical quantities can be viewed with the following methods:
• Contours
• Vectors
• Flux lines

The following functions can also be applied to a view:

• Step/phase specification

19
JMAG Version 22.2 User's Manual
Overview

• Animations
• Cut planes
• Model copies
• View original model
• Scale

 Result processing feature

• User components:
Creates user-defined output items by adding calculation processing to output physical quantities.
• Post-calculation script:
Automates calculation processing for output physical quantities using the script function.

Other Optional Features

 Analysis template
Uses setting information such as materials and conditions included in studies as a template. Data
used as a template can be applied to models with different geometry.

 Parametric analysis
Evaluates the effects of the parameters on the analysis results by changing one or more parameters
included in a study.

 Optimization
Derives design proposals that optimize the specified objective functions.

Tools
The following tools are included with JMAG:

 JMAG-Explorer
This tool manages JPROJ files, JCF files, and JPLOT files output from JMAG-Designer in a data-
base. With this tool, JMAG files can be browsed in a list.

 JMAG-Express 21.2 and JMAG-Express Classic

With this tool, 2D motor models can be created and evaluated.

 Motor Inductance Calculation

With this tool, d-q axis inductance for a three-phase PM synchronous motor model can be com-
puted using a magnetic field analysis JCF file.

 Bus Bar Inductance Calculation

With this tool, self and mutual inductance of conductors can be computed using the JCF file from a
magnetic field analysis or from a current distribution analysis.

20
 JMAG Features and Basic Workflow

 Coil Inductance Calculation

With this tool, inductance in a model containing coils, such as in a transformer model, can be com-
puted using a magnetic field analysis JCF file.

 Field Integral Calculation

With this tool, the magnetic flux density (or electric field) at a specified point can be computed by
integration, using magnetization vectors, current density, beam current, or charge data included in
magnetic field analysis (or electric field analysis) results.

 Force Export for Virtual.Lab

With this tool, electromagnetic force computed from JMAG magnetic field transient analysis can be
output to a file that can be used in vibration/noise analysis in LMS Virtual.Lab.

 Force Mapping for Abaqus

With this tool, electromagnetic and magnetostrictive force computed from JMAG magnetic field
analysis can be mapped to the input file for a structural analysis in the nonlinear finite element anal-
ysis program Abaqus.

 Heat Generation Mapping for Abaqus

With this tool, generated heat computed from JMAG magnetic field analysis and iron loss analysis
can be mapped to the input file for a heat transfer analysis in the nonlinear finite element analysis
program Abaqus.

 Exporting Multi-purpose Files

With this tool, mesh data, analysis data (time, frequency, etc.), and results data (physical quantities)
created in JMAG can be exported to a Nastran file (or CSV file or Universal file). The exported file
can be used with simulation software other than JMAG.
Results data from simulation software other than JMAG can be mapped to a JMAG input file.

 Hysteresis Curve Creator

With this tool, hysteresis curve data for use in JMAG magnetic field analysis based on the CSV file
containing measurement data of magnetic properties can be created.

 JMAG-RT
With this tool, motor characteristics taking into account for example magnetic saturation in JMAG
FEA can be computed and the results in a file format (.rtt) can be exported for circuit simulators.
Using an exported RTT file, high-speed control circuit simulation can be executed while taking into
account motor characteristics.

 JMAG-RT Viewer
With this tool, outputted RTT file data can be checked and torque speed curves and efficiency maps
can be created based on the outputted RTT file.

Script Feature
With exception to a few tools, all the functions in JMAG-Designer can be executed with scripts.
GUI operations can also be automatically recorded to a script in JMAG-Designer.

21
JMAG Version 22.2 User's Manual
Overview

MEMO VBScript, JScript, and Python are supported in JMAG.

Coupled Analysis Feature with Third Party Software

JMAG supports coupled analyses with the following simulation software. The following are exam-
ples of well-known simulation software:
• Abaqus:
The following methods are available when coupling JMAG and Abaqus:
• Run one-way coupled analysis using the Stress Distribution condition
• Run one-way coupled analysis using the Multi-Purpose File Export Tool
• Run one-way coupled analysis using the Force Mapping Tool for Abaqus
• Run one-way coupled analysis using the Heat Generation Mapping Tool for Abaqus
• Run direct coupled analysis using the Stress Distribution condition, Displacement condition,
or Temperature Distribution condition
MEMO Coupled analysis using JMAG, Abaqus, and STAR-CCM+ is also possible. For details,
please contact JMAG support.
• Simulink:
The following methods are available when linking JMAG and Simulink:
• Method to directly link magnetic field analysis of JMAG and Simulink using the External
Circuit Link condition
• Method to use an RTT file exported with JMAG-RT or JMAG-Express in Simulink
• PSIM:
The following methods are available when linking JMAG and PSIM:
• Method to directly link magnetic field analysis of JMAG and PSIM using the External Cir-
cuit Link condition
• Method to use the analysis results of PSIM in JMAG
• Method to use an RTT file exported with JMAG-RT or JMAG-Express in PSIM
• Virtual.Lab:
JMAG and Virtual.Lab can be linked with the following methods:
• With the electromagnetic force setting tool for Virtual.Lab, use electromagnetic force
exported from a JMAG-Designer magnetic field transient analysis in a vibration/noise analy-
sis using LMS Virtual.Lab developed by LMS International.
• STAR-CCM+:
JMAG and STAR-CCM+ can be linked with the following methods:
• Perform a direct coupled analysis using the Stress Distribution condition, Displacement con-
dition, or Temperature Distribution condition.

22
 JMAG Features and Basic Workflow

Basic Process of FEM Analysis Using JMAG

The basic process of analysis using JMAG is shown below:

1. Pre-Analysis considerations and preparations (page 23)

2. Creating input data for an analysis (page 24)
3. Performing an analysis (page 25)
4. Verifying analysis results (page 25)
5. Post-analysis evaluation (page 25)

Pre-Analysis considerations and preparations

Before using JMAG, consider the following points and make the following preparations:

 Clarifying the analysis objective

Prior to performing analysis, clarify the analysis objective and decide the conditions and materials to
be set.

 Preparing data for analysis

Prepare data required for the analysis, such as current values.

 Considerations and preparations for improving analysis efficiency

Planning and preparation are required to get analysis results in a shorter amount of time according
to the situation such as when numerous calculations need to be run with JMAG.

Expanding analysis resources

Prepare the environment to run a distributed calculation using multiple machines. For example, set-
ting up a remote system and an environment to perform parallel computing. Consider whether or
not to use a GPU.
MEMO The parallel computing function and functions to use GPU require specialized licenses sold sep-
arately from JMAG-Designer.

Modeling
• Simplify the parts of geometry which have little effect on the analysis results. For example,
remove fillets of the corner of parts.
• Limit the scope of the analysis to just one section by accounting for the geometry of the analysis
target and periodicity of distribution amounts and using boundary conditions.
• Account for the geometry of the analysis target and the periodicity of distribution amounts, and
use 2D geometry instead of 3D geometry if possible.
MEMO In JMAG, a “full model” refers to modeling the entire geometry of the analysis target, and a
“partial model” refers to modeling only one part of the analysis target.
MEMO Magnetic field analyses and iron loss analyses support both 3D and 2D geometry (cross-sections
parallel to the center axis, cross-sections horizontal to the center axis). Structural analyses support both
3D and 2D geometry. Thermal, electric field, and thermal stress analyses support 3D geometry only.

23
JMAG Version 22.2 User's Manual
Overview

Reducing the number of elements

Combine multiple mesh generation functions to evaluate whether or not the number of elements
can be adjusted so there isn't an excessive amount. For example, using an extrusion mesh to create
coarse meshes in the axial direction.
MEMO A sudden change in element size deteriorates calculation accuracy. Please be careful to make a
gentle change.

Creating input data for an analysis

Use JMAG-Designer’s pre-processor function to create input data for analysis.

 Geometry preparation
Use one of the following methods to import geometry for the analysis target into JMAG-Designer:
• Create geometry with a tool that comes with JMAG-Designer (Geometry Editor, JMAG-
Express, Transformer Modeling tool) and import it into JMAG-Designer.
• Save a CAD model created with commercial CAD software, such as AutoCAD, CreoParametric,
and SOLIDWORKS to a file, and import it into JMAG-Designer.
• Save a mesh model created with commercial simulation software in a file and import it into
JMAG-Designer.

 Creating a study
Select an analysis type when creating a study. A study controls settings for materials, conditions, and
other settings related to the model. Set the materials and conditions after the study is created.

 Study property settings

Set the analysis time/frequency, select the solution method, and select the physical quantities to be
output to the result file.

 Material settings
Determine the material properties (magnetic, thermal, mechanical, electrical, and iron loss) of each
part. Commercially available material data provided by material manufacturers can also be used.

 Circuit analysis settings

Electrical, thermal, and control circuits can be created and coupled with FEA.

 Analysis condition settings

Set boundary conditions, current conditions, motion conditions, output conditions, linkage condi-
tions, and modeling conditions. If a circuit is created, the output from the circuit analysis can be
used as input for FEA.

 Creating a mesh model

A CAD model is divided into units called “elements”. The number of elements and the state of the
mesh affect calculation accuracy and time. Many options are available to fine-tune the mesh. Con-
sider the periodicity and symmetry of the model to determine which option to use.

24
 JMAG Features and Basic Workflow

Performing an analysis
The input data created is then solved using JMAG's solver functions. The following execution
methods are available:
• Foreground execution with JMAG-Designer:
JMAG-Designer manages and executes the calculations. During foreground execution, it is not
possible to exit JMAG-Designer or perform other operations in JMAG-Designer.
• Background execution using JMAG-Scheduler:
JMAG-Scheduler is a tool that manages and executes calculations on behalf of JMAG-Designer.
• Using a local machine for calculations
• Using SSH remote machines for calculations
• Using remote machines managed by JMAG-RemoteSystem for calculations
• Background execution by directly executing the solver program (command line execution)
• Using a local machine for calculations
• Using SSH remote machines for calculations
• Background execution using a commercially available job scheduler system
• Using remote machines managed by a job scheduler system for calculations

Verifying analysis results

Use JMAG-Designer’s post-processor function to display physical quantity distributions as images
and output numeric values as tables and graphs.
Verify the validity of the results output by JMAG at this time. Even if the input values are invalid
due to unit settings or an incorrectly set decimal place, a calculation error will not occur, and results
for those incorrect values are output. Calculation converges and input values used in a calculation
can be viewed in a solver report.
When the results are not valid and incorrect input values cannot be found, please contact your dis-
tributor.

Post-analysis evaluation
Use results calculated with JMAG to evaluate your product.
Using the parametric analysis function and optimization function allows specific objectives and
input values to be narrowed down, and by combining multiple solver functions to perform a cou-
pled analysis, effects to multiple fields can be accounted for.

25
JMAG Version 22.2 User's Manual
Overview

26
Functions Limited by the OS

JMAG functions can be separated into two groups: pre/post, which includes analysis model creation and view-
ing results, and the solver, which runs the analysis engine. These functions are supported in Windows or Linux
as an operating environment.
Select one of the following operating environments:
• In Windows, use a JMAG module that includes both pre/post and solver functions (JMAG Windows mod-
ule).
• In Linux, use a JMAG module that includes both pre/post and solver functions (JMAG Linux module).
Like the JMAG Windows module, the JMAG Linux module has functions that cannot be used. Read the fol-
lowing information prior to selecting an environment to run JMAG in.
MEMO If JMAG is installed on a machine on the same network as the local machine, that machine can be used for
analysis and mesh generation. This is called “remote execution”.
For remote execution, use the JMAG Remote System or a remote machine (or third-party job scheduler) using SSH.
Which one should be used depends on the OS environment of the local and remote machines.

 Topics in This Chapter

• Functions Not Supported in JMAG Linux Module Full Edition (page 28)

27
JMAG Version 22.2 User's Manual
Overview

Functions Not Supported in JMAG Linux Module Full Edition

The following functions are not supported when using JMAG Linux module Full Edition:

 List of unsupported functions

Unsupported function Remark
VB Script and Jscript scripting languages Python can be used.
Script execution from third-party programs Using Windows COM is not supported.
Script help, self learning system (SLS) Running script help or the self learning sys-
tem is not supported.
Help buttons in each setting panel cannot
be used.
Linking with other vendor's CAD software CAD linking that uses CAPRI is not sup-
ported.
Importing CAD files The following files can be imported:
• CATIA version 5 files • ACIS files
• Inventor files • CATIA version 4 files
• Creo Parametric files
• IGES files
• NX files
• Parasolid files
• SolidEdge files
• SOLIDWORKS files
• STEP files
Exporting animations Exporting Windows AVI format (.avi) is
not supported.
Magnetic field analysis New GPU solver can be used.
• Previous GPU solver
• Snapshot Calculation function
Tools The following tools can be used:
• Motor Inductance Calculation • JMAG-RT
• Bus Bar Inductance Calculation • JMAG-RT Viewer
• Coil Inductance Calculation • JMAG-Express
• Field Integral Calculation • Hysteresis Curve Creator
• Force Mapping for Abaqus
• Heat Generation Mapping for Abaqus Some of the functions for the multi-pur-
• Multi-Purpose File Export pose file export tool can be performed from
the command line.
Tools for license Running each of these tools is not sup-
• License selection tool ported.
• JMAG License Center (for LM-X)
• License setting tool (for FLEXlm)
• License borrowing tool (for FLEXlm)

28
Save Destination of User-registered Data (JMAG User
Folder)

Data-created by the user such as material and circuit can be registered in JMAG-Designer. The registered data is
stored in a designated folder. This designated folder is called the JMAG user folder.
This chapter describes how to change the path of the JMAG user folder.

 Topics in This Chapter

• Default Path for JMAG User Folder (page 30)
• Data Stored in the JMAG User Folder (page 31)
• Changing JMAG User Folders Through Environment Variables (page 33)

29
JMAG Version 22.2 User's Manual
Overview

Default Path for JMAG User Folder

The default for the JMAG user folder is as follows:
• Windows10:
C:\Users\(login user name)\

• Linux:
(home directory)/(login user name)/

30
 Save Destination of User-registered Data (JMAG User Folder)

Data Stored in the JMAG User Folder

Item Description
JMAG-Designer tempo- Temporary files created by JMAG-Designer.
rary files • Default path:
(JMAG user folder)\JMAGDesignerTemp
Geometry Editor tempo- Temporary files created by Geometry Editor.
rary files • Default path:
(JMAG user folder)\ModellerTemp
Custom materials Material data created by the user. Custom materials are displayed in the
[Custom Materials] folder of the [Materials] tab in the JMAG-Designer
[Toolbox].
• Default path:
(JMAG user folder)\JMAG Designer
Custom scripts Scripts created by the user. Custom scripts are displayed in the [Custom]
folder of the [Script] tab in the JMAG-Designer [Toolbox].
• Default path:
(JMAG user folder)\JMAG Designer\Scripts
Custom post calculation Scripts created by the user. Custom post calculation scripts are displayed
scripts in the [Post Calculation Custom] folder of the [Script] tab in the JMAG-
Designer [Toolbox].
• Default path:
(JMAG user folder)\JMAG Designer\PostCalculationScripts
Custom equations Equations created by the user. Custom equations are displayed in the
[Custom] folder of the [Equations] tab in the JMAG-Designer [Tool-
box].
• Default path:
(JMAG user folder)\JMAG Designer\Equations
Custom analysis tem- Analysis templates created by the user. Custom analysis templates are
plates displayed in the [Custom] folder of the [Analysis Templates] tab in the
JMAG-Designer [Toolbox].
• Default path:
(JMAG user folder)\JMAG Designer\Templates
Custom geometries Shape data created by the user. Custom geometries are displayed in the
[Custom Geometry] folder of the [Geometry Library] tab in the Geom-
etry Editor [Toolbox].
• Default path:
(JMAG user folder)\JMAG Designer\Modeller\Geometries
SSH remote machine SSH remote machine settings created by the user. SSH remote machine
settings settings are displayed in the [SSH/Execution Script] setting panel of the
[Preferences] dialog in JMAG-Designer.
• Default path:
(JMAG user folder)\JMAG Designer\RemoteMachines\222

31
JMAG Version 22.2 User's Manual
Overview

Item Description
Macro components in Macro components registered by the user. The macro components reg-
Circuit Library istered in the library are displayed in the [Libraries] tab of the [Tool
Box] and the [Macro Component List] dialog.
• Default path:
(JMAG user folder)\JMAG Designer\SubCircuit
Circuits in Circuit Circuits registered by the user. The circuits registered in the library are
Library displayed in the [Libraries] tab of the [Tool Box].
• Default path:
(JMAG user folder)\JMAG Designer\Circuit

32
 Save Destination of User-registered Data (JMAG User Folder)

Changing JMAG User Folders Through Environment Variables

The environment variable JMAG_HOME_PATH can be used to change the JMAG user folder
from the JMAG default to a specified folder.

 Notes
• JMAG_HOME_PATH cannot be used to change the save destination folder of the JMAG-RT
Library Manager file (.jrt). The save destination folder of the JMAG-RT Library Manager file
can be changed from the [Preferences] button in JMAG-RT Library Manager.
MEMO JMAG-RT Library Manager file is a file that contains the parameter information for creating
JMAG-RT models. The JMAG-RT library manager list shows the information loaded from the
JMAG-RT Library Manager file in the JMAG user folder.

 Environment Variable JMAG_HOME_PATH

For information on how to set the environment variable, see “Setting Environment Variables (Win-
dows/Linux)” on page 42.

Environment variable Value Description

JMAG_HOME_- Full path of JMAG • Before setting this environment variable, create a
PATH user folder folder to be the JMAG user folder.
• JMAG users must have access to the folder specified
in the JMAG user folder.
Setting example:
JMAG_HOME_PATH=C:\home

33
JMAG Version 22.2 User's Manual
Overview

34
Operations in Windows and Linux

Settings such as environment variables using Windows GUI or Linux commands may be necessary when using
JMAG. Here we will explain several operation methods that can be run in Windows and Linux.
If you are a Windows user, see the following explanation that matches with the currently used version.

 Topics in This Chapter

• Opening the Control Panel (Windows) (page 36)
• Starting the Application (Windows/Linux) (page 37)
• Finding OS Type and Version (Windows/Linux) (page 38)
• Finding Host Name, MAC Address, and IP Address (Windows/Linux) (page 39)
• Getting a List of Port Numbers That are Being Used (Windows/Linux) (page 40)
• Finding the Registry (Windows) (page 41)
• Setting Environment Variables (Windows/Linux) (page 42)

35
JMAG Version 22.2 User's Manual
Overview

Opening the Control Panel (Windows)

1. Click the [Start] icon in Windows.
2. Click [Windows System] > [Control Panel].

MEMO Or, [the dialog can be opened by selecting [Control Panel] from a menu that is displayed by
holding down the [Windows] key on the keyboard and pressing the [X] key.

36
 Operations in Windows and Linux

Starting the Application (Windows/Linux)

• Running from the Windows [Start] Menu (page 37)
• Starting from the Command Line (page 37)

Running from the Windows [Start] Menu

1. Click the [Start] icon in Windows.
2. Click one of the application icons.

Starting from the Command Line

Examples of JMAG-Designer is listed below.

 Windows (using command)

1. Execute the command to run JMAG-Designer.

If the JMAG-Designer installation folder is set to INSDIR, execute the following command:
(INSDIR=C:\Program Files\JMAG-Designer22.2, etc.).
cd $INSDIR
designer.exe

File paths with spaces need to be enclosed with double quotation marks (").
For details on JMAG-Designer startup command options, see “Screen Configuration Edition”.

 Linux (using command)

1. Execute the command to run JMAG-Designer.

If the JMAG-Designer installation folder is set to INSDIR, execute the following command:
(INSDIR=/home/JMAG-Designer22.2, etc.)
cd $INSDIR
./designer

For details on JMAG-Designer startup command options, see “Screen Configuration Edition”.
The path to the library and a symbolic link must be set every time the terminal is run. Therefore,
run the following commands during the first startup from the terminal. Executing the setenv
script file specifies path to the library.
cd $INSDIR
source setenv
./designer

The setenv script file is a file with the setting commands for environment variables written with a
bash shell. When running the setenv command with the csh shell, the export command written
in the file needs to be changed to the setenv command. For details on changing to the setenv
command, see “Setting Environment Variables (Windows/Linux)” on page 42.

37
JMAG Version 22.2 User's Manual
Overview

Finding OS Type and Version (Windows/Linux)

OS type and version information are required at the time a license is requested. Additionally, if there
is an issue with JMAG, this information may be requested by us in order to investigate and trouble-
shoot its cause.
• Windows (page 38)
• Linux (page 38)

Windows
1. Open the Windows Control Panel.
See “Opening the Control Panel (Windows)” on page 36.
2. Click [System].
MEMO Click [System] after clicking [System and Security] when category display is applied to the
control panel.
3. The OS type and version are shown in [Windows Edition].

Linux

 Red Hat Enterprise Linux

1. Run the following command:

cat /etc/redhat-release

 SUSE Linux Enterprise

1. Run the following command:

cat /etc/SuSE-release

38
 Operations in Windows and Linux

Finding Host Name, MAC Address, and IP Address (Windows/Linux)

The host name and Mac address are required at the time a license is requested. Additionally, the host
name and IP address are required when specifying a license server or remote management server for
reference by a client.
• Windows (page 39)
• Linux (page 39)

Windows
1. Start the Windows command prompt.
See “Starting the Application (Windows/Linux)” on page 37.
2. Enter the following command, and then press the [Enter] key:
ipconfig /all

[Hostname], [Physical address] (MAC address), [IPv4 address]/[IPv6 address] and others, net-
work in-formation will be displayed.
When requesting license issuance, please fill in the license sheet with information displayed in
the [hostname] and [Physical address]. If multiple addressed are displayed under [Physical
address], any of the addresses displayed can be used without a problem but, usually, it is best to
tell us the ethernet address.

Linux
1. Run the following command:
• Host name
uname -n

• MAC address and IP address

/sbin/ifconfig -a

Executing the command above displays information for the interface. The “HWaddr” column
corresponds to the MAC address.

39
JMAG Version 22.2 User's Manual
Overview

Getting a List of Port Numbers That are Being Used (Windows/

Linux)
Ports are used for data communication during license authentication and remote execution. It is
necessary to change the port number if data communication fails with the default settings of JMAG.
• Windows (page 40)
• Linux (page 40)

Windows
1. Start the Windows command prompt.
For details on ways to run application software, see “Starting the Application (Windows/
Linux)” on page 37.
2. Enter the following command and press the [Enter] key:
netstat -ano

A list of used TCP/UDP ports is displayed.

The local address column shows the local address and the port number used. For example, when
“192.0.2.0: 6200” is displayed, “192.0.2.0” is the local address and “6200” is the port number.

Linux
1. Run the following command:
netstat -anp

A list of used TCP/UDP ports is displayed.

The local address column shows the local address and the port number used. For example, when
“192.0.2.0: 6200” is displayed, “192.0.2.0” is the local address and “6200” is the port number.

40
 Operations in Windows and Linux

Finding the Registry (Windows)

Settings information used in Windows is stored in the registry. Contents of the registry can be con-
firmed with the registry editor.
JMAG information can be confirmed in the registry editor under [HKEY_CURRENT_USER] >
[Software] > [JRI].
MEMO The registry editor is displayed by searching for “regedit” in the search box of Windows.

41
JMAG Version 22.2 User's Manual
Overview

Setting Environment Variables (Windows/Linux)

Setting environment variables is sometimes necessary in order to use JMAG.
MEMO Differences between user environment variables and system environment variables in Windows.
User environment variables are user specific environment variables. The system environment variable is a
machine-specific environment variable. It affects all users who use that machine. If an environment vari-
able with the same name is set in the user environment variable and system environment variable, the
system environment variable setting takes precedence. Please select the appropriate setting according to
usage situation.

Windows

 Notes
• JMAG needs to be installed before setting environment variables.
• If environment variables have been set directly in the OS, the variables that have been once set
will take effect until those settings are deleted.
• An administrative account is required when setting system environment variables.
• In the case of Windows, environment variable names are not case sensitive.
• When editing an existing environment variable, use caution not to overwrite the variable value.
By using a semicolon (;) 1 environment variable can be set to have multiple values (e.g.,
@192.0.2.0; @198.51.100.0).

 Setting environment variables on OS

1. Open the Windows Control Panel.

See “Opening the Control Panel (Windows)” on page 36.
2. Click [System].
Click [System] after clicking [System and Security] when category display is applied to the con-
trol panel.
3. Click [Advanced system settings] on the left side of the window.
4. Click [Environment Variables].
5. To create a new environment variable, click [New] of [User variables] or [System vari-
ables].
To edit the existing environment variable, select one from the list of [User variables] or
[System variables] and click [Edit].
Open the [New User Variable] dialog or the [New System Variable] dialog when creating a new
variable. Open the [Edit User Variable] dialog or the [Edit System Variable] dialog when editing
an existing environment variable.
6. Specify or correct the [Variable Name] and [Variable Value].
For example, enter the following in each text box when it is “InsDir”, a unique environment vari-
able for JMAG:
• [Variable Name]: InsDir
• [Variable Value]: Folder where JMAG is installed (absolute path). In case of default, “C:\Pro-
gram Files\JMAG-Designer22.2”.

42
 Operations in Windows and Linux

7. Click [OK], and close all dialogs.

 Setting environment variables from the command prompt

Use the set command. For this command, connect the variable and variable value with an equal sign.
MEMO Variable values set from the command prompt using the set command are valid only within the
command prompt in which the set command is executed.
• Format:
export "variable name"="variable value"

• Example:
set InsDir=C:\Program Files\JMAG-Designer22.2
set WorkDir=D:\JMAG\Data

Linux

 Notes
• In the case of Linux, environment variable names are case sensitive. Be sure to use upper case text
for environment variable names.

 Setting environment variables on OS using the C shell

Use the setenv command. For this command, enter a space between the variable and the variable
value.
• Format:
setenv "variable name" "variable value"

• Example:
setenv JRI_LICENSE_FILE @MyPC

 Setting environment variables on OS using the bash

Use the export command. For this command, connect the variable and variable value with an equal
sign.
• Format:
export "variable name"="variable value"

• Example:
export [email protected]

43
JMAG Version 22.2 User's Manual
Overview

44