Page History

...

type ids_parameters_input !

1366 character(len=132), dimension(:), pointer ::parameters_value => null()

1367 character(len=132), dimension(:), pointer ::parameters_default => null()

1368 character(len=132), dimension(:), pointer ::schema => null()

1369 endtype

ITM	IMAS
CHEAT SHEET
use euitm_schemas	use ids_schemas
use euitm_routines	use ids_routines
type (type_<cpo_name>) :: cpo	type (ids_<ids_name>) :: ids
type (type_<cpo_name>), pointer :: cpoArray(:) ! <= ArrayARRAY !!!	type (ids_<ids_name>) :: ids <== SINGLE OBJ !!!
eval-pkg-config	pkg-config
eval-pkg-config --cflags --libs ual-ifort	pkg-config --cflags --libs imas-ifort
eval-pkg-config --cflags --libs ual-gfortran	pkg-config --cflags --libs imas-gfortran
type(type_param) :: XML_params	type(ids_parameters_input ) :: XML_params
type ids_parameters_input ! Code parameters block passed from the wrapper to the subroutine. Does not appear as such in the data structure. This is inserted i 1366 character(len=132), dimension(:), pointer ::parameters_value => null() ! /parameters_input/parameters_value - Actual value of the code parameters (instance of Code_Parameters/Parameters in XML format) 1367 character(len=132), dimension(:), pointer ::parameters_default => null() ! /parameters_input/parameters_default - Default value of the code parameters (instance of Code_Parameters/Parameters in XML format) 1368 character(len=132), dimension(:), pointer ::schema => null() ! /parameters_input/schema - Code parameters schema 1369 endtype	type_param ... :: parameters ... :: default_param ... :: schema endtype	type ids_parameters_input ... :: parameters_value ... :: parameters_default ... :: schema endtype
use euitm_xml_parser	use imas_xml_parser
call euitm_xml_parse(code_params, nparm, param_list)	call imas_xml_parse(code_params, nparm, param_list)
eval-pkg-config	pkg-config
eval-pkg-config --cflags ual-ifort	pkg-config --cflags imas-ifort
eval-pkg-config --cflags ual-gfortran	pkg-config --cflags imas-gfortran

4.2.2 Examples

Examples of interface between wrapper and user code

ITM

1

2

3

4

5

6

7

8

9

10

11

12

13

14

/**** Fortran intrinsic data types ***/
integer :: input
character(50) :: charstring
integer,dimension(4) :: tabint
 
/**** Single slice ***/
type (type_equilibrium) :: cpo
 
/**** Array of slices ***/
type (type_equilibrium),pointer :: cpoArray(:)
/**** Code XML parameters ***/
 type(type_param), intent(in) :: codeparam
 
/**** Arbitrary diagnostic info ***/
integer    ::     outputFlag
character(len=:), pointer   ::    diagInfo

IMAS

1

2

3

4

5

6

7

8

9

10

11

12

13

14

/**** Fortran intrinsic data types ***/
integer :: input
character(50) :: charstring
integer,dimension(4) :: tabint
 
/**** Single slice ***/
type (ids_equilibrium) :: cpo
 
/**** Array of slices ***/
type (ids_equilibrium) :: ids <== SINGLE OBJ !!!
 
/**** Code XML parameters ***/
 type(ids_parameters_input), intent(in) :: codeparam
 
/**** Arbitrary diagnostic info ***/
integer    ::     outputFlag
character(len=:), pointer   ::    diagInfo

4.2.

...

The user code should be delivered as a static library.
Please find examples of the simple "Makefile" below:

2.1 Subroutine syntax

subroutine name ( <in/out arguments list> [,code_parameters] [,diagnostic_info] )

...

2 XML Parsing

Code Block

 use imas_xml_parser
 
  type(ids_Parameters_Input),intent(in)   :: code_parameters
  integer, intent(out)                    :: return_status
  type(tree)             :: parameter_list
  type(element), pointer :: temp_pointer
  integer(itm_i4)        :: i, nparm, n_values,j
  character(len = 132)   :: cname
!...  initialisations
  nparm         = 0
  n_values      = 0
  return_status = 0      ! no error
  j

...

2.2. Arguments list

A mandatory position
A list of input and output subroutine arguments including:
- Fortran intrisic data types, eg:
  - integer :: input
  - character(50) :: charstring
  - integer,dimension(4) :: tabint
- IDSes, eg:
  - type (type_equilibrium),pointer :: equilibriumin(:)
  - type (type_distsource),pointer :: distsourceout(:)

Warning
Do not forget to add: use imas_schemas, while playing with IDSes Please use intent(in), intent(out) to point in/out parameters

2.3. Code parameters

...

Argument of type: type_param

...

parameters - Actual value of the code parameters (instance of coparam/parameters in XML format).
default_param - Default value of the code parameters (instance of coparam/parameters in XML format).
schema - Code parameters schema.

...

(type_param) :: codeparam{{

2.5. Examples

...

title	Example 3 Usage of code input parameters

...

0
!-- parse xml-string code_parameters%parameters using W3C XML schema in
!   code_parameters%schema
  call imas_xml_parse(code_parameters, nparm, parameter_list)
!-- assign variables
  temp_pointer => parameter_list%first
  outer: do
    cname = char2str(temp_pointer%cname)   ! necessary for AIX
    select case (cname)
!--   parameters overall
      case ("parameters")
        temp_pointer => temp_pointer%child
        cycle      
!--   parameter classes
!--   individual parameters
      case ("tokamak")
        if (allocated(temp_pointer%cvalue)) &

...

     call char2num(temp_pointer%cvalue, tokamak)

      case default
        write(0, *) 'ERROR: invalid parameter', cname
        return_status = 1
        exit
    end select

...

 do
      if (associated(temp_pointer%sibling)) then
        temp_pointer => temp_pointer%sibling
        exit
      end if
      if (associated(temp_pointer%parent, parameter_list%first )) &
        exit outer
      if (associated(temp_pointer%parent)) then
        temp_pointer => temp_pointer%parent
      else
        write(0, *) 'ERROR: broken list.'
        return
      end if
    end do
  end do outer

4.2.3

...

Delivery of the user code

The user code should be delivered as a static library.
Please find examples of the simple "

...

Makefile" below:

Code Block

language	bash
title	Example 6. Building of Fortran code

F90 = $(ITM_INTEL_FC)ifort
COPTS = -g -O0 -assume no2underscore -fPIC -shared-intel

INCLUDES = $(shell eval-pkg-config --cflags ual-$(ITM_INTEL_OBJECTCODE)imas-ifort)

all: equilibrium2distsource.o libequilibrium2distsource

libequilibrium2distsource: equilibrium2distsource.o
        ar -rvs libequilibrium2distsource.a equilibrium2distsource.o

equilibrium2distsource.o: equilibrium2distsource.f90
        $(F90) $(COPTS) -c -o $@ $^ ${INCLUDES} 

clean:
        rm -f *.o *.a

Tip

Recomendations

Please use eval-pkg-config to get UAL flags and not hard coded references.
The usage of environment variables for identifying compilers and versions of the pkg-config is recommended.

Page tree

Versions Compared

Old Version 10

New Version Current

Key