Welcome to EUROfusion Integrated Modelling workflow’s documentation!

Contents

• 1. Introduction to the EUROfusion Project Code Development for integrated modelling
  • 1.1. The European Integrated Modelling (EU-IM) approach
  • 1.2. Mission
  • 1.3. Achievements
  • 1.4. Publications
  • 1.5. Contributors
  • 1.6. Glossary
• 2. Infrastructure
  • 2.1. Kepler
    • 2.1.1. Introduction to Kepler - basics
      • 2.1.1.1. Installing Kepler and tutorial workflows
    • 2.1.2. Kepler IMAS actors
    • 2.1.3. IMAS Kepler based configuration
      • 2.1.3.1. Running Kepler using IMAS environment
        • 2.1.3.1.1. Setting up environment
          • 2.1.3.1.1.1. Backing up old files
        • 2.1.3.1.2. Creating place to store your personal installations of Kepler
        • 2.1.3.1.3. Running Kepler (default release)
    • 2.1.4. FC2K - Embedding user codes into Kepler
      • 2.1.4.1. FC2K basics
        • 2.1.4.1.1. What FC2K actually does?
        • 2.1.4.1.2. FC2K main window
        • 2.1.4.1.3. Actor description
        • 2.1.4.1.4. Environment
        • 2.1.4.1.5. “Arguments” tab explained
        • 2.1.4.1.6. “Parameters” tab explained
        • 2.1.4.1.7. “Source” tab explained
          • 2.1.4.1.7.1. Libraries
        • 2.1.4.1.8. “Settings” tab explained
        • 2.1.4.1.9. “Documentation” tab explained
        • 2.1.4.1.10. “Interface” tab explained
      • 2.1.4.2. Incorporating user codes into Kepler using FC2K - exercises
        • 2.1.4.2.1. Embedding Fortran codes into Kepler
        • 2.1.4.2.2. Embedding C++ codes
    • 2.1.5. FC2K - developer guidelines
      • 2.1.5.1. What code wrapper actually does?
      • 2.1.5.2. Development of Fortran codes
        • 2.1.5.2.1. Subroutine syntax
        • 2.1.5.2.2. Arguments list
        • 2.1.5.2.3. Code parameters
        • 2.1.5.2.4. Diagnostic info
        • 2.1.5.2.5. Examples
      • 2.1.5.3. Development of C++ codes
        • 2.1.5.3.1. Function syntax
        • 2.1.5.3.2. Arguments list
        • 2.1.5.3.3. Code parameters
        • 2.1.5.3.4. Diagnostic info
        • 2.1.5.3.5. Examples
      • 2.1.5.4. Delivery of the user code
    • 2.1.6. FC2K - Example 1 - Embedding Fortran codes into Kepler (no CPOs)
      • 2.1.6.1. Get familiar with codes that will be incorporated into Kepler
      • 2.1.6.2. Build the code by issuing
      • 2.1.6.3. Prepare environment for FC2K
      • 2.1.6.4. Start FC2K application
      • 2.1.6.5. Open a nocpo_example_1 project
      • 2.1.6.6. Project settings
      • 2.1.6.7. After all the settings are correct, you can generate actor
      • 2.1.6.8. Confirm Kepler compilation
      • 2.1.6.9. You can now start Kepler and use generated actor
      • 2.1.6.10. Launch the workflow
    • 2.1.7. FC2K - Example 2 - Embedding Fortran code into Kepler (CPOs)
      • 2.1.7.1. Get familiar with codes that will be incorporated into Kepler
      • 2.1.7.2. Build the code
      • 2.1.7.3. Prepare environment for FC2K
      • 2.1.7.4. Start FC2K application
      • 2.1.7.5. Open project cposlice2cposlicef_fc2k
      • 2.1.7.6. Project settings
      • 2.1.7.7. After all the settings are correct, you can generate actor
      • 2.1.7.8. Confirm Kepler compilation
      • 2.1.7.9. You can now start Kepler and use generated actor
      • 2.1.7.10. Launch the workflow
    • 2.1.8. FC2K - Example 3 - Embedding C++ code within Kepler (no CPOs)
      • 2.1.8.1. Get familiar with codes that will be incorporated into Kepler
      • 2.1.8.2. Build the code by issuing
      • 2.1.8.3. Prepare environment for FC2K
      • 2.1.8.4. Start FC2K application
      • 2.1.8.5. Open project simplecppactor_nocpo
      • 2.1.8.6. Project settings
      • 2.1.8.7. Actor generation
      • 2.1.8.8. Confirm Kepler compilation
      • 2.1.8.9. You can now start Kepler and use generated actor
      • 2.1.8.10. Launch the workflow
    • 2.1.9. FC2K - Example 4 - Embedding C++ code within Kepler (CPOs)
      • 2.1.9.1. Get familiar with codes that will be incorporated into Kepler
      • 2.1.9.2. Build the code by issuing
      • 2.1.9.3. Prepare environment for FC2K
      • 2.1.9.4. Start FC2K application
      • 2.1.9.5. Open project simplecppactor
      • 2.1.9.6. Project settings
      • 2.1.9.7. Actor generation
      • 2.1.9.8. Confirm Kepler compilation
      • 2.1.9.9. You can now start Kepler and use generated actor
    • 2.1.10. IMAS Kepler 2.1.3 (default release)
      • 2.1.10.1. Installation of default version of Kepler (without actors)
      • 2.1.10.2. Installation of “dressed” version of Kepler (with actors)
    • 2.1.11. IMAS Kepler 2.1.5 (release candidate)
    • 2.1.12. Installation based on README file
  • 2.2. General Grid Description and Grid Service Library
    • 2.2.1. Resources
    • 2.2.2. Documentation
    • 2.2.3. Outdated documentation
      • 2.2.3.1. Example grids
        • 2.2.3.1.1. Example grid details
          • 2.2.3.1.1.1. Example Grid #1: 2d structured R,Z grid
          • 2.2.3.1.1.2. Object classes
          • 2.2.3.1.1.3. Example 2: B2 grid
        • 2.2.3.1.2. Object list examples
        • 2.2.3.1.3. Subgrid examples
      • 2.2.3.2. Grid service library
        • 2.2.3.2.1. Using the grid service library
          • 2.2.3.2.1.1. Setting up the environment
          • 2.2.3.2.1.2. Checking out and testing the grid service library
        • 2.2.3.2.2. Example applications (outdated)
          • 2.2.3.2.2.1. Plotting 3d wall geometry with VisIt (temporary solution, not required any more)
          • 2.2.3.2.2.2. Using UALConnector to visualize CPOs using the general grid description
      • 2.2.3.3. IMP3 General Grid Description and Grid Service Library - Tutorial
        • 2.2.3.3.1. Setup your environment
        • 2.2.3.3.2. Compile & run examples
        • 2.2.3.3.3. Visualize
