user/pages/09.software/47.ansys/docs.en.md
452be89a
 ---
 title: ANSYS
 published: true
 taxonomy:
     category:
         - docs
 external_links:
     process: true
     no_follow: true
     target: _blank
     mode: active
 media_order: 'ansys_example_01.png,ansys_example_02.png,ansys_example_01b.png,ansys_example_03.png,ansys_example_03b.png'
 ---
 
 [toc]
 
 ## Environment Settings{#enviroment}
 
 
 
 ### Software Version, System Requirements, and License Type{#version}
 
 The Modules software package can dynamically switch and set the environment settings required to use the application by executing the module command.  And you can change the environment settings easily when you switch to the different version of the application.
 Please refer to [Modules](/config/modules) for details.
 
 You can check a list of available module files with the module avail command.
 
495abba5
 Version            |  Module File Name    | System A |System B/C/G  | Cloud System
 ---------------    | -----                | -----         |  ----- | ---
5e1beaba
  2024R1.1 (default)           | ansysmcfd/2024R1.1  | - |  KU           |  -
495abba5
  2023R1.4          | ansysmcfd/2023R1.4  | - |  KU           |  -
  2022R2.2          | ansysmcfd/2022R2.2   | - | KU           |  -
5e1beaba
  2022R2 | ansysmcfd/2022R2     | - | KU           |  -
452be89a
 
 \+ : Available for all users 
4e369d25
 
452be89a
 KU : Available for academic users only    
4e369d25
 
