FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/RuntimeParameters/RuntimeParameters_mapStrToInt.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:15 2019

TABLE OF CONTENTS


[Functions] source/RuntimeParameters/RuntimeParameters_mapStrToInt

[top][index]

NAME

  RuntimeParameters_mapStrToInt

SYNOPSIS

  RuntimeParameters_mapStrToInt(character(in) :: inputString(:),
                                     integer(out)  :: constKey)

DESCRIPTION

  Convert a string parameter into the corresponding integer constant.
  The strings are defined in Config files and  provided by the flash.par file.
  The integer constants are defined in the header file constants.h

  This routine is often used when mapping boundary conditions or geometry
  type from a string given in the flash.par to a constant key which
  is used by the rest of the code.

ARGUMENTS

  inputString - input character string 
  constKey -    output integer key corresponding to inputString

EXAMPLE

  !  Determine the geometry requested by the flash.par
  call RuntimeParameters_get("geometry",pt_str_geometry)
  call RuntimeParameters_mapStrToInt(pt_str_geometry, pt_geometry)

  if (pt_geometry == CARTESIAN) then
     .... code for rectangular domain
  else
     .... code for non-rectangular
  endif