FLASH4.6.1 API

Generated from /asc/asci2/site/flashcode/secure/release_4p6/source/RuntimeParameters/RuntimeParameters_get.F90 with ROBODoc v4.99.8 on Sun Sep 15 01:16:41 2019

TABLE OF CONTENTS


[Functions] source/RuntimeParameters/RuntimeParameters_get

[top][index]

NAME

  RuntimeParameters_get

SYNOPSIS

  RuntimeParameters_get(  char*(in) :: name,
              real/int/str/log(out) :: value) 

DESCRIPTION

  This function retrievess a runtime parameter from a linked list.
  RuntimeParameters_get is an overloaded routine.  Underneath the
  hood, RuntimeParameters_get implements RuntimeParameters_getReal,
  RuntimeParameters_getInt, RuntimeParameters_getStr and
  RuntimeParameters_getLog.

  Typically RuntimeParameters_get should only be called in the
  initialization routines for each unit (Driver_init, IO_init,
  Hydro_init, Simulation_init etc).  In FLASH3 we get the runtime
  parameters one time and store the values in the corresponding data
  modules (Driver_data, IO_data, Hydro_data, Simulation_data, etc.)

ARGUMENTS

  name:       name of parameter
  value:      parameter value

EXAMPLE

  use RuntimeParameters, ONLY : RuntimeParameters_set
  
     integer :: lrefine_max

     call RuntimeParameters_get('lrefine_max', lrefine_max) 
     if (lrefine_max .GT. 2) then
          .......

NOTES

  Because RuntimeParameters_get is an overloaded function, a user calling
  the routine must USE the interface RuntimeParameters_interface.