• 3. European Transport Simulator (ETS)
  • 3.1. ETS Documentation
    • 3.1.1. Configuration of the ETS-5 workflow in Kepler
    • 3.1.2. ETS releases
  • 3.2. ETS workflows in KEPLER
    • 3.2.1. Configuring the ETS run
      • 3.2.1.1. Workflow parameters
        • 3.2.1.1.1. General Parameters
        • 3.2.1.1.2. Time resolution
        • 3.2.1.1.3. Transport
        • 3.2.1.1.4. Equilibrium
        • 3.2.1.1.5. Numerics
        • 3.2.1.1.6. Equilibrium
      • 3.2.1.2. Ion, Impurity and Neutral Composition
      • 3.2.1.3. Equations to be solved and boundary conditions
        • 3.2.1.3.1. Main Plasma
        • 3.2.1.3.2. Impurity
        • 3.2.1.3.3. Neutrals
        • 3.2.1.3.4. Input profiles interpolation
      • 3.2.1.4. Convergence loop
      • 3.2.1.5. Equilibrium
        • 3.2.1.5.1. Initialization Settings
        • 3.2.1.5.2. Run Settings
      • 3.2.1.6. Transport
        • 3.2.1.6.1. Transport models
        • 3.2.1.6.2. Background transport
        • 3.2.1.6.3. Edge transport barrier
        • 3.2.1.6.4. Total transport coefficients
      • 3.2.1.7. MHD
      • 3.2.1.8. Sources and impurity
        • 3.2.1.8.1. Analytical & Impurity sources
        • 3.2.1.8.2. HCD sources
        • 3.2.1.8.3. Power control
        • 3.2.1.8.4. Total power
      • 3.2.1.9. Instantaneous events & Actuators
        • 3.2.1.9.1. Pellet
        • 3.2.1.9.2. Sawtooth
        • 3.2.1.9.3. Actuators
      • 3.2.1.10. Scenario output
      • 3.2.1.11. Visualization during the run
        • 3.2.1.11.1. Multiple Tab Display
        • 3.2.1.11.2. ETSviz
    • 3.2.2. List of Actors
      • 3.2.2.1. Equilibrium actors
      • 3.2.2.2. Core transport actors
      • 3.2.2.3. Heating and current drive actors
      • 3.2.2.4. Events actors
      • 3.2.2.5. Non-physics actors
  • 3.3. Turbulent Flux Quantities in Transport Models
    • 3.3.1. Overview
    • 3.3.2. Particle Flux as an Example
    • 3.3.3. Metric Coefficients
    • 3.3.4. Heat Fluxes
    • 3.3.5. Ds and Vs from Turbulence Codes to Transport Solvers
    • 3.3.6. Ambipolarity
    • 3.3.7. Statistical Character
  • 3.4. Running Exponential Average
    • 3.4.1. Overview
    • 3.4.2. Definition
    • 3.4.3. Differential Equation
    • 3.4.4. Equivalence to Past-Time Convolution Integral
    • 3.4.5. notes
