III. Input Settings

III. Input Settings#

This chapter describes how to enter data in the input file required to run EMSolution (each input item is also called a parameter). The input file contains all information, except mesh data, for describing an analysis model from a physical perspective, as well as user selections about the analysis. It is therefore the control file for EMSolution analysis. It contains all input data other than nodes and elements. Except for some items, data is shared between initial and restart runs.

This document uses the following notation.

  • File name: post_geom

  • Input setting:

    PRE_PROCESSING(1) (linked; described on another page)

    PRE_PROCESSING (not linked; described on the current page)

  • Module name: <deform module>

Linked input settings refer to items outside the current document. Settings without links refer to items in the current document.

input text format#

The general format of the input file is as follows.

Descriptions of the conventional text format are generally contained in the following collapsible sections. Click collapsible sections for the input text format to display them. Opening a section displays its text-format description.

Input text-format section

  1. A line whose first column begins with * (half-width asterisk) is a comment and has no semantic meaning. An * in the middle of a line is not recognized as a comment.

  2. Input data has three types: string, real number, and integer. The input order on each line is defined (described in this chapter), and values are separated by blanks. Provided that order is maintained, their positions on the line are unrestricted. Use half-width spaces or tabs as blanks; full-width spaces are not blanks.

  3. Integer 0 and real 0.0 in the first column must not be replaced with blanks. Unused items after the first column may be omitted; omitted items are treated as zero.

  4. Unless otherwise stated, 0 means off (do not execute) and 1 means on (execute) for execution control, input/output options, and similar settings.

  5. Enter a value even for settings unused by the analysis conditions unless this guide explicitly states that they may be omitted.

In the following descriptions:

Integer type:

“I”

Real-number type:

“E”

String type:

“S”

They are denoted as above. Multiple data values are represented by number of data items in the Type column. Some use title-card format; in that case, a string (uppercase or lowercase) is placed first.

  • Title-card example

* PHICOIL *SERIES_NO * NO_PARTS * IN_ROTOR *
PHICOIL      111        1        0

In the following descriptions, the number in parentheses after a variable name is its data number (the item number in Chapter III).

  • Example: TRANSIENT(2) means input data in item 2, “Analysis Type,” of Chapter III.

Input data for an item does not necessarily occupy one line (the following is input data for item 1). Each input item has a variable name such as PRE_PROCESSING. We recommend writing the variable name on a comment line as shown below, but it is not required.

* PRE_PROCESSING * MAKE_SYSTEM_MATRICES *
    1                   1
* SOLVE_EQUATION * POST_PROCESSING *
    1                 1

The beginning of each item’s description page shows the complete input data and the type of each variable in its corresponding data field.

* PHICOIL * SERIES_NO * NO_PARTS * IN_ROTOR *
    S           I           I          I

In title-card format, the variable name is string-type (S-type) input data.

* PHICOIL  *SERIES_NO * NO_PARTS * IN_ROTOR *
PHICOIL         1          1            0

Input data

Each input item consists of parameter sets containing multiple parameters. Parameter sets include fixed parameter sets and additional parameter sets. A fixed parameter set is always required; an additional parameter set is added according to parameter settings in a fixed parameter set. A semi-fixed parameter set is a set for which one of several alternatives is required depending on conditions. Input data and parameter sets normally have a defined order and work when values are defined at their designated positions. Source elements, however, use title cards such as COIL(17.1) and ELMCUR(17.2) to define parameter sets themselves, so they can be entered in any order. These source-element parameter sets are called title-card parameter sets or TC parameter sets. Not every title-card item is a TC parameter set: for example, SOURCE/END(17) is a fixed parameter set and MOTION(19) is an additional parameter set.

  • Parameter sets

* PRE_PROCESSING * MAKE_SYSTEM_MATRICES *
        1           1
* SOLVE_EQUATION * POST_PROCESSING *
        1           1

  • Parameters include PRE_PROCESSING and MAKE_SYSTEM_MATRICES in the parameter sets above.

Input data description

Each input-data list provides its input format and detailed parameter descriptions.

  • Input format

* PRE_PROCESSING * MAKE_SYSTEM_MATRICES *
        1           1
* SOLVE_EQUATION * POST_PROCESSING *
        1           1
  • Detailed description

    • In the example below, PRE_PROCESSING is the parameter in row 1, column 1 of a fixed parameter set, and its input type is integer.

    PRE_PROCESSING
固定パラメータセット ｜[row, col] = [1, 1]　｜Type=I (0, 1)

- =1：前処理プロセスを実行
- =0：前処理プロセスをスキップ

Input parameters are basically:

  • I: integer type, such as -1, 0, or 1

  • E: real-number type, such as 1.0 or 5.e-7

  • S: string type, such as identifiers COIL and NETWORK

Formulas cannot be entered.

input.json format#

From 2024.11, a more flexible JSON format is available in addition to the conventional fixed text format. JSON format uses keys and values to describe nearly the same parameters as text format.

Enclose entries in {} and write them as “key”: “value”.

Important

JSON format is available only in versions from 2024.11 onward. The conventional text format remains available, but JSON format is recommended.

Running EMSolution with conventional text format generates input.json for redirection. Edit this file to create JSON-format input data.

It is written as follows.

JSON format from 2024.11#
"1_Execution_Control" :
{
    "PRE_PROCESSING" : I,
    "MAKE_SYSTEM_MATRICES" : I,
    "SOLVE_EQUATION" : I,
    "POST_PROCESSING" : I
},

Compared with fixed text format, it has the following advantages.

  • Works well with programming languages such as Python

    It is easy to retrieve or change values using “keys”.

  • The order of {} entries can be changed freely.

    Frequently changed entries can be placed first and seldom changed entries last.

  • Default values need not be defined

    Default values are shown for each parameter.

Input data description#

As in text format, input parameters are basically:

Key: string

Value: integer or real-number type

  • Integer (I): such as -1, 0, or 1

  • Real number (E): such as 1.0 or 5.e-7

  • String (S): formula input, such as “4.0*sqrt(2)” or “1/60”

Formulas can be entered as strings. See the input-data list for parameters that allow formula input.

Note

Unless otherwise stated, 0 means off (do not execute) and 1 means on (execute) for execution control, input/output options, and similar settings.

Input example

JSON format from 2024.11#
"5_Convergence_Conditions" :
{
    "THETA" : "2/3",
    "THETA_NETWORK" : "1/2",
    "THETA_MOTION" : "1/2"
},

Caution

Entering a formula directly causes an error in JSON format.

Input-data list#