src/examples/itm_grid_example5_1dstructured.f90

Go to the documentation of this file.

program itm_grid_example5_1dstructured

  !> This example program demonstrates how to use the general grid description
  !> to store a simple 2d structured grid and write some data given on it to the CPO.
  !>
  !> The focus of this example program is delegate as much work as possible onto the
  !> grid service library. This is the recommended way to use the general grid description.
  !>
  !> If you want to learn how to do everything manually, step-by-step, without hiding any
  !> complexity behind high-level calls, have a look at the file itm_grid_example1_2dstructured_manual.f90
  !> in this directory.
  !>
  !> The used grid is described in detail here on the ITM Documentation Website (https://www.efda-itm.eu/ITM/html/)
  !> Then go to IMP3 -> IMP3 general grid description & service library -> Example grids -> Example grid #1
  !> Direct link (might be broken): https://www.efda-itm.eu/ITM/html/imp3_gridexamples.html#imp3_gridexamples_5 

  use itm_types         ! ITM standard Fortran data types, e.g. real(R8)
  use euITM_schemas     ! ITM data structure/CPO definitions
  use euITM_routines    ! ITM UAL routines
  use itm_grid_common   ! ITM grid service library: constant definitions like COORDTYPE_R, COORDTYPE_Z
  use itm_grid_structured ! ITM grid service libary, routines for handling structured grids
  use itm_constants, pi => itm_pi

  implicit none

  ! parameters
  integer, parameter :: NPOINTR = 50

  integer, parameter :: SHOTNUM = 9005
  integer, parameter :: RUNNUM = 0

  real(R8) :: XMIN = 2*pi
  real(R8) :: XMAX = 2*pi + 2*pi

  ! variables
  type (type_edge),pointer :: edgecpo(:) => null()
  integer :: idx
  integer :: i
  
  real(R8), dimension(NPOINTR) :: x, y
  real(R8) :: dx

  
  ! === 1. Set up CPO ===

  allocate( edgecpo(1) )    
  allocate( edgecpo(1)%datainfo%dataprovider(1) )
  edgecpo(1)%datainfo%dataprovider="IMP3"
  allocate( edgecpo(1)%codeparam%codename(1) )
  edgecpo(1)%codeparam%codename(1)="itm_grid_example1_2dstructured_manual"
  edgecpo(1)%time = 0.0_R8

  ! === 2. Set up grid ===
  
  dx = (XMAX - XMIN) / (NPOINTR-1)
  x = (/ ( XMIN + dx * i, i=0,NPOINTR-1) /)

  call gridSetupStructuredSep( edgecpo(1)%grid, &
      & ndim = 1, &
      & c1 = COORDTYPE_R, &
      & x1 = x, &
      & id = '1d_structured' )

  ! === 3. Set up subgrid for 2d cells ("faces") ===

  ! Not necessary, a default set of subgrids is automatically created by gridSetupStructured.
  ! You can disable this behaviour by calling gridSetupStructuredSep with the optional
  ! argument createSubgrids = .false. 
  ! 
  ! The easiest way to manually create the subgrid for all (1,1) cells ("faces") is 
  ! allocate(edgecpo(1)%subgrids(1))  
  ! call createSubGridForClass(edgecpo(1)%grid, edgecpo(1)%subgrids(1), (/ 1, 1 /), "Cells")

  ! === 4. Write some fake scalar data to the edge cpo ===

  ! Make up some data

  ! Write the data to the complexgrid_scalar data structure
  allocate(edgecpo(1)%fluid%ne%value(3))
  y = (/ ( x(i), i=1,NPOINTR ) /)
  call gridStructWriteData1d( edgecpo(1)%grid, edgecpo(1)%fluid%ne%value(1), GRID_STRUCT_NODES, y )
  y = (/ ( sin(x(i)), i=1,NPOINTR ) /)
  call gridStructWriteData1d( edgecpo(1)%grid, edgecpo(1)%fluid%ne%value(2), GRID_STRUCT_NODES, y )
  y = (/ ( exp(x(i)), i=1,NPOINTR ) /)
  call gridStructWriteData1d( edgecpo(1)%grid, edgecpo(1)%fluid%ne%value(3), GRID_STRUCT_NODES, y )

  ! === 5. Write the edge CPO to the UAL ===

  write (*,*) "Example 5: writing to shot ", SHOTNUM, ", run ", RUNNUM
  call euitm_create( 'euitm', SHOTNUM, RUNNUM, 0, 0, idx)
  call euitm_put(idx, "edge", edgecpo)
  call euitm_close(idx)
  call euitm_deallocate(edgecpo)   

end program itm_grid_example5_1dstructured