Doxygen Generated Documentation From Interface Source Code
Simulation_mapStrToInt.F90 File Reference

Go to the source code of this file.


subroutine Simulation_mapStrToInt (str, key, map)

Function/Subroutine Documentation

◆ Simulation_mapStrToInt()

subroutine Simulation_mapStrToInt ( character(len=*), intent(in)  str,
integer, intent(out)  key,
integer  map 

This routine is created by the setup script, and should never be edited. This routine maps a string described in the Config file to an integer index described in the Simulation.h file. The integer can represent a variable, a species, a flux variable, or a particle property.

For example, the Config file might say: VARIABLE velx At setup time, the Simulation.h file would be created to look like #define VELX_VAR 6 The result of "call Simulation_mapStrToInt(keyout,'velx',MAPBLOCK_UNK)" would be keyout=6.

str – string input key – returned integer index map – variable indicating the type of data structure within Simulation.h. Valid values are

Definition at line 35 of file Simulation_mapStrToInt.F90.