FORTRAN ROUTINES FOR STORING EIRENE TRIANGULAR GRIDS IN IMAS

Content

1. Introduction
2. Files provided
3. Running a test example
4. Storing EIRENE triangular grids in IMAS
   
   1. Structure of EIRENE files keeping the grid
   2. Presentation of EIRENE grid in GGD
   Module 
   1. Module  triangular_grid_
   modile 
   1. modile 
   Module 
   1. Module  triangular_grid_ids_
   io 
   1. io 
   2. Template
   files 
   1. files  save_grid.f90
    and 
   1.  and  recover_grid.f90
    
5. Storing the EIRENE input
6. Things to be done

Introduction

The Fortran routines described herein are intended to become a part of interface between the code EIRENE and the IMAS data structure.  They take files containing the description of a triangular grid in native EIRENE format and store this grid in an IMAS IDS; on the other hand, they extract a stored grid description from IMAS and provide it in EIRENE format. At present, these routines have been tested only with the IDS  edge_profiles    .

The grid is stored in the IMAS subsystem called GGD (General Grid Description). This subsystem consists of two data sub-trees available in most IMAS IDS:  grid_ggd  and  ggd  .  The former contains the description of the grid itself; the latter, all quantities given with reference to this grid (for, value of electron temperature at all grid nodes, values of energy flux at all nodes at the divertor surface etc.). A more detailed description will be given in section 5. 

The files provided are intended to support storing triangular 2D grids in the  grid_ggd  structure. In the future (if required), they can be upgraded to support work with 3D grids consisting of a triangular 2D grid in the poloidal plane and a grid in the toroidal direction.

Files provided

The files listed below can be found in the public directory ~g2yyakov/public/eirene/0.5.

...

FILES

...

CONTENT

...

Library that supports reading, writing and processing triangular grids

...

Files provided

The files listed below can be found in the public directory ~g2yyakov/public/eirene.

!!! To be updated

Running a test example

!!! To be updated. !!! You need to have installed GSL (GGD Standard Library).

1. Open the file  gsl_config.sh  and set the value of the variable HOME to the GSL source directory location.
2. Type
   module load imasenv    
3. Create the required IMAS entry:
   imasdb eirene 
4. Type 
   . ./gsl_config.sh 

Running a test example

You need to have installed GSL (GGD Standard Library).

1. Open the file  gsl_config.sh  and set the value of the variable HOME to the GSL source directory location.
2. Type
   module load imasenv    
3. Create the required IMAS entry:
   imasdb eirene 
4. Type 
   . ./gsl_config.sh 
5. Now you can compile the examples. Type
   make clean 
make save 
   OR type
   ifort triangular_grid_module.f90 trangular_grid_ids_io.f90 save_grid.f90 -o save_grid.exe ${PKG_PART  }
6. Run the program:
   ./save_grid.exe 
   The program puts the grid stored in the files soledge3x.* into the IDS  edge_profiles   of the IMAS database  eirene .
7. Type
   make recover 
   OR type
   ifort triangular_grid_module.f90 trangular_grid_ids_io.f90 recover_grid.f90 -o recover_grid.exe ${PKG_PART  }
8. Run the program:
   ./recover_grid.exe 
   Compare the new files  eirene.*   with the original files  soledge3x.* .

...

1. ./recover_grid.exe 
   Compare the new files  eirene.*   with the original files  soledge3x.* .

Storing EIRENE triangular grids in IMAS

The Fortran routines described herein take files containing the description of a triangular grid in native EIRENE format and store this grid in an IMAS IDS; on the other hand, they extract a stored grid description from IMAS and provide it in EIRENE format. At present, these routines have been tested only with the IDS's  edge_profiles and equilibrium.

The grid is stored in the IMAS subsystem called GGD (General Grid Description). This subsystem consists of two data sub-trees available in most IMAS IDS:  grid_ggd  and  ggd  .  The former contains the description of the grid itself; the latter, all quantities given with reference to this grid (for, value of electron temperature at all grid nodes, values of energy flux at all nodes at the divertor surface etc.). A more detailed description will be given in section 5. 

The files provided are intended to support storing triangular 2D grids in the  grid_ggd  structure. In the future (if required), they can be upgraded to support work with 3D grids consisting of a triangular 2D grid in the poloidal plane and a grid in the toroidal direction.

Structure of EIRENE files keeping the grid

There are three files describing the triangular grid used in EIRENE.

...

Here N_i  is the index of the neighbouring triangle on side i, S_i  is the index of this side in the triangle N_i, M_i  is the ‘material property’ of the side i,   ixtri  and  iytri  are not used now (they are zeros in this example). Note that side 1 connects vertices 1 and 2; side 2, vertices 2 and 3; side 3, vertices 3 and 1. The material property (MP) is an index referring to a surface model defined in the main EIRENE file. In particular, MP is 0 for transparent (i.e., internal) grid edges. The MP of boundary edges can have different positive values. In the provides example, there are boundary edges with MP = 1, 2, 3.

Presentation of EIRENE grid in GGD

We begin with brief overview of general principles of presentation of grids in the  grid_ggd  structure.

...

At present, only items 1-4 of this lists are implemented.

Module triangular_grid_module

The module contains a data type for storing the information about all elements of a triangular grid and a library of methods (subroutines and functions). The methods solve the following tasks:

...

The module depends on the IMAS module  ids_types   (uses the constant  IDS_real  – the kind of real variables in IMAS).

Data types provided

The following data types are provided:

...

The type  edge_structure  is intended for information about an edge. The integer child array  vertex   holds indices of the edge vertices in  triangular_grid%vertex  . The leaf  material_property   holds the MP of the edge. The child array  adjacent   holds the indices of the neighbouring triangles in  triangular_grid%triangle .

Methods provided

The module member routines are as follows:

...

For description of service routines (some of them are no longer used), see comments in the module file.

Module  triangular_grid_ids_io

The module contains routines that support writing a grid having the  type(triangular_grid)  form to IMAS IDS and, vice versa, reading a grid from IMAS and putting it into the  type(triangular_grid)  form. It depends on the module  triangular_grid_module   and the IMAS modules  ids_schemas   and  ids_routines .

...

Template files  save_grid.f90   and  recover_grid.f90 

The program contained in the file  save_grid.f90  performs the following actions:

...

• Opens the IMAS database by calling the subroutine  imas_open_env  .
• Reads the IMAS IDS  edge_profiles, using the subroutine  ids_get .
• Extracts the information about the grid from the IDS and puts it into a  type(triangular_grid)-structure, using the subroutine  get_triangular_grid_from_ids  (module  triangular_grid_ids_io).
• Writes the grid to EIRENE-format files (subroutine  write_eirene_grid, module  triangular_grid_module).
• Closes the IMAS database.

Storing EIRENE input

Things to be done

• Add some simple methods for reading and writing physical data.
• Organize a 1D toroidal space and a couple of subsets in the 3D space.
• Add standard integer identifiers where appropriate.
• Try to adjust the processing of exceptions to GSL practices.
• Understand how the triangular grid can be united with the rectangular grid.

...