• 4. Equilibrium and MHD Stability workflow (EQSTABIL)
  • 4.1. Workflow rationale
  • 4.2. Workflow organization & design
    • 4.2.1. START
    • 4.2.2. CHECK_DATA
    • 4.2.3. MHD_EQ_STABILITY
    • 4.2.4. SAVE SLICE
  • 4.3. Installing the workflow
  • 4.4. Setting up Workflow and Actor parameters
    • 4.4.1. Setting workflow parameters
    • 4.4.2. Setting actor parameters
  • 4.5. EQSTABIL Tutorial
• 5. The EQRECONSTRUCT workflow
  • 5.1. Workflow rationale
  • 5.2. Workflow organization & design
    • 5.2.1. I - START
    • 5.2.2. II - CHECK_DATA
    • 5.2.3. III - Reconstruct
    • 5.2.4. IV - SAVE SLICE
  • 5.3. Installing and running the workflow
  • 5.4. Setting up the Workflow and Actor parameters
    • 5.4.1. I - Setting the workflow parameters
    • 5.4.2. II - Setting actor parameters
  • 5.5. 6. News and Recent activity
• 6. Turbulence with synthetic diagnostics workflows
  • 6.1. HESEL Documentation
    • 6.1.1. HESEL as stand-alone
      • 6.1.1.1. Obtaining and building HESEL
      • 6.1.1.2. HESEL input
        • 6.1.1.2.1. HESEL input
        • 6.1.1.2.2. Profile datafile
        • 6.1.1.2.3. Probe positions
      • 6.1.1.3. HESEL code structure
      • 6.1.1.4. Running a HESEL simulation
      • 6.1.1.5. HESEL output
    • 6.1.2. HESEL as an actor
    • 6.1.3. HESEL in the KEPLER workflow
  • 6.2. RENATE Documentation