452be89a
 \- : Not available
 
 **License Type**
 * ANSYS Academic Research Mechanical and CFD
   * The license selection of the launcher should be [Ansys Mechanical Enterprise].
   * The product features are shown below. <br> [Product Features](https://www.ansys.com/-/media/ansys/corporate/files/pdf/product/academic/academic-products-features-table-2019-v2.pdf)
 
 ## Software Overview{#overview}
 
 ANSYS is a multi-physics CAE. It allows you to conduct flexible and purpose-suited analysis of physical phenomena such as structure, vibration, heat transfer, electromagnetic field, electric voltage, acousmato, thermic fluid, and drop collision, as well as problems that combine the above.
 
 
 
 ### Software Features{#functions}
 
 * Structural analysis
 * Heat transfer analysis
 * Electromagnetic field analysis
 * Fluid analysis
 * Fatigue analysis
 * Acoustic analysis
 * Drop and collision analysis
 * Piezoelectric analysis
 * Coupled analysis
 * FSI analysis(fluid-solid coupled analysis)
 
 
 ### Areas of Application{#app_area}
 
 * Automobile
 * Electrical and electronic
 * Aerospace
 * Energy
 * Medical technology
 * Construction and civil engineering, etc.
 
 
 
 ## How to Use{#usage}
 
 
 ### User Registration{#regist}
 
 You need to register via the [user portal](http://www.iimc.kyoto-u.ac.jp/en/services/comp/support/portal.html) to use ANSYS.
 
 
 **※ANSYS is only available to Kyoto University members who are physically located within 50 miles(80.4 km) from Yoshida campus.**
 
 
 ### Setting Up Environment(Executing the module Command){#env_set}
 
 Set up the environment by executing the module command. (Load the version of the module file which you want to use.)
 
 
 
 ```nohighlight
 $ module load ansysmcfd
 ```
 
 
 ### How to use in the GUI{#gui}
 
 
 
 #### Starting the launcher
 
 The basic usage is to start various products via the launcher.
 You can start the launcher by executing the following command.
 
 Please refer to  [Interactive Processing](/run/interactive) for details on the tssrun command. 
 
 
 
 ```nohighlight
 $ tssrun --x11 launcher
 ※The ending of the execution command name (version number) differs depending on the version.
 ```
 
 
 ![](ansys_example_03.png)
 
 
 If you want to use parallel computing in your simulation, specify the number of cores to allocate with the --rsc option when executing the tssrun command.
 
 例:4 Parallel computing
 ```nohighlight
 $ tssrun --x11 --rsc t=4:c=4 launcher170
 ```
 
 If you use parallel computing, you need to set  the value of Use Shared-Memory Parallel in the 'High Performance Computing Setup' tab in the 'Setting the Simulation Environment' described below.
 
 
 #### Setting the Simulation Environment
 
 You can set the simulation environment after the launcher has started.
 
 And you can select a simulation environment from the following options. Here we explain the case ANSYS is selected.
 
 * ANSYS … ANSYS standard interface
 * ANSYS Batch … Used for batch processing of analyses
 
 Settings for each simulation environment are made via the tab menu.
 
 
 ![](ansys_example_03b.png)
 
 **File Management Tab (File Management)**
 
 * Working directory(Working Directory)
     * The default save location of the file created while ANSYS is running.
 * Job name(Job Name)
     * The default filename of the file created while ANSYS is running. Maximum 32 characters.
 
 **Customization and Preferences Tab (Customization/Preferences)**
 
 * Memory
     * Memory for analysis is automatically set, but it can also be set manually.
 * Language selection (only English for Linux and UNIX)
 * Graphic device
     * X11 … Default
     * X11c
     * 3D …need to support opengl
 * Output To
     * Screen & File … Default
     * File Only ... If you are using version 2021R2 or 2022R1, please select File Only.
     * Screen Only
 
 **HPC Setup Tab (High Performance Computing Setup)**
 
 * How to Execute(Type of High Perfomance Computing Run)
     * None … Serial running
     * Use Shared-Memory Parallel (SMP) … Thread parallelization
         *  Set the same number as the number of parallels specified by the --rsc option of the tssrun command; up to 16 parallels are available.
 
 
 #### Starting ANSYS
 
 After the settings are completed, click Run to start up ANSYS (selected simulation environment).
 
 
 #### Setting After ANSYS Has Started
 
 **Changing the font size:**
 
 If the default font size is smaller or larger than you expect, you can change the font size through the following menu.
 
 
 [MenuCtrls] ⇒ [Font Selection]
 
 ![](ansys_example_02.png)
 
 
 ### How to Use in CUI{#cui}
 
 By default, ANSYS performs the processing interactively by using a GUI, but it can also execute on the command line. The command syntax and options are listed below. Please refer to  [Interactive Processing](/run/interactive) for details on the tssrun command. 
 
 ```nohighlight
e3fe76c6
 $ tssrun ansys222 [options] -i input-file > output-file
452be89a
 ※The ending of the execution command name (version number) differs depending on the version.
 ```
4e369d25
                                                     
 
 Options                             |  Description                     
 ---------------------------------- | --------------------------------
 -j JobName                          |   Specifying a job name                   
 -d Switch                           |  Specifying a device type(X11, X11c, 3D)        
 -m Size                             |  Specifying a memory: work space(unit: MB), it is automatically set by default.    
 -db Size                            |  Specifying a memory: database space(unit: MB), it is automatically set by default. 
 -p Prod                             |  Specifying a product                              
 -g                                  |  Starts in a GUI mode
 -np NCPUS                          | Number of process parallelization      (When '-smp' is specified or '-dis' is not specified)
 -np NTHREAD                        | Number of threads parallelization     (When '-dis' is specified)
 -smp                               | SMP parallelization
 -dis                                |  MPI parallelization                                  
 -dir Dir                            |  Specifying a work directory                              
452be89a
 
 
4e369d25
 ### How to Use in Batch Job{#batch_job}
452be89a
 
4e369d25
 You need to prepare an Batch file to run ANSYS by Batch job. 
 Write the commands in the script as you  execute on the command line, and submit the job with the sbatch command.
452be89a
 
4e369d25
 The execute command of the ANSYS will automatically calls mpiexec inside the command, so the srun command is unnecessary.
452be89a
 
 
4e369d25
 #### Example of Job Script 1: SMP
 ```nohighlight
 #!/bin/bash
 #============ LSF Options ============
 #SBATCH -q gr19999b
 #SBATCH -t 1:00:00
 #SBATCH --rsc p=1:t=4:c=4
 #============ Shell Script ============
 module load ansysmcfd/2022R2
 ansys222 -j test_${SLURM_JOBID} -b -smp -np ${SLURM_DPC_THREADS} -i test.dat
 ```
 ※The ending of the execution command name (version number) differs depending on the ANSYS version.
452be89a
 
4e369d25
 #### Example of Job Script 2: MPI
452be89a
 ```nohighlight
 #!/bin/bash
 #============ LSF Options ============
 #SBATCH -q gr19999b
 #SBATCH -t 1:00:00
4e369d25
 #SBATCH --rsc p=4:t=1:c=1
452be89a
 #============ Shell Script ============
 module load ansys
4e369d25
 ansys222 -j test_${SLURM_JOBID} -b -dis -np ${SLURM_DPC_NPROCS} -i test.dat
452be89a
 ```
4e369d25
 ※The ending of the execution command name (version number) differs depending on the ANSYS version.
452be89a
 
 ## References{#references}
 
 ### References in Japanese{#ref_ja}
 
 #### 2022R1{#ref2022_ja}
 * [ANSYS Workbench Mechanical 入門セミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Beginner_2022R1.zip)
 * [ANSYS Workbench Mechanical 使いこなしセミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Mastering_2022R1.zip)
 * [ANSYS Workbench Mechanical 接触解析セミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Contact_2022R1.zip)
 * [ANSYS Workbench Mechanical 動解析セミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Dynamics_2022R1.zip)
 * [ANSYS Workbench Mechanical 材料非線形セミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Materialnl_2022R1.zip)
 * [ANSYS Workbench Mechanical 伝熱解析セミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/AWM_Thermal_2022R1.zip)
 * [ANSYS Fluent ベーシックセミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/Fluent_Basic_2022R1_.zip)
c003e8fe
 * [ANSYS CFX ベーシックセミナー](https://web.kudpc.kyoto-u.ac.jp/auth/manual/ansys/2022R1/CFX_Basic_2022R1.zip)
452be89a
 
 
 <!--
 ### 英語{#ref_en}
 
 #### v18.0{#ref18_en}
 
 * [ANSYS Fluent Docs](https://web.kudpc.kyoto-u.ac.jp/ansysdocs/v18/ANSYS-Fluent-Doc-R18.zip)
 
 ## リンク{#link}
 -->
 
 
 ### External Links{#ex_link}
 
 * [ANSYS, inc.](http://ansys.com/)
 * [アンシス・ジャパン株式会社](http://ansys.jp/)
 * [汎用FEM連成解析ツール ANSYS:サイバネット](http://www.cybernet.co.jp/ansys/)