• 7. Codes
  • 7.1. IMASviz
  • 7.2. IMASgo!
  • 7.3. How to turn a C++ code into a Kepler actor
    • 7.3.1. Adapt your C++ function
    • 7.3.2. How to use code parameters
    • 7.3.3. Compile your function as a library
    • 7.3.4. Full example
    • 7.3.5. How to fill the FC2K window
  • 7.4. Plasma equilibrium and MHD list of codes
    • 7.4.1. Free boundary equilibrium codes
    • 7.4.2. Fixed boundary equilibrium codes
    • 7.4.3. Linear MHD stability codes
    • 7.4.4. Sawtooth Crash Modules
    • 7.4.5. ELM Modules
    • 7.4.6. NTM Modules
    • 7.4.7. Numerical Tools
  • 7.5. Heating, current drive (H&CD) and fast particles list of codes
    • 7.5.1. Electron heating codes
      • 7.5.1.1. EC wave codes
      • 7.5.1.2. Combined electron Fokker-Planck codes
      • 7.5.1.3. Wave codes for ion cyclotron heating
      • 7.5.1.4. Fokker-Planck codes for ion cyclotron heating
      • 7.5.1.5. NBI sources for Fokker-Planck codes
      • 7.5.1.6. Nuclear sources (input for Fokker-Planck codes)
      • 7.5.1.7. NBI Fokker-Planck codes
      • 7.5.1.8. Runaway electrons
      • 7.5.1.9. Advanced codes
      • 7.5.1.10. Codes for fast ion-MHD interactions
  • 7.6. Transport list of codes
• 8. Conventions
  • 8.1. Standard Machine Names
  • 8.2. Physics Conventions
    • 8.2.1. Coordinate System
    • 8.2.2. Representation of the Magnetic Field and Current
    • 8.2.3. Poloidal and Toroidal Fluxes
    • 8.2.4. Safety Factor
    • 8.2.5. Signs
    • 8.2.6. COCOS - toroidal coordinate conventions
      • 8.2.6.1. Equilibrium COCOS transformation library and actor
    • 8.2.7. The Flux Surface Average
    • 8.2.8. The Toroidal Flux Radius as the Radial Coordinate
    • 8.2.9. Toroidal and Parallel Current
    • 8.2.10. Straight Field Line Coordinates
    • 8.2.11. Plasma Betas
    • 8.2.12. Internal Inductance
    • 8.2.13. Poloidal Angle Dimension in Equilibrium CPO
  • 8.3. Numerical and computational conventions
    • 8.3.1. Standardized Variable Types
    • 8.3.2. Standardized Physical Constants
    • 8.3.3. Invalid Data Base Entries
    • 8.3.4. Enumerated datatypes/Identifiers
      • 8.3.4.1. Example: How to fill coresource/values/sourceid
    • 8.3.5. Grid Types in Equilibrium CPO
      • 8.3.5.1. Grid Type Identifier
        • 8.3.5.1.1. Poloidal Angle Identifier
    • 8.3.6. Standardized EU-EU-IM Plasma Bundle
• 9. AMNS
  • 9.1. Scientific Rationale and Main Objectives
  • 9.2. EU-IM contact person
  • 9.3. AMNS tasks
  • 9.4. AMNS Documentation
    • 9.4.1. AMNS User Interface
      • 9.4.1.1. AMNS User Interface Data Structures
      • 9.4.1.2. AMNS User Interface Data Reactions
      • 9.4.1.3. AMNS User Interface Data Queries
      • 9.4.1.4. AMNS User Interface Data Setting Options
      • 9.4.1.5. FORTRAN AMNS User Interface
        • 9.4.1.5.1. AMNS User Interface: Fortran Calls
        • 9.4.1.5.2. AMNS User Interface Example (Fortran)
        • 9.4.1.5.3. AMNS User Interface Example Fortran Makefile
    • 9.4.2. C AMNS User Interface
      • 9.4.2.1. AMNS User Interface: C Calls
      • 9.4.2.2. AMNS User Interface Example (C)
      • 9.4.2.3. AMNS User Interface Example C Makefile
    • 9.4.3. Python AMNS User Interface
      • 9.4.3.1. AMNS User Interface: Python Calls
      • 9.4.3.2. AMNS User Interface Example (Python)
• 10. Additional resources

Using the WPCD workflows

Use of the WPCD workflows is available via the EUROfusion Gateway, the JET analysis cluster (FREIA) and the ITER IO HPC

The WPCD documentation and workflow concepts are copyright of the EUROfusion consortium.